Skip to content

Commit

Permalink
Simplify Response object handling
Browse files Browse the repository at this point in the history
- always use use and short name
- avoid calling getInstance() several times in one script

Signed-off-by: Michal Čihař <michal@cihar.com>
  • Loading branch information
nijel committed Dec 7, 2016
1 parent b56f101 commit 308c9d7
Show file tree
Hide file tree
Showing 80 changed files with 188 additions and 141 deletions.
3 changes: 2 additions & 1 deletion browse_foreigners.php
Expand Up @@ -5,6 +5,7 @@
*
* @package PhpMyAdmin
*/
use PMA\libraries\Response;

require_once 'libraries/common.inc.php';
require_once 'libraries/transformations.lib.php';
Expand All @@ -26,7 +27,7 @@

PMA\libraries\Util::checkParameters(array('db', 'table', 'field'));

$response = PMA\libraries\Response::getInstance();
$response = Response::getInstance();
$response->getFooter()->setMinimal();
$header = $response->getHeader();
$header->disableMenuAndConsole();
Expand Down
3 changes: 2 additions & 1 deletion changelog.php
Expand Up @@ -5,13 +5,14 @@
*
* @package PhpMyAdmin
*/
use PMA\libraries\Response;

/**
* Gets core libraries and defines some variables
*/
require 'libraries/common.inc.php';

$response = PMA\libraries\Response::getInstance();
$response = Response::getInstance();
$response->disable();
$response->getHeader()->sendHttpHeaders();

Expand Down
3 changes: 2 additions & 1 deletion chk_rel.php
Expand Up @@ -5,6 +5,7 @@
*
* @package PhpMyAdmin
*/
use PMA\libraries\Response;

require_once 'libraries/common.inc.php';

Expand All @@ -26,7 +27,7 @@
PMA_fixPMATables($cfgRelation['db']);
}

$response = PMA\libraries\Response::getInstance();
$response = Response::getInstance();
$response->addHTML(
PMA_getRelationsParamDiagnostic($cfgRelation)
);
3 changes: 2 additions & 1 deletion db_central_columns.php
Expand Up @@ -7,6 +7,7 @@
* @package PhpMyAdmin
*/
use PMA\libraries\URL;
use PMA\libraries\Response;

/**
* Gets some core libraries
Expand Down Expand Up @@ -57,7 +58,7 @@
$selected_col[] = $_POST['column-select'];
$tmp_msg = PMA_syncUniqueColumns($selected_col, false, $selected_tbl);
}
$response = PMA\libraries\Response::getInstance();
$response = Response::getInstance();
$header = $response->getHeader();
$scripts = $header->getScripts();
$scripts->addFile('jquery/jquery.uitablefilter.js');
Expand Down
3 changes: 2 additions & 1 deletion db_datadict.php
Expand Up @@ -6,6 +6,7 @@
* @package PhpMyAdmin
*/
use PMA\libraries\URL;
use PMA\libraries\Response;

/**
* Gets the variables sent or posted to this script, then displays headers
Expand All @@ -27,7 +28,7 @@
) = PMA\libraries\Util::getDbInfo($db, isset($sub_part) ? $sub_part : '');
}

$response = PMA\libraries\Response::getInstance();
$response = Response::getInstance();
$header = $response->getHeader();
$header->enablePrintView();

Expand Down
5 changes: 3 additions & 2 deletions db_designer.php
Expand Up @@ -5,12 +5,13 @@
*
* @package PhpMyAdmin-Designer
*/
use PMA\libraries\Response;

require_once 'libraries/common.inc.php';
require_once 'libraries/pmd_common.php';
require_once 'libraries/db_designer.lib.php';

$response = PMA\libraries\Response::getInstance();
$response = Response::getInstance();

if (isset($_REQUEST['dialog'])) {

Expand Down Expand Up @@ -113,7 +114,7 @@
$params['db'] = $_GET['db'];
}

$response = PMA\libraries\Response::getInstance();
$response = Response::getInstance();
$response->getFooter()->setMinimal();
$header = $response->getHeader();
$header->setBodyId('pmd_body');
Expand Down
5 changes: 3 additions & 2 deletions db_import.php
Expand Up @@ -6,6 +6,7 @@
* @package PhpMyAdmin
*/

use PMA\libraries\Response;
use PMA\libraries\config\PageSettings;

require_once 'libraries/common.inc.php';
Expand All @@ -14,7 +15,7 @@

PageSettings::showGroup('Import');

$response = PMA\libraries\Response::getInstance();
$response = Response::getInstance();
$header = $response->getHeader();
$scripts = $header->getScripts();
$scripts->addFile('import.js');
Expand All @@ -37,7 +38,7 @@
) = PMA\libraries\Util::getDbInfo($db, isset($sub_part) ? $sub_part : '');

