From 3f01cd8c133889de16d8d77ba174a3b004bfb26e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maur=C3=ADcio=20Meneghini=20Fauth?= Date: Mon, 20 Jul 2020 19:43:46 -0300 Subject: [PATCH] Remove Message::display method MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Related to https://github.com/phpmyadmin/phpmyadmin/issues/16258. Signed-off-by: Maurício Meneghini Fauth --- .../Database/TrackingController.php | 16 +++++----- .../Preferences/TwoFactorController.php | 4 +-- libraries/classes/Database/Events.php | 4 +-- libraries/classes/Database/Qbe.php | 2 +- libraries/classes/Database/Routines.php | 4 +-- libraries/classes/Database/Triggers.php | 4 +-- libraries/classes/Display/Export.php | 4 +-- libraries/classes/Display/Import.php | 4 +-- libraries/classes/ErrorHandler.php | 2 +- libraries/classes/Menu.php | 10 ------- libraries/classes/Message.php | 10 +------ libraries/classes/Pdf.php | 4 +-- .../classes/Plugins/AuthenticationPlugin.php | 4 +-- .../classes/Plugins/Import/ImportXml.php | 10 +++---- libraries/classes/Routing.php | 6 ++-- libraries/classes/Tracking.php | 2 +- libraries/classes/TwoFactor.php | 2 +- test/classes/MenuTest.php | 12 -------- test/classes/MessageTest.php | 29 ++++--------------- 19 files changed, 41 insertions(+), 92 deletions(-) diff --git a/libraries/classes/Controllers/Database/TrackingController.php b/libraries/classes/Controllers/Database/TrackingController.php index 502fac288c..8af0f1c40c 100644 --- a/libraries/classes/Controllers/Database/TrackingController.php +++ b/libraries/classes/Controllers/Database/TrackingController.php @@ -74,12 +74,12 @@ class TrackingController extends AbstractController if (isset($_POST['delete_tracking'], $_POST['table'])) { Tracker::deleteTracking($db, $_POST['table']); - Message::success( + echo Message::success( __('Tracking data deleted successfully.') - )->display(); + )->getDisplay(); } elseif (isset($_POST['submit_create_version'])) { $this->tracking->createTrackingForMultipleTables($_POST['selected']); - Message::success( + echo Message::success( sprintf( __( 'Version %1$s was created for selected tables,' @@ -87,16 +87,16 @@ class TrackingController extends AbstractController ), htmlspecialchars($_POST['version']) ) - )->display(); + )->getDisplay(); } elseif (isset($_POST['submit_mult'])) { if (! empty($_POST['selected_tbl'])) { if ($_POST['submit_mult'] === 'delete_tracking') { foreach ($_POST['selected_tbl'] as $table) { Tracker::deleteTracking($db, $table); } - Message::success( + echo Message::success( __('Tracking data deleted successfully.') - )->display(); + )->getDisplay(); } elseif ($_POST['submit_mult'] === 'track') { echo $this->template->render('create_tracking_version', [ 'route' => '/database/tracking', @@ -111,9 +111,9 @@ class TrackingController extends AbstractController return; } } else { - Message::notice( + echo Message::notice( __('No tables selected.') - )->display(); + )->getDisplay(); } } diff --git a/libraries/classes/Controllers/Preferences/TwoFactorController.php b/libraries/classes/Controllers/Preferences/TwoFactorController.php index 05a1727a8a..d3bab5bf45 100644 --- a/libraries/classes/Controllers/Preferences/TwoFactorController.php +++ b/libraries/classes/Controllers/Preferences/TwoFactorController.php @@ -54,7 +54,7 @@ class TwoFactorController extends AbstractController } $twoFactor->configure(''); - Message::rawNotice(__('Two-factor authentication has been removed.'))->display(); + echo Message::rawNotice(__('Two-factor authentication has been removed.'))->getDisplay(); } elseif (isset($_POST['2fa_configure'])) { if (! $twoFactor->configure($_POST['2fa_configure'])) { echo $this->template->render('preferences/two_factor/configure', [ @@ -65,7 +65,7 @@ class TwoFactorController extends AbstractController return; } - Message::rawNotice(__('Two-factor authentication has been configured.'))->display(); + echo Message::rawNotice(__('Two-factor authentication has been configured.'))->getDisplay(); } $backend = $twoFactor->getBackend(); diff --git a/libraries/classes/Database/Events.php b/libraries/classes/Database/Events.php index 121e0f1c37..761cc47490 100644 --- a/libraries/classes/Database/Events.php +++ b/libraries/classes/Database/Events.php @@ -576,7 +576,7 @@ class Events exit; } - $message->display(); + echo $message->getDisplay(); } public function export(): void @@ -628,6 +628,6 @@ class Events exit; } - $message->display(); + echo $message->getDisplay(); } } diff --git a/libraries/classes/Database/Qbe.php b/libraries/classes/Database/Qbe.php index c3ca5b2209..b62c67f14a 100644 --- a/libraries/classes/Database/Qbe.php +++ b/libraries/classes/Database/Qbe.php @@ -356,7 +356,7 @@ class Qbe ); $all_tables_count = $this->dbi->numRows($all_tables); if ($all_tables_count == 0) { - Message::error(__('No tables found in database.'))->display(); + echo Message::error(__('No tables found in database.'))->getDisplay(); exit; } // The tables list gets from MySQL diff --git a/libraries/classes/Database/Routines.php b/libraries/classes/Database/Routines.php index 238c1d151e..7d5cc61112 100644 --- a/libraries/classes/Database/Routines.php +++ b/libraries/classes/Database/Routines.php @@ -220,7 +220,7 @@ class Routines exit; } - $message->display(); + echo $message->getDisplay(); } /** @@ -1979,6 +1979,6 @@ class Routines exit; } - $message->display(); + echo $message->getDisplay(); } } diff --git a/libraries/classes/Database/Triggers.php b/libraries/classes/Database/Triggers.php index ba724bf1ed..bf0e2f2c2e 100644 --- a/libraries/classes/Database/Triggers.php +++ b/libraries/classes/Database/Triggers.php @@ -589,7 +589,7 @@ class Triggers exit; } - $message->display(); + echo $message->getDisplay(); } private function export(): void @@ -645,6 +645,6 @@ class Triggers exit; } - $message->display(); + echo $message->getDisplay(); } } diff --git a/libraries/classes/Display/Export.php b/libraries/classes/Display/Export.php index c46f9ec1aa..74705db615 100644 --- a/libraries/classes/Display/Export.php +++ b/libraries/classes/Display/Export.php @@ -659,9 +659,9 @@ class Export /* Fail if we didn't find any plugin */ if (empty($exportList)) { - Message::error( + echo Message::error( __('Could not load export plugins, please check your installation!') - )->display(); + )->getDisplay(); exit; } diff --git a/libraries/classes/Display/Import.php b/libraries/classes/Display/Import.php index feb41257d0..532688eeed 100644 --- a/libraries/classes/Display/Import.php +++ b/libraries/classes/Display/Import.php @@ -57,11 +57,11 @@ class Import /* Fail if we didn't find any plugin */ if (empty($importList)) { - Message::error( + echo Message::error( __( 'Could not load import plugins, please check your installation!' ) - )->display(); + )->getDisplay(); exit; } diff --git a/libraries/classes/ErrorHandler.php b/libraries/classes/ErrorHandler.php index c83e70903a..283f4be899 100644 --- a/libraries/classes/ErrorHandler.php +++ b/libraries/classes/ErrorHandler.php @@ -294,7 +294,7 @@ class ErrorHandler if (! headers_sent()) { $this->dispPageStart($error); } - $error->display(); + echo $error->getDisplay(); $this->dispPageEnd(); exit; } diff --git a/libraries/classes/Menu.php b/libraries/classes/Menu.php index 1403ad355a..736f20cbfa 100644 --- a/libraries/classes/Menu.php +++ b/libraries/classes/Menu.php @@ -59,16 +59,6 @@ class Menu $this->template = new Template(); } - /** - * Prints the menu and the breadcrumbs - * - * @return void - */ - public function display() - { - echo $this->getDisplay(); - } - /** * Returns the menu and the breadcrumbs as a string * diff --git a/libraries/classes/Message.php b/libraries/classes/Message.php index 9b8c18d4ea..156a150f83 100644 --- a/libraries/classes/Message.php +++ b/libraries/classes/Message.php @@ -23,7 +23,7 @@ use function strlen; * simple usage examples: * * // display simple error message 'Error' - * Message::error()->display(); + * echo Message::error()->getDisplay(); * * // get simple success message 'Success' * $message = Message::success(); @@ -739,14 +739,6 @@ class Message return self::$level[$this->getNumber()]; } - /** - * Displays the message in HTML - */ - public function display(): void - { - echo $this->getDisplay(); - } - /** * returns HTML code for displaying this message * diff --git a/libraries/classes/Pdf.php b/libraries/classes/Pdf.php index 4a3a55d0b7..6a570b1cb0 100644 --- a/libraries/classes/Pdf.php +++ b/libraries/classes/Pdf.php @@ -152,9 +152,9 @@ class Pdf extends TCPDF // @codingStandardsIgnoreLine public function Error($error_message = '') { - Message::error( + echo Message::error( __('Error while creating PDF:') . ' ' . $error_message - )->display(); + )->getDisplay(); exit; } diff --git a/libraries/classes/Plugins/AuthenticationPlugin.php b/libraries/classes/Plugins/AuthenticationPlugin.php index 1226ea37af..c210911f2f 100644 --- a/libraries/classes/Plugins/AuthenticationPlugin.php +++ b/libraries/classes/Plugins/AuthenticationPlugin.php @@ -358,9 +358,9 @@ abstract class AuthenticationPlugin exit; } echo $this->template->render('login/header', ['theme' => $GLOBALS['PMA_Theme']]); - Message::rawNotice( + echo Message::rawNotice( __('You have enabled two factor authentication, please confirm your login.') - )->display(); + )->getDisplay(); echo $this->template->render('login/twofactor', [ 'form' => $twofactor->render(), 'show_submit' => $twofactor->showSubmit(), diff --git a/libraries/classes/Plugins/Import/ImportXml.php b/libraries/classes/Plugins/Import/ImportXml.php index f2e661e843..81c6cc08f9 100644 --- a/libraries/classes/Plugins/Import/ImportXml.php +++ b/libraries/classes/Plugins/Import/ImportXml.php @@ -108,13 +108,12 @@ class ImportXml extends ImportPlugin * The XML was malformed */ if ($xml === false) { - Message::error( + echo Message::error( __( 'The XML file specified was either malformed or incomplete.' . ' Please correct the issue and try again.' ) - ) - ->display(); + )->getDisplay(); unset($xml); $GLOBALS['finished'] = false; @@ -173,13 +172,12 @@ class ImportXml extends ImportPlugin * The XML was malformed */ if ($db_name === null) { - Message::error( + echo Message::error( __( 'The XML file specified was either malformed or incomplete.' . ' Please correct the issue and try again.' ) - ) - ->display(); + )->getDisplay(); unset($xml); $GLOBALS['finished'] = false; diff --git a/libraries/classes/Routing.php b/libraries/classes/Routing.php index 54736dfbce..213b46822c 100644 --- a/libraries/classes/Routing.php +++ b/libraries/classes/Routing.php @@ -66,10 +66,10 @@ class Routing /** @var Response $response */ $response = $container->get(Response::class); $response->setHttpResponseCode(404); - Message::error(sprintf( + echo Message::error(sprintf( __('Error 404! The page %s was not found.'), '' . htmlspecialchars($route) . '' - ))->display(); + ))->getDisplay(); return; } @@ -78,7 +78,7 @@ class Routing /** @var Response $response */ $response = $container->get(Response::class); $response->setHttpResponseCode(405); - Message::error(__('Error 405! Request method not allowed.'))->display(); + echo Message::error(__('Error 405! Request method not allowed.'))->getDisplay(); return; } diff --git a/libraries/classes/Tracking.php b/libraries/classes/Tracking.php index 298fd99322..52d5814c4c 100644 --- a/libraries/classes/Tracking.php +++ b/libraries/classes/Tracking.php @@ -280,7 +280,7 @@ class Tracking */ if (count($data['ddlog']) == 0 && count($data['dmlog']) === 0) { $msg = Message::notice(__('No data')); - $msg->display(); + echo $msg->getDisplay(); } $html .= $this->getHtmlForTrackingReportExportForm1( diff --git a/libraries/classes/TwoFactor.php b/libraries/classes/TwoFactor.php index 6f80d1e722..f6e41f1ef6 100644 --- a/libraries/classes/TwoFactor.php +++ b/libraries/classes/TwoFactor.php @@ -269,7 +269,7 @@ class TwoFactor } $result = $this->save(); if ($result !== true) { - $result->display(); + echo $result->getDisplay(); } return true; diff --git a/test/classes/MenuTest.php b/test/classes/MenuTest.php index 07a4f856b2..69df0f1640 100644 --- a/test/classes/MenuTest.php +++ b/test/classes/MenuTest.php @@ -76,18 +76,6 @@ class MenuTest extends AbstractTestCase ); } - /** - * Table menu display test - */ - public function testTableDisplay(): void - { - $menu = new Menu('pma_test', ''); - $this->expectOutputString( - $menu->getDisplay() - ); - $menu->display(); - } - /** * Table menu setTable test */ diff --git a/test/classes/MessageTest.php b/test/classes/MessageTest.php index 94e01a22ee..dacb8cf0bd 100644 --- a/test/classes/MessageTest.php +++ b/test/classes/MessageTest.php @@ -490,29 +490,12 @@ class MessageTest extends AbstractTestCase $this->assertEquals('error', $this->object->getLevel()); } - /** - * testing display method (output string and _is_displayed variable) - */ - public function testDisplay(): void - { - $this->assertFalse($this->object->isDisplayed()); - $this->object->setMessage('Test Message'); - - $this->expectOutputString( - '' . "\n" - ); - $this->object->display(); - - $this->assertTrue($this->object->isDisplayed()); - } - /** * getDisplay test */ public function testGetDisplay(): void { + $this->assertFalse($this->object->isDisplayed()); $this->object->setMessage('Test Message'); $this->assertEquals( '' . "\n", $this->object->getDisplay() ); + $this->assertTrue($this->object->isDisplayed()); } /** @@ -574,8 +558,7 @@ class MessageTest extends AbstractTestCase $this->object = new Message(); $msg = $this->object->getMessageForAffectedRows($rows); $this->object->addMessage($msg); - $this->expectOutputString($output); - $this->object->display(); + $this->assertEquals($output, $this->object->getDisplay()); } /** @@ -620,8 +603,7 @@ class MessageTest extends AbstractTestCase $this->object = new Message(); $msg = $this->object->getMessageForInsertedRows($rows); $this->object->addMessage($msg); - $this->expectOutputString($output); - $this->object->display(); + $this->assertEquals($output, $this->object->getDisplay()); } /** @@ -666,7 +648,6 @@ class MessageTest extends AbstractTestCase $this->object = new Message(); $msg = $this->object->getMessageForDeletedRows($rows); $this->object->addMessage($msg); - $this->expectOutputString($output); - $this->object->display(); + $this->assertEquals($output, $this->object->getDisplay()); } }