<?php /* vim: set expandtab sw=4 ts=4 sts=4: */ /** * Holds class Message * * @package PhpMyAdmin */ namespace PMA\libraries; /** * a single message * * simple usage examples: * <code> * // display simple error message 'Error' * Message::error()->display(); * * // get simple success message 'Success' * $message = Message::success(); * * // get special notice * $message = Message::notice(__('This is a localized notice')); * </code> * * more advanced usage example: * <code> * // create a localized success message * $message = Message::success('strSomeLocaleMessage'); * * // create another message, a hint, with a localized string which expects * // two parameters: $strSomeTooltip = 'Read the %smanual%s' * $hint = Message::notice('strSomeTooltip'); * // replace placeholders with the following params * $hint->addParam('[doc@cfg_Example]'); * $hint->addParam('[/doc]'); * // add this hint as a tooltip * $hint = showHint($hint); * * // add the retrieved tooltip reference to the original message * $message->addMessage($hint); * * // create another message ... * $more = Message::notice('strSomeMoreLocale'); * $more->addString('strSomeEvenMoreLocale', '<br />'); * $more->addParam('parameter for strSomeMoreLocale'); * $more->addParam('more parameter for strSomeMoreLocale'); * * // and add it also to the original message * $message->addMessage($more); * // finally add another raw message * $message->addMessage('some final words', ' - '); * * // display() will now print all messages in the same order as they are added * $message->display(); * // strSomeLocaleMessage <sup>1</sup> strSomeMoreLocale<br /> * // strSomeEvenMoreLocale - some final words * </code> * * @package PhpMyAdmin */ class Message { const SUCCESS = 1; // 0001 const NOTICE = 2; // 0010 const ERROR = 8; // 1000 const SANITIZE_NONE = 0; // 0000 0000 const SANITIZE_STRING = 16; // 0001 0000 const SANITIZE_PARAMS = 32; // 0010 0000 const SANITIZE_BOOTH = 48; // 0011 0000 /** * message levels * * @var array */ static public $level = array ( Message::SUCCESS => 'success', Message::NOTICE => 'notice', Message::ERROR => 'error', ); /** * The message number * * @access protected * @var integer */ protected $number = Message::NOTICE; /** * The locale string identifier * * @access protected * @var string */ protected $string = ''; /** * The formatted message * * @access protected * @var string */ protected $message = ''; /** * Whether the message was already displayed * * @access protected * @var boolean */ protected $isDisplayed = false; /** * Whether to use BB code when displaying. * * @access protected * @var boolean */ protected $useBBCode = true; /** * Unique id * * @access protected * @var string */ protected $hash = null; /** * holds parameters * * @access protected * @var array */ protected $params = array(); /** * holds additional messages * * @access protected * @var array */ protected $addedMessages = array(); /** * Constructor * * @param string $string The message to be displayed * @param integer $number A numeric representation of the type of message * @param array $params An array of parameters to use in the message * @param integer $sanitize A flag to indicate what to sanitize, see * constant definitions above */ public function __construct($string = '', $number = Message::NOTICE, $params = array(), $sanitize = Message::SANITIZE_NONE ) { $this->setString($string, $sanitize & Message::SANITIZE_STRING); $this->setNumber($number); $this->setParams($params, $sanitize & Message::SANITIZE_PARAMS); } /** * magic method: return string representation for this object * * @return string */ public function __toString() { return $this->getMessage(); } /** * get Message of type success * * shorthand for getting a simple success message * * @param string $string A localized string * e.g. __('Your SQL query has been * executed successfully') * * @return Message * @static */ static public function success($string = '') { if (empty($string)) { $string = __('Your SQL query has been executed successfully.'); } return new Message($string, Message::SUCCESS); } /** * get Message of type error * * shorthand for getting a simple error message * * @param string $string A localized string e.g. __('Error') * * @return Message * @static */ static public function error($string = '') { if (empty($string)) { $string = __('Error'); } return new Message($string, Message::ERROR); } /** * get Message of type notice * * shorthand for getting a simple notice message * * @param string $string A localized string * e.g. __('The additional features for working with * linked tables have been deactivated. To find out * why click %shere%s.') * * @return Message * @static */ static public function notice($string) { return new Message($string, Message::NOTICE); } /** * get Message with customized content * * shorthand for getting a customized message * * @param string $message A localized string * @param integer $type A numeric representation of the type of message * * @return Message * @static */ static public function raw($message, $type = Message::NOTICE) { $r = new Message('', $type); $r->setMessage($message); $r->setBBCode(false); return $r; } /** * get Message for number of affected rows * * shorthand for getting a customized message * * @param integer $rows Number of rows * * @return Message * @static */ static public function getMessageForAffectedRows($rows) { $message = Message::success( _ngettext('%1$d row affected.', '%1$d rows affected.', $rows) ); $message->addParam($rows); return $message; } /** * get Message for number of deleted rows * * shorthand for getting a customized message * * @param integer $rows Number of rows * * @return Message * @static */ static public function getMessageForDeletedRows($rows) { $message = Message::success( _ngettext('%1$d row deleted.', '%1$d rows deleted.', $rows) ); $message->addParam($rows); return $message; } /** * get Message for number of inserted rows * * shorthand for getting a customized message * * @param integer $rows Number of rows * * @return Message * @static */ static public function getMessageForInsertedRows($rows) { $message = Message::success( _ngettext('%1$d row inserted.', '%1$d rows inserted.', $rows) ); $message->addParam($rows); return $message; } /** * get Message of type error with custom content * * shorthand for getting a customized error message * * @param string $message A localized string * * @return Message * @static */ static public function rawError($message) { return Message::raw($message, Message::ERROR); } /** * get Message of type notice with custom content * * shorthand for getting a customized notice message * * @param string $message A localized string * * @return Message * @static */ static public function rawNotice($message) { return Message::raw($message, Message::NOTICE); } /** * get Message of type success with custom content * * shorthand for getting a customized success message * * @param string $message A localized string * * @return Message * @static */ static public function rawSuccess($message) { return Message::raw($message, Message::SUCCESS); } /** * returns whether this message is a success message or not * and optionally makes this message a success message * * @param boolean $set Whether to make this message of SUCCESS type * * @return boolean whether this is a success message or not */ public function isSuccess($set = false) { if ($set) { $this->setNumber(Message::SUCCESS); } return $this->getNumber() === Message::SUCCESS; } /** * returns whether this message is a notice message or not * and optionally makes this message a notice message * * @param boolean $set Whether to make this message of NOTICE type * * @return boolean whether this is a notice message or not */ public function isNotice($set = false) { if ($set) { $this->setNumber(Message::NOTICE); } return $this->getNumber() === Message::NOTICE; } /** * returns whether this message is an error message or not * and optionally makes this message an error message * * @param boolean $set Whether to make this message of ERROR type * * @return boolean Whether this is an error message or not */ public function isError($set = false) { if ($set) { $this->setNumber(Message::ERROR); } return $this->getNumber() === Message::ERROR; } /** * Set whether we should use BB Code when rendering. * * @param boolean $useBBCode Use BB Code? * * @return void */ public function setBBCode($useBBCode) { $this->useBBCode = $useBBCode; } /** * set raw message (overrides string) * * @param string $message A localized string * @param boolean $sanitize Whether to sanitize $message or not * * @return void */ public function setMessage($message, $sanitize = false) { if ($sanitize) { $message = Message::sanitize($message); } $this->message = $message; } /** * set string (does not take effect if raw message is set) * * @param string $string string to set * @param boolean $sanitize whether to sanitize $string or not * * @return void */ public function setString($string, $sanitize = true) { if ($sanitize) { $string = Message::sanitize($string); } $this->string = $string; } /** * set message type number * * @param integer $number message type number to set * * @return void */ public function setNumber($number) { $this->number = $number; } /** * add parameter, usually in conjunction with strings * * usage * <code> * $message->addParam('strLocale', false); * $message->addParam('[em]some string[/em]'); * $message->addParam('<img src="img" />', false); * </code> * * @param mixed $param parameter to add * @param boolean $raw whether parameter should be passed as is * without html escaping * * @return void */ public function addParam($param, $raw = true) { if ($param instanceof Message) { $this->params[] = $param; } elseif ($raw) { $this->params[] = htmlspecialchars($param); } else { $this->params[] = Message::notice($param); } } /** * add another string to be concatenated on displaying * * @param string $string to be added * @param string $separator to use between this and previous string/message * * @return void */ public function addString($string, $separator = ' ') { $this->addedMessages[] = $separator; $this->addedMessages[] = Message::notice($string); } /** * add a bunch of messages at once * * @param array $messages to be added * @param string $separator to use between this and previous string/message * * @return void */ public function addMessages($messages, $separator = ' ') { foreach ($messages as $message) { $this->addMessage($message, $separator); } } /** * add another raw message to be concatenated on displaying * * @param mixed $message to be added * @param string $separator to use between this and previous string/message * * @return void */ public function addMessage($message, $separator = ' ') { if (mb_strlen($separator)) { $this->addedMessages[] = $separator; } if ($message instanceof Message) { $this->addedMessages[] = $message; } else { $this->addedMessages[] = Message::rawNotice($message); } } /** * set all params at once, usually used in conjunction with string * * @param array|string $params parameters to set * @param boolean $sanitize whether to sanitize params * * @return void */ public function setParams($params, $sanitize = false) { if ($sanitize) { $params = Message::sanitize($params); } $this->params = $params; } /** * return all parameters * * @return array */ public function getParams() { return $this->params; } /** * return all added messages * * @return array */ public function getAddedMessages() { return $this->addedMessages; } /** * Sanitizes $message * * @param mixed $message the message(s) * * @return mixed the sanitized message(s) * @access public * @static */ static public function sanitize($message) { if (is_array($message)) { foreach ($message as $key => $val) { $message[$key] = Message::sanitize($val); } return $message; } return htmlspecialchars($message); } /** * decode $message, taking into account our special codes * for formatting * * @param string $message the message * * @return string the decoded message * @access public * @static */ static public function decodeBB($message) { return PMA_sanitize($message, false, true); } /** * wrapper for sprintf() * * @return string formatted */ static public function format() { $params = func_get_args(); if (isset($params[1]) && is_array($params[1])) { array_unshift($params[1], $params[0]); $params = $params[1]; } return call_user_func_array('sprintf', $params); } /** * returns unique Message::$hash, if not exists it will be created * * @return string Message::$hash */ public function getHash() { if (null === $this->hash) { $this->hash = md5( $this->getNumber() . $this->string . $this->message ); } return $this->hash; } /** * returns compiled message * * @return string complete message */ public function getMessage() { $message = $this->message; if (0 === mb_strlen($message)) { $string = $this->getString(); if (isset($GLOBALS[$string])) { $message = $GLOBALS[$string]; } elseif (0 === mb_strlen($string)) { $message = ''; } else { $message = $string; } } if ($this->isDisplayed()) { $message = $this->getMessageWithIcon($message); } if (count($this->getParams()) > 0) { $message = Message::format($message, $this->getParams()); } if ($this->useBBCode) { $message = Message::decodeBB($message); } foreach ($this->getAddedMessages() as $add_message) { $message .= $add_message; } return $message; } /** * Returns only message string without image & other HTML. * * @return string */ public function getOnlyMessage() { return $this->message; } /** * returns Message::$string * * @return string Message::$string */ public function getString() { return $this->string; } /** * returns Message::$number * * @return integer Message::$number */ public function getNumber() { return $this->number; } /** * returns level of message * * @return string level of message */ public function getLevel() { return Message::$level[$this->getNumber()]; } /** * Displays the message in HTML * * @return void */ public function display() { echo $this->getDisplay(); $this->isDisplayed(true); } /** * returns HTML code for displaying this message * * @return string whole message box */ public function getDisplay() { $this->isDisplayed(true); return '<div class="' . $this->getLevel() . '">' . $this->getMessage() . '</div>'; } /** * sets and returns whether the message was displayed or not * * @param boolean $isDisplayed whether to set displayed flag * * @return boolean Message::$isDisplayed */ public function isDisplayed($isDisplayed = false) { if ($isDisplayed) { $this->isDisplayed = true; } return $this->isDisplayed; } /** * Returns the message with corresponding image icon * * @param string $message the message(s) * * @return string message with icon */ public function getMessageWithIcon($message) { if ('error' == $this->getLevel()) { $image = 's_error.png'; } elseif ('success' == $this->getLevel()) { $image = 's_success.png'; } else { $image = 's_notice.png'; } $message = Message::notice(Util::getImage($image)) . " " . $message; return $message; } }
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
bfShapeFiles | Folder | 0755 |
|
|
config | Folder | 0755 |
|
|
controllers | Folder | 0755 |
|
|
dbi | Folder | 0755 |
|
|
di | Folder | 0755 |
|
|
engines | Folder | 0755 |
|
|
gis | Folder | 0755 |
|
|
navigation | Folder | 0755 |
|
|
plugins | Folder | 0755 |
|
|
properties | Folder | 0755 |
|
|
rte | Folder | 0755 |
|
|
sql-parser | Folder | 0755 |
|
|
Advisor.php | File | 15.13 KB | 0644 |
|
Config.php | File | 54.7 KB | 0644 |
|
Console.php | File | 14.82 KB | 0644 |
|
DatabaseInterface.php | File | 95.6 KB | 0644 |
|
DbList.php | File | 1.9 KB | 0644 |
|
DbQbe.php | File | 68.87 KB | 0644 |
|
DbSearch.php | File | 17.21 KB | 0644 |
|
DisplayResults.php | File | 206 KB | 0644 |
|
Error.php | File | 12.7 KB | 0644 |
|
ErrorHandler.php | File | 16.48 KB | 0644 |
|
File.php | File | 18.82 KB | 0644 |
|
Font.php | File | 4.24 KB | 0644 |
|
Footer.php | File | 10.52 KB | 0644 |
|
Header.php | File | 25.34 KB | 0644 |
|
Index.php | File | 23.79 KB | 0644 |
|
IndexColumn.php | File | 4.46 KB | 0644 |
|
Language.php | File | 4.27 KB | 0644 |
|
LanguageManager.php | File | 20.75 KB | 0644 |
|
Linter.php | File | 5.02 KB | 0644 |
|
ListAbstract.php | File | 3.15 KB | 0644 |
|
ListDatabase.php | File | 4.62 KB | 0644 |
|
Menu.php | File | 21.14 KB | 0644 |
|
Message.php | File | 18.67 KB | 0644 |
|
OutputBuffering.php | File | 3.59 KB | 0644 |
|
PDF.php | File | 3.94 KB | 0644 |
|
Partition.php | File | 7.26 KB | 0644 |
|
Psr4Autoloader.php | File | 4.85 KB | 0644 |
|
RecentFavoriteTable.php | File | 11.78 KB | 0644 |
|
Response.php | File | 12.61 KB | 0644 |
|
SavedSearches.php | File | 11.67 KB | 0644 |
|
Scripts.php | File | 7.38 KB | 0644 |
|
ServerStatusData.php | File | 15.72 KB | 0644 |
|
StorageEngine.php | File | 13.61 KB | 0644 |
|
SubPartition.php | File | 3.52 KB | 0644 |
|
SysInfo.php | File | 799 B | 0644 |
|
SysInfoLinux.php | File | 1.92 KB | 0644 |
|
SysInfoSunOS.php | File | 1.86 KB | 0644 |
|
SysInfoWINNT.php | File | 3.08 KB | 0644 |
|
SystemDatabase.php | File | 3.66 KB | 0644 |
|
Table.php | File | 88.12 KB | 0644 |
|
Template.php | File | 4.45 KB | 0644 |
|
Theme.php | File | 11.34 KB | 0644 |
|
ThemeManager.php | File | 12.91 KB | 0644 |
|
Tracker.php | File | 30.35 KB | 0644 |
|
Types.php | File | 6.08 KB | 0644 |
|
TypesMySQL.php | File | 17.26 KB | 0644 |
|
Util.php | File | 172.46 KB | 0644 |
|
VersionInformation.php | File | 7.87 KB | 0644 |
|
ZipFile.php | File | 6.63 KB | 0644 |
|
advisor.lib.php | File | 1.6 KB | 0644 |
|
advisory_rules.txt | File | 25.94 KB | 0644 |
|
autoloader.php | File | 450 B | 0644 |
|
bookmark.lib.php | File | 8.5 KB | 0644 |
|
browse_foreigners.lib.php | File | 9.83 KB | 0644 |
|
central_columns.lib.php | File | 49.38 KB | 0644 |
|
charset_conversion.lib.php | File | 3.54 KB | 0644 |
|
check_user_privileges.lib.php | File | 10.65 KB | 0644 |
|
cleanup.lib.php | File | 1.29 KB | 0644 |
|
common.inc.php | File | 34.38 KB | 0644 |
|
config.default.php | File | 66.5 KB | 0644 |
|
config.values.php | File | 10.17 KB | 0644 |
|
core.lib.php | File | 29.94 KB | 0644 |
|
create_addfield.lib.php | File | 15.68 KB | 0644 |
|
database_interface.inc.php | File | 2.63 KB | 0644 |
|
db_common.inc.php | File | 3.12 KB | 0644 |
|
db_designer.lib.php | File | 10.4 KB | 0644 |
|
db_table_exists.lib.php | File | 3.21 KB | 0644 |
|
display_change_password.lib.php | File | 5.45 KB | 0644 |
|
display_create_table.lib.php | File | 1.53 KB | 0644 |
|
display_export.lib.php | File | 38.11 KB | 0644 |
|
display_git_revision.lib.php | File | 3.04 KB | 0644 |
|
display_import.lib.php | File | 24.34 KB | 0644 |
|
display_import_ajax.lib.php | File | 3.13 KB | 0644 |
|
display_select_lang.lib.php | File | 2.36 KB | 0644 |
|
error.inc.php | File | 1.21 KB | 0644 |
|
error_report.lib.php | File | 10.25 KB | 0644 |
|
export.lib.php | File | 35.16 KB | 0644 |
|
file_listing.lib.php | File | 2.37 KB | 0644 |
|
iconv_wrapper.lib.php | File | 3.88 KB | 0644 |
|
import.lib.php | File | 50.64 KB | 0644 |
|
index.lib.php | File | 1.37 KB | 0644 |
|
information_schema_relations.lib.php | File | 10.95 KB | 0644 |
|
insert_edit.lib.php | File | 112.79 KB | 0644 |
|
ip_allow_deny.lib.php | File | 9.35 KB | 0644 |
|
js_escape.lib.php | File | 4.43 KB | 0644 |
|
kanji-encoding.lib.php | File | 4.46 KB | 0644 |
|
language_stats.inc.php | File | 1.45 KB | 0644 |
|
logging.lib.php | File | 521 B | 0644 |
|
mime.lib.php | File | 704 B | 0644 |
|
mult_submits.inc.php | File | 10.64 KB | 0644 |
|
mult_submits.lib.php | File | 20.44 KB | 0644 |
|
mysql_charsets.inc.php | File | 4.09 KB | 0644 |
|
mysql_charsets.lib.php | File | 10.47 KB | 0644 |
|
mysql_relations.lib.php | File | 5.12 KB | 0644 |
|
normalization.lib.php | File | 33.98 KB | 0644 |
|
opendocument.lib.php | File | 7.94 KB | 0644 |
|
operations.lib.php | File | 73.64 KB | 0644 |
|
parse_analyze.lib.php | File | 2.12 KB | 0644 |
|
plugin_interface.lib.php | File | 19.69 KB | 0644 |
|
plugin_interface.lib.php.bak | File | 19.69 KB | 0644 |
|
pmd_common.php | File | 24.2 KB | 0644 |
|
relation.lib.php | File | 68.41 KB | 0644 |
|
relation_cleanup.lib.php | File | 13.84 KB | 0644 |
|
replication.inc.php | File | 8.82 KB | 0644 |
|
replication_gui.lib.php | File | 37.45 KB | 0644 |
|
sanitizing.lib.php | File | 6.3 KB | 0644 |
|
select_server.lib.php | File | 3.4 KB | 0644 |
|
server_common.inc.php | File | 1.22 KB | 0644 |
|
server_common.lib.php | File | 1.92 KB | 0644 |
|
server_privileges.lib.php | File | 179.22 KB | 0644 |
|
server_status.lib.php | File | 9.92 KB | 0644 |
|
server_status_advisor.lib.php | File | 1.89 KB | 0644 |
|
server_status_monitor.lib.php | File | 26.22 KB | 0644 |
|
server_status_processes.lib.php | File | 9.57 KB | 0644 |
|
server_status_queries.lib.php | File | 4.86 KB | 0644 |
|
server_status_variables.lib.php | File | 28.95 KB | 0644 |
|
server_user_groups.lib.php | File | 12.8 KB | 0644 |
|
server_users.lib.php | File | 1.35 KB | 0644 |
|
session.inc.php | File | 5.22 KB | 0644 |
|
session.lib.php | File | 735 B | 0644 |
|
special_schema_links.lib.php | File | 17.51 KB | 0644 |
|
sql.lib.php | File | 77.51 KB | 0644 |
|
sql.lib.php.bak | File | 77.51 KB | 0644 |
|
sql_query_form.lib.php | File | 15.71 KB | 0644 |
|
string.lib.php | File | 800 B | 0644 |
|
stringMb.lib.php | File | 1.86 KB | 0644 |
|
stringNative.lib.php | File | 6.82 KB | 0644 |
|
sysinfo.lib.php | File | 1.34 KB | 0644 |
|
tbl_columns_definition_form.inc.php | File | 13.55 KB | 0644 |
|
tbl_common.inc.php | File | 1.3 KB | 0644 |
|
tbl_info.inc.php | File | 3.54 KB | 0644 |
|
tbl_partition_definition.inc.php | File | 5.55 KB | 0644 |
|
tracking.lib.php | File | 54.93 KB | 0644 |
|
transformations.lib.php | File | 14.63 KB | 0644 |
|
url_generating.lib.php | File | 6.77 KB | 0644 |
|
user_preferences.inc.php | File | 2.38 KB | 0644 |
|
user_preferences.lib.php | File | 8.17 KB | 0644 |
|
util.lib.php | File | 749 B | 0644 |
|
vendor_config.php | File | 2.49 KB | 0644 |
|
zip_extension.lib.php | File | 5.38 KB | 0644 |
|