require 'libraries/display_import.lib.php';
$response = PMA\libraries\Response::getInstance();
$response = Response::getInstance();
$response->addHTML(
PMA_getImportDisplay(
'database', $db, $table, $max_upload_size
Expand Down
4 changes: 2 additions & 2 deletions db_operations.php
Expand Up @@ -11,6 +11,7 @@
*
* @package PhpMyAdmin
*/
use PMA\libraries\Response;
use PMA\libraries\plugins\export\ExportSql;

/**
Expand All @@ -26,7 +27,7 @@
require_once 'libraries/operations.lib.php';

// add a javascript file for jQuery functions to handle Ajax actions
$response = PMA\libraries\Response::getInstance();
$response = Response::getInstance();
$header = $response->getHeader();
$scripts = $header->getScripts();
$scripts->addFile('db_operations.js');
Expand Down Expand Up @@ -174,7 +175,6 @@
* Database has been successfully renamed/moved. If in an Ajax request,
* generate the output with {@link PMA\libraries\Response} and exit
*/
$response = PMA\libraries\Response::getInstance();
if ($response->isAjax()) {
$response->setRequestStatus($message->isSuccess());
$response->addJSON('message', $message);
Expand Down
3 changes: 2 additions & 1 deletion db_qbe.php
Expand Up @@ -7,14 +7,15 @@
*/
use PMA\libraries\SavedSearches;
use PMA\libraries\URL;
use PMA\libraries\Response;

/**
* requirements
*/
require_once 'libraries/common.inc.php';
require_once 'libraries/sql.lib.php';

$response = PMA\libraries\Response::getInstance();
$response = Response::getInstance();

// Gets the relation settings
$cfgRelation = PMA_getRelationsParam();
Expand Down
3 changes: 2 additions & 1 deletion db_search.php
Expand Up @@ -13,9 +13,10 @@
*/
require_once 'libraries/common.inc.php';

use PMA\libraries\Response;
use PMA\libraries\DbSearch;

$response = PMA\libraries\Response::getInstance();
$response = Response::getInstance();
$header = $response->getHeader();
$scripts = $header->getScripts();
$scripts->addFile('db_search.js');
Expand Down
3 changes: 2 additions & 1 deletion db_sql.php
Expand Up @@ -6,6 +6,7 @@
* @package PhpMyAdmin
*/
use PMA\libraries\config\PageSettings;
use PMA\libraries\Response;

/**
*
Expand All @@ -19,7 +20,7 @@
/**
* Runs common work
*/
$response = PMA\libraries\Response::getInstance();
$response = Response::getInstance();
$header = $response->getHeader();
$scripts = $header->getScripts();
$scripts->addFile('makegrid.js');
Expand Down
3 changes: 2 additions & 1 deletion db_sql_autocomplete.php
Expand Up @@ -6,6 +6,7 @@
* @package PhpMyAdmin
*/

use PMA\libraries\Response;
require_once 'libraries/common.inc.php';

if ($GLOBALS['cfg']['EnableAutocompleteForTablesAndColumns']) {
Expand All @@ -22,5 +23,5 @@
} else {
$sql_autocomplete = true;
}
$response = PMA\libraries\Response::getInstance();
$response = Response::getInstance();
$response->addJSON("tables", json_encode($sql_autocomplete));
3 changes: 2 additions & 1 deletion db_sql_format.php
Expand Up @@ -5,6 +5,7 @@
*
* @package PhpMyAdmin
*/
use PMA\libraries\Response;

/**
* Loading common files. Used to check for authorization, localization and to
Expand All @@ -16,5 +17,5 @@

$query = SqlParser\Utils\Formatter::format($query);

$response = PMA\libraries\Response::getInstance();
$response = Response::getInstance();
$response->addJSON("sql", $query);
3 changes: 2 additions & 1 deletion db_tracking.php
Expand Up @@ -5,6 +5,7 @@
*
* @package PhpMyAdmin
*/
use PMA\libraries\Response;
use PMA\libraries\Tracker;

/**
Expand All @@ -16,7 +17,7 @@
require_once 'libraries/display_create_table.lib.php';

//Get some js files needed for Ajax requests
$response = PMA\libraries\Response::getInstance();
$response = Response::getInstance();
$header = $response->getHeader();
$scripts = $header->getScripts();
$scripts->addFile('jquery/jquery.tablesorter.js');
Expand Down
4 changes: 2 additions & 2 deletions error_report.php
Expand Up @@ -5,6 +5,7 @@
*
* @package PhpMyAdmin
*/
use PMA\libraries\Response;
require_once 'libraries/common.inc.php';
require_once 'libraries/error_report.lib.php';
require_once 'libraries/user_preferences.lib.php';
Expand All @@ -15,7 +16,7 @@
die('Oops, something went wrong!!');
}

$response = PMA\libraries\Response::getInstance();
$response = Response::getInstance();

if (isset($_REQUEST['send_error_report'])
&& ($_REQUEST['send_error_report'] == true
Expand All @@ -35,7 +36,6 @@
) {
$_SESSION['error_subm_count'] = 0;
$_SESSION['prev_errors'] = '';
$response = PMA\libraries\Response::getInstance();
$response->addJSON('_stopErrorReportLoop', '1');
} else {
$_SESSION['prev_error_subm_time'] = time();
Expand Down
5 changes: 3 additions & 2 deletions gis_data_editor.php
Expand Up @@ -5,6 +5,7 @@
*
* @package PhpMyAdmin
*/
use PMA\libraries\Response;
use PMA\libraries\gis\GISFactory;
use PMA\libraries\gis\GISVisualization;
use PMA\libraries\URL;
Expand Down Expand Up @@ -101,7 +102,7 @@ function escape($variable)
'visualization' => $visualization,
'openLayers' => $open_layers,
);
$response = PMA\libraries\Response::getInstance();
$response = Response::getInstance();
$response->addJSON($extra_data);
exit;
}
Expand Down Expand Up @@ -427,5 +428,5 @@ function escape($variable)
echo '</div>';
echo '</form>';

PMA\libraries\Response::getInstance()->addJSON('gis_editor', ob_get_contents());
Response::getInstance()->addJSON('gis_editor', ob_get_contents());
ob_end_clean();
12 changes: 3 additions & 9 deletions import.php
Expand Up @@ -5,6 +5,7 @@
*
* @package PhpMyAdmin
*/
use PMA\libraries\Response;
use PMA\libraries\Encoding;
use PMA\libraries\plugins\ImportPlugin;
use PMA\libraries\File;
Expand Down Expand Up @@ -36,17 +37,17 @@
exit;
}

$response = Response::getInstance();

// If it's a refresh console bookmarks request
if (isset($_REQUEST['console_bookmark_refresh'])) {
$response = PMA\libraries\Response::getInstance();
$response->addJSON(
'console_message_bookmark', PMA\libraries\Console::getBookmarkContent()
);
exit;
}
// If it's a console bookmark add request
if (isset($_REQUEST['console_bookmark_add'])) {
$response = PMA\libraries\Response::getInstance();
if (isset($_REQUEST['label']) && isset($_REQUEST['db'])
&& isset($_REQUEST['bookmark_query']) && isset($_REQUEST['shared'])
) {
Expand Down Expand Up @@ -203,7 +204,6 @@
$_SESSION['Import_message']['message'] = $message->getDisplay();
$_SESSION['Import_message']['go_back_url'] = $GLOBALS['goto'];

$response = PMA\libraries\Response::getInstance();
$response->setRequestStatus(false);
$response->addJSON('message', $message);

Expand All @@ -212,7 +212,6 @@

// Add console message id to response output
if (isset($_POST['console_message_id'])) {
$response = PMA\libraries\Response::getInstance();
$response->addJSON('console_message_id', $_POST['console_message_id']);
}

Expand Down Expand Up @@ -335,7 +334,6 @@
// Bookmark Support: get a query back from bookmark if required
if (! empty($_REQUEST['id_bookmark'])) {
$id_bookmark = (int)$_REQUEST['id_bookmark'];
$response = PMA\libraries\Response::getInstance();
switch ($_REQUEST['action_bookmark']) {
case 0: // bookmarked query that have to be run
$bookmark = Bookmark::get(
Expand Down Expand Up @@ -393,7 +391,6 @@
$message = PMA\libraries\Message::success(
__('The bookmark has been deleted.')
);
$response = PMA\libraries\Response::getInstance();
$response->setRequestStatus($message->isSuccess());
$response->addJSON('message', $message);
$response->addJSON('action_bookmark', $_REQUEST['action_bookmark']);
Expand Down Expand Up @@ -746,7 +743,6 @@
);
}

$response = PMA\libraries\Response::getInstance();
$response->addJSON('ajax_reload', $ajax_reload);
$response->addHTML($html_output);
exit();
Expand All @@ -762,15 +758,13 @@
);
}

$response = PMA\libraries\Response::getInstance();
$response->setRequestStatus(true);
$response->addJSON('message', PMA\libraries\Message::success($msg));
$response->addJSON(
'sql_query',
PMA\libraries\Util::getMessage($msg, $sql_query, 'success')
);
} else if ($result == false) {
$response = PMA\libraries\Response::getInstance();
$response->setRequestStatus(false);
$response->addJSON('message', PMA\libraries\Message::error($msg));
} else {
Expand Down

0 comments on commit 308c9d7

Please sign in to comment.