From 72aeab0244ae6925bc989c235655707e7a517bdc Mon Sep 17 00:00:00 2001 From: "Christopher R. Maden" Date: Wed, 18 Apr 2018 17:48:01 -0400 Subject: [PATCH] pkp/pkp-lib#3579: the easy changes... --- .../tab/settings/form/ContextSettingsForm.inc.php | 15 ++++++++------- .../ManageAnnouncementGridHandler.inc.php | 8 ++++---- .../announcements/form/AnnouncementForm.inc.php | 7 ++++--- .../form/AnnouncementTypeForm.inc.php | 2 +- .../grid/files/LibraryFileGridCategoryRow.inc.php | 4 ++-- .../grid/files/LibraryFileGridHandler.inc.php | 4 ++-- .../languages/LanguageGridCellProvider.inc.php | 2 +- .../form/NavigationMenuForm.inc.php | 6 +++--- .../form/NavigationMenuItemsForm.inc.php | 15 +++++++++------ .../grid/settings/genre/GenreGridHandler.inc.php | 4 ++-- .../languages/ManageLanguageGridHandler.inc.php | 4 ++-- .../PreparedEmailsGridHandler.inc.php | 2 +- .../reviewForms/ReviewFormGridHandler.inc.php | 6 ++---- .../reviewForms/form/PreviewReviewForm.inc.php | 5 +++-- .../reviewForms/form/ReviewFormForm.inc.php | 10 ++++++---- .../settings/roles/UserGroupGridHandler.inc.php | 2 +- .../SubmissionChecklistGridHandler.inc.php | 4 ++-- .../grid/settings/user/UserGridHandler.inc.php | 2 +- .../BlockPluginsListbuilderHandler.inc.php | 4 ++-- .../form/AnnouncementSettingsForm.inc.php | 2 +- .../appearance/form/PKPAppearanceForm.inc.php | 2 +- .../form/EmailTemplatesForm.inc.php | 2 +- .../paymentMethod/form/PaymentMethodForm.inc.php | 8 ++++---- 23 files changed, 63 insertions(+), 57 deletions(-) diff --git a/classes/controllers/tab/settings/form/ContextSettingsForm.inc.php b/classes/controllers/tab/settings/form/ContextSettingsForm.inc.php index 4f0819a01ba..9e744503f00 100644 --- a/classes/controllers/tab/settings/form/ContextSettingsForm.inc.php +++ b/classes/controllers/tab/settings/form/ContextSettingsForm.inc.php @@ -82,18 +82,18 @@ function setSettings($settings) { // /** * @copydoc Form::initData() - * @param $request Request */ - function initData($request) { + function initData() { + $application = PKPApplication::getApplication(); + $request = $application->getRequest(); $context = $request->getContext(); $this->_data = $context->getSettings(); } /** * @see Form::readInputData() - * @param $request PKPRequest */ - function readInputData($request) { + function readInputData() { $this->readUserVars(array_keys($this->getSettings())); } @@ -118,10 +118,11 @@ function fetch($request, $params = null) { /** * @see Form::execute() - * @param $request PKPRequest */ - function execute($request) { - parent::execute($request); + function execute() { + parent::execute(); + $application = PKPApplication::getApplication(); + $request = $application->getRequest(); $context = $request->getContext(); $settingsDao = $context->getSettingsDao(); $settings = $this->getSettings(); diff --git a/controllers/grid/announcements/ManageAnnouncementGridHandler.inc.php b/controllers/grid/announcements/ManageAnnouncementGridHandler.inc.php index f3986671be2..e0f1df14aae 100644 --- a/controllers/grid/announcements/ManageAnnouncementGridHandler.inc.php +++ b/controllers/grid/announcements/ManageAnnouncementGridHandler.inc.php @@ -40,8 +40,8 @@ function __construct() { /** * @copydoc AnnouncementGridHandler::initialize() */ - function initialize($request) { - parent::initialize($request); + function initialize($request, $args = null) { + parent::initialize($request, $args); $this->setTitle('announcement.announcements'); @@ -85,10 +85,10 @@ protected function getRowInstance() { /** * @copydoc GridHandler::authorize() */ - function authorize($request, &$args, $roleAssignments) { + function authorize($request, &$args, $roleAssignments, $requireAnnouncementsEnabled = false) { import('lib.pkp.classes.security.authorization.ContextAccessPolicy'); $this->addPolicy(new ContextAccessPolicy($request, $roleAssignments)); - return parent::authorize($request, $args, $roleAssignments, false); + return parent::authorize($request, $args, $roleAssignments, $requireAnnouncementsEnabled); } /** diff --git a/controllers/grid/announcements/form/AnnouncementForm.inc.php b/controllers/grid/announcements/form/AnnouncementForm.inc.php index 5fb2a4a9402..53ad7495c82 100644 --- a/controllers/grid/announcements/form/AnnouncementForm.inc.php +++ b/controllers/grid/announcements/form/AnnouncementForm.inc.php @@ -96,7 +96,7 @@ function getLocaleFieldNames() { /** * @copydoc Form::fetch() */ - function fetch($request) { + function fetch($request, $template = null, $display = false) { $templateMgr = TemplateManager::getManager($request); $templateMgr->assign('readOnly', $this->isReadOnly()); $templateMgr->assign('selectedTypeId', $this->getData('typeId')); @@ -151,9 +151,8 @@ function readInputData() { /** * Save announcement. - * @param $request PKPRequest */ - function execute($request) { + function execute() { $announcementDao = DAORegistry::getDAO('AnnouncementDAO'); $announcement = $announcementDao->getById($this->announcementId); @@ -199,6 +198,8 @@ function execute($request) { import('classes.notification.NotificationManager'); $notificationManager = new NotificationManager(); $userGroupDao = DAORegistry::getDAO('UserGroupDAO'); + $application = PKPApplication::getApplication(); + $request = $application->getRequest(); $notificationUsers = array(); $allUsers = $userGroupDao->getUsersByContextId($contextId); while ($user = $allUsers->next()) { diff --git a/controllers/grid/announcements/form/AnnouncementTypeForm.inc.php b/controllers/grid/announcements/form/AnnouncementTypeForm.inc.php index a484693a53d..4b34ceb9bef 100644 --- a/controllers/grid/announcements/form/AnnouncementTypeForm.inc.php +++ b/controllers/grid/announcements/form/AnnouncementTypeForm.inc.php @@ -54,7 +54,7 @@ function getLocaleFieldNames() { /** * @copydoc Form::fetch() */ - function fetch($request) { + function fetch($request, $template = null, $display = false) { $templateMgr = TemplateManager::getManager($request); $templateMgr->assign('typeId', $this->typeId); return parent::fetch($request, 'controllers/grid/announcements/form/announcementTypeForm.tpl'); diff --git a/controllers/grid/files/LibraryFileGridCategoryRow.inc.php b/controllers/grid/files/LibraryFileGridCategoryRow.inc.php index 10989a2b84f..ac18462b8c9 100644 --- a/controllers/grid/files/LibraryFileGridCategoryRow.inc.php +++ b/controllers/grid/files/LibraryFileGridCategoryRow.inc.php @@ -52,8 +52,8 @@ function getContext() { /** * @copydoc GridCategoryRow::initialize() */ - function initialize($request) { - parent::initialize($request); + function initialize($request, $template = null) { + parent::initialize($request, $template); $this->setId($this->getData()); } } diff --git a/controllers/grid/files/LibraryFileGridHandler.inc.php b/controllers/grid/files/LibraryFileGridHandler.inc.php index 11bb57557b5..34f7dab16c5 100644 --- a/controllers/grid/files/LibraryFileGridHandler.inc.php +++ b/controllers/grid/files/LibraryFileGridHandler.inc.php @@ -78,8 +78,8 @@ function setCanEdit($canEdit) { * Configure the grid * @param $request PKPRequest */ - function initialize($request) { - parent::initialize($request); + function initialize($request, $args = null) { + parent::initialize($request, $args); $router = $request->getRouter(); $this->_context = $router->getContext($request); diff --git a/controllers/grid/languages/LanguageGridCellProvider.inc.php b/controllers/grid/languages/LanguageGridCellProvider.inc.php index e8adbbfc01d..e2e46ca45a7 100644 --- a/controllers/grid/languages/LanguageGridCellProvider.inc.php +++ b/controllers/grid/languages/LanguageGridCellProvider.inc.php @@ -59,7 +59,7 @@ function getTemplateVarsFromRowColumn($row, $column) { /** * @copydoc GridCellProvider::getCellActions() */ - function getCellActions($request, $row, $column) { + function getCellActions($request, $row, $column, $position = GRID_ACTION_POSITION_DEFAULT) { import('lib.pkp.classes.linkAction.request.RemoteActionConfirmationModal'); import('lib.pkp.classes.linkAction.request.AjaxAction'); diff --git a/controllers/grid/navigationMenus/form/NavigationMenuForm.inc.php b/controllers/grid/navigationMenus/form/NavigationMenuForm.inc.php index 7de5b94e5be..292d4b64dba 100644 --- a/controllers/grid/navigationMenus/form/NavigationMenuForm.inc.php +++ b/controllers/grid/navigationMenus/form/NavigationMenuForm.inc.php @@ -52,7 +52,7 @@ function getLocaleFieldNames() { /** * @copydoc Form::fetch() */ - function fetch($request) { + function fetch($request, $template = null, $display = false) { $templateMgr = TemplateManager::getManager($request); $themePlugins = PluginRegistry::getPlugins('themes'); @@ -198,7 +198,7 @@ function execute() { * Perform additional validation checks * @copydoc Form::validate */ - function validate() { + function validate($callHooks = true) { $navigationMenuDao = DAORegistry::getDAO('NavigationMenuDAO'); $navigationMenu = $navigationMenuDao->getByTitle($this->_contextId, $this->getData('title')); @@ -213,7 +213,7 @@ function validate() { } } - return parent::validate(); + return parent::validate($callHooks); } } diff --git a/controllers/grid/navigationMenus/form/NavigationMenuItemsForm.inc.php b/controllers/grid/navigationMenus/form/NavigationMenuItemsForm.inc.php index 868c8a3bebf..6735e0e7653 100644 --- a/controllers/grid/navigationMenus/form/NavigationMenuItemsForm.inc.php +++ b/controllers/grid/navigationMenus/form/NavigationMenuItemsForm.inc.php @@ -59,7 +59,11 @@ function getContextId() { /** * @copydoc Form::fetch() */ - function fetch($request) { + function fetch( + $request, + $template = 'controllers/grid/navigationMenus/form/navigationMenuItemsForm.tpl', + $display = false + ) { AppLocale::requireComponents(LOCALE_COMPONENT_APP_MANAGER); $templateMgr = TemplateManager::getManager($request); @@ -101,7 +105,7 @@ function fetch($request) { 'navigationMenuItemTypeConditionalWarnings' => json_encode($typeConditionalWarnings), )); - return parent::fetch($request, 'controllers/grid/navigationMenus/form/navigationMenuItemsForm.tpl'); + return parent::fetch($request, $template, $display); } /** @@ -131,9 +135,8 @@ function readInputData() { /** * Save NavigationMenuItem. - * @param $request PKPRequest */ - function execute($request) { + function execute() { $navigationMenuItemDao = DAORegistry::getDAO('NavigationMenuItemDAO'); $navigationMenuItem = $navigationMenuItemDao->getById($this->navigationMenuItemId); @@ -162,7 +165,7 @@ function execute($request) { * Perform additional validation checks * @copydoc Form::validate */ - function validate() { + function validate($callHooks = true) { import('lib.pkp.classes.navigationMenu.NavigationMenuItem'); if ($this->getData('menuItemType') && $this->getData('menuItemType') != "") { if ($this->getData('menuItemType') == NMI_TYPE_CUSTOM) { @@ -185,7 +188,7 @@ function validate() { $this->addError('path', __('manager.navigationMenus.form.typeMissing')); } - return parent::validate(); + return parent::validate($callHooks); } } diff --git a/controllers/grid/settings/genre/GenreGridHandler.inc.php b/controllers/grid/settings/genre/GenreGridHandler.inc.php index 0fd95c13755..10e10e73b64 100644 --- a/controllers/grid/settings/genre/GenreGridHandler.inc.php +++ b/controllers/grid/settings/genre/GenreGridHandler.inc.php @@ -38,8 +38,8 @@ function __construct() { * Configure the grid * @param $request PKPRequest */ - function initialize($request) { - parent::initialize($request); + function initialize($request, $args = null) { + parent::initialize($request, $args); // Load language components AppLocale::requireComponents( diff --git a/controllers/grid/settings/languages/ManageLanguageGridHandler.inc.php b/controllers/grid/settings/languages/ManageLanguageGridHandler.inc.php index 825dd7118a1..8751b609cb9 100644 --- a/controllers/grid/settings/languages/ManageLanguageGridHandler.inc.php +++ b/controllers/grid/settings/languages/ManageLanguageGridHandler.inc.php @@ -69,8 +69,8 @@ protected function loadData($request, $filter) { /** * @copydoc LanguageGridHandler::initialize() */ - function initialize($request) { - parent::initialize($request); + function initialize($request, $args = null) { + parent::initialize($request, $args); AppLocale::requireComponents(LOCALE_COMPONENT_APP_MANAGER); $this->addNameColumn(); diff --git a/controllers/grid/settings/preparedEmails/PreparedEmailsGridHandler.inc.php b/controllers/grid/settings/preparedEmails/PreparedEmailsGridHandler.inc.php index 9e927552e38..4fa63be3dee 100644 --- a/controllers/grid/settings/preparedEmails/PreparedEmailsGridHandler.inc.php +++ b/controllers/grid/settings/preparedEmails/PreparedEmailsGridHandler.inc.php @@ -38,7 +38,7 @@ function __construct() { /** * @copydoc PKPHandler::authorize() */ - function authorize($request, $args, $roleAssignments) { + function authorize($request, &$args, $roleAssignments) { import('lib.pkp.classes.security.authorization.ContextAccessPolicy'); $this->addPolicy(new ContextAccessPolicy($request, $roleAssignments)); return parent::authorize($request, $args, $roleAssignments); diff --git a/controllers/grid/settings/reviewForms/ReviewFormGridHandler.inc.php b/controllers/grid/settings/reviewForms/ReviewFormGridHandler.inc.php index 9d61423058b..c27192517db 100644 --- a/controllers/grid/settings/reviewForms/ReviewFormGridHandler.inc.php +++ b/controllers/grid/settings/reviewForms/ReviewFormGridHandler.inc.php @@ -155,11 +155,9 @@ protected function getRowInstance() { } /** - * @see GridHandler::loadData() - * @param $request PKPRequest - * @return array Grid data. + * @copydoc GridHandler::loadData() */ - protected function loadData($request) { + protected function loadData($request, $filter = null) { // Get all review forms. $reviewFormDao = DAORegistry::getDAO('ReviewFormDAO'); $context = $request->getContext(); diff --git a/controllers/grid/settings/reviewForms/form/PreviewReviewForm.inc.php b/controllers/grid/settings/reviewForms/form/PreviewReviewForm.inc.php index 3b00873e506..b18d7b25a35 100644 --- a/controllers/grid/settings/reviewForms/form/PreviewReviewForm.inc.php +++ b/controllers/grid/settings/reviewForms/form/PreviewReviewForm.inc.php @@ -49,11 +49,12 @@ function fetch($args, $request) { /** * Initialize form data from current settings. - * @param $reviewForm ReviewForm optional */ - function initData($request) { + function initData() { if ($this->reviewFormId) { // Get review form + $application = PKPApplication::getApplication(); + $request = $application->getRequest(); $context = $request->getContext(); $reviewFormDao = DAORegistry::getDAO('ReviewFormDAO'); $reviewForm = $reviewFormDao->getById($this->reviewFormId, Application::getContextAssocType(), $context->getId()); diff --git a/controllers/grid/settings/reviewForms/form/ReviewFormForm.inc.php b/controllers/grid/settings/reviewForms/form/ReviewFormForm.inc.php index 3d2f8c3630c..06e67dc8645 100644 --- a/controllers/grid/settings/reviewForms/form/ReviewFormForm.inc.php +++ b/controllers/grid/settings/reviewForms/form/ReviewFormForm.inc.php @@ -43,10 +43,11 @@ function readInputData() { /** * Initialize form data from current settings. - * @param $request PKPRequest */ - function initData($request) { + function initData() { if ($this->reviewFormId) { + $application = PKPApplication::getApplication(); + $request = $application->getRequest(); $context = $request->getContext(); $reviewFormDao = DAORegistry::getDAO('ReviewFormDAO'); $reviewForm = $reviewFormDao->getById($this->reviewFormId, Application::getContextAssocType(), $context->getId()); @@ -70,9 +71,10 @@ function fetch($args, $request) { /** * Save review form. - * @param $request PKPRequest */ - function execute($request) { + function execute() { + $application = PKPApplication::getApplication(); + $request = $application->getRequest(); $context = $request->getContext(); $reviewFormDao = DAORegistry::getDAO('ReviewFormDAO'); diff --git a/controllers/grid/settings/roles/UserGroupGridHandler.inc.php b/controllers/grid/settings/roles/UserGroupGridHandler.inc.php index b4e0ef3a604..141fb9ab52a 100644 --- a/controllers/grid/settings/roles/UserGroupGridHandler.inc.php +++ b/controllers/grid/settings/roles/UserGroupGridHandler.inc.php @@ -192,7 +192,7 @@ protected function getRowInstance() { /** * @see GridHandler::renderFilter() */ - function renderFilter($request) { + function renderFilter($request, $filterData = null) { // Get filter data. $roleDao = DAORegistry::getDAO('RoleDAO'); $roleOptions = array(0 => 'grid.user.allPermissionLevels') + Application::getRoleNames(true); diff --git a/controllers/grid/settings/submissionChecklist/SubmissionChecklistGridHandler.inc.php b/controllers/grid/settings/submissionChecklist/SubmissionChecklistGridHandler.inc.php index 1d1f2060ddf..1dd40190c69 100644 --- a/controllers/grid/settings/submissionChecklist/SubmissionChecklistGridHandler.inc.php +++ b/controllers/grid/settings/submissionChecklist/SubmissionChecklistGridHandler.inc.php @@ -33,8 +33,8 @@ function __construct() { /** * @copydoc SetupGridHandler::initialize() */ - function initialize($request) { - parent::initialize($request); + function initialize($request, $args = null) { + parent::initialize($request, $args); // Basic grid configuration $this->setId('submissionChecklist'); diff --git a/controllers/grid/settings/user/UserGridHandler.inc.php b/controllers/grid/settings/user/UserGridHandler.inc.php index 1483d589a05..e6aa0b1655d 100644 --- a/controllers/grid/settings/user/UserGridHandler.inc.php +++ b/controllers/grid/settings/user/UserGridHandler.inc.php @@ -179,7 +179,7 @@ protected function loadData($request, $filter) { /** * @copydoc GridHandler::renderFilter() */ - function renderFilter($request) { + function renderFilter($request, $filterData = null) { $context = $request->getContext(); $userGroupDao = DAORegistry::getDAO('UserGroupDAO'); $userGroups = $userGroupDao->getByContextId($context->getId()); diff --git a/controllers/listbuilder/settings/BlockPluginsListbuilderHandler.inc.php b/controllers/listbuilder/settings/BlockPluginsListbuilderHandler.inc.php index b27dc839d4a..3a03b9ada91 100644 --- a/controllers/listbuilder/settings/BlockPluginsListbuilderHandler.inc.php +++ b/controllers/listbuilder/settings/BlockPluginsListbuilderHandler.inc.php @@ -45,8 +45,8 @@ function authorize($request, &$args, $roleAssignments) { /** * @copydoc ListbuilderHandler::initialize() */ - function initialize($request) { - parent::initialize($request); + function initialize($request, $args = null) { + parent::initialize($request, $args); AppLocale::requireComponents(LOCALE_COMPONENT_PKP_MANAGER); // Basic configuration diff --git a/controllers/tab/settings/announcements/form/AnnouncementSettingsForm.inc.php b/controllers/tab/settings/announcements/form/AnnouncementSettingsForm.inc.php index c726485abdc..2c73d9898e5 100644 --- a/controllers/tab/settings/announcements/form/AnnouncementSettingsForm.inc.php +++ b/controllers/tab/settings/announcements/form/AnnouncementSettingsForm.inc.php @@ -49,7 +49,7 @@ function getLocaleFieldNames() { /** * @copydoc ContextSettingsForm::fetch() */ - function fetch($request) { + function fetch($request, $params = null) { for($x = 1; $x < 11; $x++) { $numAnnouncementsHomepageOptions[$x] = $x; } diff --git a/controllers/tab/settings/appearance/form/PKPAppearanceForm.inc.php b/controllers/tab/settings/appearance/form/PKPAppearanceForm.inc.php index c56dd5d1fa6..f6594a8de29 100644 --- a/controllers/tab/settings/appearance/form/PKPAppearanceForm.inc.php +++ b/controllers/tab/settings/appearance/form/PKPAppearanceForm.inc.php @@ -84,7 +84,7 @@ function getLocaleFieldNames() { /** * @copydoc ContextSettingsForm::fetch() */ - function fetch($request) { + function fetch($request, $params = null) { // Get all upload form image link actions. $uploadImageLinkActions = array(); foreach ($this->getImagesSettingsName() as $settingName => $altText) { diff --git a/controllers/tab/settings/emailTemplates/form/EmailTemplatesForm.inc.php b/controllers/tab/settings/emailTemplates/form/EmailTemplatesForm.inc.php index e97f126acdf..21cde5c1724 100644 --- a/controllers/tab/settings/emailTemplates/form/EmailTemplatesForm.inc.php +++ b/controllers/tab/settings/emailTemplates/form/EmailTemplatesForm.inc.php @@ -38,7 +38,7 @@ function __construct($wizardMode = false) { /** * @copydoc ContextSettingsForm::fetch() */ - function fetch($request) { + function fetch($request, $params = null) { $context = $request->getContext(); $dispatcher = $request->getDispatcher(); return parent::fetch($request, array( diff --git a/controllers/tab/settings/paymentMethod/form/PaymentMethodForm.inc.php b/controllers/tab/settings/paymentMethod/form/PaymentMethodForm.inc.php index a3735295a84..dd6bda45f16 100644 --- a/controllers/tab/settings/paymentMethod/form/PaymentMethodForm.inc.php +++ b/controllers/tab/settings/paymentMethod/form/PaymentMethodForm.inc.php @@ -53,7 +53,7 @@ function initData($request) { /** * @copydoc ContextSettingsForm::fetch() */ - function fetch($request) { + function fetch($request, $params = null) { $templateMgr = TemplateManager::getManager($request); $currencyDao = DAORegistry::getDAO('CurrencyDAO'); $currencies = array(); @@ -61,7 +61,7 @@ function fetch($request) { $currencies[$currency->getCodeAlpha()] = $currency->getName(); } $templateMgr->assign('currencies', $currencies); - return parent::fetch($request); + return parent::fetch($request, $params); } /** @@ -106,13 +106,13 @@ function execute($request) { * Validate the form. * @copydoc Form::validate */ - function validate() { + function validate($callHooks = true) { if (!$this->settingsForm->validate()) { foreach ($this->settingsForm->getErrorsArray() as $field => $message) { $this->addError($field, $message); } } - return parent::validate(); + return parent::validate($callHooks); } }