gian/phpmyadmin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Simplify Message adding methods

Browse Source 
The methods are now called based on added type:

- addHtml adds HTML code as is
- addText adds text after escaping it
- addMessage adds Message instance

Signed-off-by: Michal Čihař <michal@cihar.com>
This commit is contained in:
Michal Čihař 2016-06-16 15:22:03 +02:00
parent 54a76de3d8
commit 9869a95641
11 changed files with 33 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
import.php
View File

@ -582,12 +582,12 @@ if (! empty($id_bookmark) && $_REQUEST['action_bookmark'] == 2) {
$message->addParam($executed_queries);
if ($import_notice) {
$message->addMessageHtml($import_notice);
$message->addHtml($import_notice);
}
if (! empty($local_import_file)) {
$message->addMessageString('(' . $local_import_file . ')');
$message->addText('(' . $local_import_file . ')');
} else {
$message->addMessageString('(' . $_FILES['import_file']['name'] . ')');
$message->addText('(' . $_FILES['import_file']['name'] . ')');
}
}
}
@ -610,7 +610,7 @@ if ($timeout_passed) {
$message->addParamHtml('</a>');
if ($offset == 0 || (isset($original_skip) && $original_skip == $offset)) {
$message->addMessageString(
$message->addText(
__(
'However on last run no data has been parsed,'
. ' this usually means phpMyAdmin won\'t be able to'

8
libraries/DisplayResults.php
View File

@ -4723,7 +4723,7 @@ class DisplayResults
$message->addParam($last_shown_rec);
}
$message->addMessageString('(');
$message->addText('(');
if ($message_view_warning === false) {
@ -4739,11 +4739,11 @@ class DisplayResults
}
if (!empty($after_count)) {
$message_total->addMessageHtml($after_count);
$message_total->addHtml($after_count);
}
$message->addMessage($message_total, '');
$message->addMessageString(', ', '');
$message->addText(', ', '');
}
$message_qt = Message::notice(__('Query took %01.4f seconds.') . ')');
@ -4751,7 +4751,7 @@ class DisplayResults
$message->addMessage($message_qt, '');
if (! is_null($sorted_column_message)) {
$message->addMessageHtml($sorted_column_message, '');
$message->addHtml($sorted_column_message, '');
}
return $message;

6
libraries/Message.php
View File

@ -482,7 +482,7 @@ class Message
public function addMessagesString($messages, $separator = ' ')
{
foreach ($messages as $message) {
$this->addMessageString($message, $separator);
$this->addText($message, $separator);
}
}
@ -526,7 +526,7 @@ class Message
*
* @return void
*/
public function addMessageString($message, $separator = ' ')
public function addText($message, $separator = ' ')
{
if (!is_string($message)) {
trigger_error('Invalid parameter passed to addMessage');
@ -542,7 +542,7 @@ class Message
*
* @return void
*/
public function addMessageHtml($message, $separator = ' ')
public function addHtml($message, $separator = ' ')
{
if (!is_string($message)) {
trigger_error('Invalid parameter passed to addMessage');

2
libraries/Util.php
View File

@ -1115,7 +1115,7 @@ class Util
if ($message instanceof Message) {
if (isset($GLOBALS['special_message'])) {
$message->addMessageString($GLOBALS['special_message']);
$message->addText($GLOBALS['special_message']);
unset($GLOBALS['special_message']);
}
$retval .= $message->getDisplay();

4
libraries/central_columns.lib.php
View File

@ -382,7 +382,7 @@ function PMA_deleteColumnsFromList($field_select, $isTable=true)
if (!$GLOBALS['dbi']->tryQuery($query, $GLOBALS['controllink'])) {
$message = Message::error(__('Could not remove columns!'));
$message->addMessageHtml('<br />' . htmlspecialchars($cols) . '<br />');
$message->addHtml('<br />' . htmlspecialchars($cols) . '<br />');
$message->addMessage(
Message::rawError(
$GLOBALS['dbi']->getError($GLOBALS['controllink'])
@ -450,7 +450,7 @@ function PMA_makeConsistentWithList($db, $selected_tables)
$GLOBALS['dbi']->getError($GLOBALS['userlink'])
);
} else {
$message->addMessageString(
$message->addText(
$GLOBALS['dbi']->getError($GLOBALS['userlink']),
'<br />'
);

6
libraries/display_export.lib.php
View File

@ -555,11 +555,11 @@ function PMA_getHtmlForExportOptionsOutputFormat($export_type)
$html .= '<label for="filename_template" class="desc">';
$html .= __('File name template:');
$trans = new Message;
$trans->addMessageString(__('@SERVER@ will become the server name'));
$trans->addText(__('@SERVER@ will become the server name'));
if ($export_type == 'database' || $export_type == 'table') {
$trans->addMessageString(__(', @DATABASE@ will become the database name'));
$trans->addText(__(', @DATABASE@ will become the database name'));
if ($export_type == 'table') {
$trans->addMessageString(__(', @TABLE@ will become the table name'));
$trans->addText(__(', @TABLE@ will become the table name'));
}
}

6
libraries/rte/rte_events.lib.php
View File

@ -172,11 +172,11 @@ function PMA_EVN_handleEditor()
)
. '</b>'
);
$message->addMessageHtml('<ul>');
$message->addHtml('<ul>');
foreach ($errors as $string) {
$message->addMessageHtml('<li>' . $string . '</li>');
$message->addHtml('<li>' . $string . '</li>');
}
$message->addMessageHtml('</ul>');
$message->addHtml('</ul>');
}
$output = PMA\libraries\Util::getMessage($message, $sql_query);

6
libraries/rte/rte_routines.lib.php
View File

@ -274,11 +274,11 @@ function PMA_RTN_handleRequestCreateOrEdit($errors, $db)
. ' processing your request:'
)
);
$message->addMessageHtml('<ul>');
$message->addHtml('<ul>');
foreach ($errors as $string) {
$message->addMessageHtml('<li>' . $string . '</li>');
$message->addHtml('<li>' . $string . '</li>');
}
$message->addMessageHtml('</ul>');
$message->addHtml('</ul>');
}
$output = PMA\libraries\Util::getMessage($message, $sql_query);

6
libraries/rte/rte_triggers.lib.php
View File

@ -148,11 +148,11 @@ function PMA_TRI_handleEditor()
)
. '</b>'
);
$message->addMessageHtml('<ul>');
$message->addHtml('<ul>');
foreach ($errors as $string) {
$message->addMessageHtml('<li>' . $string . '</li>');
$message->addHtml('<li>' . $string . '</li>');
}
$message->addMessageHtml('</ul>');
$message->addHtml('</ul>');
}
$output = PMA\libraries\Util::getMessage($message, $sql_query);

6
libraries/sql.lib.php
View File

@ -894,7 +894,7 @@ function PMA_getDefaultSqlQueryForBrowse($db, $table)
__('Using bookmark "%s" as default browse query.')
);
$GLOBALS['using_bookmark_message']->addParam($table);
$GLOBALS['using_bookmark_message']->addMessageHtml(
$GLOBALS['using_bookmark_message']->addHtml(
PMA\libraries\Util::showDocu('faq', 'faq6-22')
);
$sql_query = $bookmark->getQuery();
@ -1336,7 +1336,7 @@ function PMA_getMessageForNoRowsReturned($message_to_show,
if ($insert_id != 0) {
// insert_id is id of FIRST record inserted in one insert,
// so if we inserted multiple rows, we had to increment this
$message->addMessageString('[br]');
$message->addText('[br]');
// need to use a temporary because the Message class
// currently supports adding parameters only to the first
// message
@ -1379,7 +1379,7 @@ function PMA_getMessageForNoRowsReturned($message_to_show,
// In case of ROLLBACK, notify the user.
if (isset($_REQUEST['rollback_query'])) {
$message->addMessageString(__('[ROLLBACK occurred.]'));
$message->addText(__('[ROLLBACK occurred.]'));
}
return $message;

8
test/classes/MessageTest.php
View File

@ -246,12 +246,12 @@ class MessageTest extends PMATestCase
*/
public function testAddString()
{
$this->object->addMessageString('test', '*');
$this->object->addText('test', '*');
$this->assertEquals(
array('*', PMA\libraries\Message::notice('test')),
$this->object->getAddedMessages()
);
$this->object->addMessageString('test', '');
$this->object->addText('test', '');
$this->assertEquals(
array(
'*',
@ -269,12 +269,12 @@ class MessageTest extends PMATestCase
*/
public function testAddMessage()
{
$this->object->addMessageString('test<>', '');
$this->object->addText('test<>', '');
$this->assertEquals(
array(PMA\libraries\Message::notice('test&lt;&gt;')),
$this->object->getAddedMessages()
);
$this->object->addMessageHtml('<b>test</b>');
$this->object->addHtml('<b>test</b>');
$this->assertEquals(
array(
PMA\libraries\Message::notice('test&lt;&gt;'),