first commit

This commit is contained in:
CHIEFSOFT\ameye
2024-06-08 17:09:23 -04:00
commit df3a033196
17887 changed files with 8637778 additions and 0 deletions
@@ -0,0 +1,63 @@
<?php
/**
* @file controllers/grid/navigationMenus/NavigationMenuItemsCellProvider.php
*
* Copyright (c) 2014-2021 Simon Fraser University
* Copyright (c) 2003-2021 John Willinsky
* Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
*
* @class NavigationMenuItemsGridCellProvider
*
* @ingroup controllers_grid_navigationMenus
*
* @brief Cell provider for title column of a NavigationMenuItems grid.
*/
namespace PKP\controllers\grid\navigationMenus;
use APP\core\Application;
use APP\core\Services;
use APP\template\TemplateManager;
use PKP\controllers\grid\GridCellProvider;
use PKP\controllers\grid\GridColumn;
use PKP\controllers\grid\GridHandler;
class NavigationMenuItemsGridCellProvider extends GridCellProvider
{
/**
* @copydoc GridCellProvider::getCellActions()
*/
public function getCellActions($request, $row, $column, $position = GridHandler::GRID_ACTION_POSITION_DEFAULT)
{
return parent::getCellActions($request, $row, $column, $position);
}
/**
* Extracts variables for a given column from a data element
* so that they may be assigned to template before rendering.
*
* @param \PKP\controllers\grid\GridRow $row
* @param GridColumn $column
*
* @return array
*/
public function getTemplateVarsFromRowColumn($row, $column)
{
$navigationMenuItem = $row->getData();
$columnId = $column->getId();
assert($navigationMenuItem instanceof \PKP\navigationMenu\NavigationMenuItem && !empty($columnId));
switch ($columnId) {
case 'title':
$templateMgr = TemplateManager::getManager(Application::get()->getRequest());
Services::get('navigationMenu')->transformNavMenuItemTitle($templateMgr, $navigationMenuItem);
return ['label' => $navigationMenuItem->getLocalizedTitle()];
default:
break;
}
return parent::getTemplateVarsFromRowColumn($row, $column);
}
}
@@ -0,0 +1,274 @@
<?php
/**
* @file controllers/grid/navigationMenus/NavigationMenuItemsGridHandler.php
*
* Copyright (c) 2014-2021 Simon Fraser University
* Copyright (c) 2003-2021 John Willinsky
* Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
*
* @class NavigationMenuItemsGridHandler
*
* @ingroup controllers_grid_navigationMenus
*
* @brief Handle NavigationMenuItems grid requests.
*/
namespace PKP\controllers\grid\navigationMenus;
use APP\controllers\grid\navigationMenus\form\NavigationMenuItemsForm;
use APP\core\Request;
use APP\notification\NotificationManager;
use PKP\controllers\grid\GridColumn;
use PKP\controllers\grid\GridHandler;
use PKP\core\JSONMessage;
use PKP\core\PKPRequest;
use PKP\db\DAORegistry;
use PKP\linkAction\LinkAction;
use PKP\linkAction\request\AjaxModal;
use PKP\navigationMenu\NavigationMenuItemDAO;
use PKP\notification\PKPNotification;
use PKP\security\authorization\PolicySet;
use PKP\security\authorization\RoleBasedHandlerOperationPolicy;
use PKP\security\Role;
class NavigationMenuItemsGridHandler extends GridHandler
{
/**
* Constructor
*/
public function __construct()
{
parent::__construct();
$this->addRoleAssignment(
Role::ROLE_ID_MANAGER,
$ops = [
'fetchGrid', 'fetchRow',
'addNavigationMenuItem', 'editNavigationMenuItem',
'updateNavigationMenuItem',
'deleteNavigationMenuItem', 'saveSequence',
]
);
$this->addRoleAssignment(Role::ROLE_ID_SITE_ADMIN, $ops);
}
//
// Overridden template methods
//
/**
* @copydoc GridHandler::authorize()
*/
public function authorize($request, &$args, $roleAssignments)
{
$context = $request->getContext();
$contextId = $context ? $context->getId() : \PKP\core\PKPApplication::CONTEXT_ID_NONE;
$rolePolicy = new PolicySet(PolicySet::COMBINING_PERMIT_OVERRIDES);
foreach ($roleAssignments as $role => $operations) {
$rolePolicy->addPolicy(new RoleBasedHandlerOperationPolicy($request, $role, $operations));
}
$this->addPolicy($rolePolicy);
$navigationMenuItemId = $request->getUserVar('navigationMenuItemId');
if ($navigationMenuItemId) {
$navigationMenuItemDao = DAORegistry::getDAO('NavigationMenuItemDAO'); /** @var NavigationMenuItemDAO $navigationMenuItemDao */
$navigationMenuItem = $navigationMenuItemDao->getById($navigationMenuItemId);
if (!$navigationMenuItem || $navigationMenuItem->getContextId() != $contextId) {
return false;
}
}
return parent::authorize($request, $args, $roleAssignments);
}
/**
* @copydoc GridHandler::initialize()
*
* @param null|mixed $args
*/
public function initialize($request, $args = null)
{
parent::initialize($request, $args);
// Basic grid configuration
$this->setTitle('manager.navigationMenuItems');
// Set the no items row text
$this->setEmptyRowText('grid.navigationMenus.navigationMenuItems.noneExist');
// Columns
$navigationMenuItemsCellProvider = new NavigationMenuItemsGridCellProvider();
$this->addColumn(
new GridColumn(
'title',
'common.title',
null,
null,
$navigationMenuItemsCellProvider
)
);
// Add grid action.
$router = $request->getRouter();
$this->addAction(
new LinkAction(
'addNavigationMenuItem',
new AjaxModal(
$router->url($request, null, null, 'addNavigationMenuItem', null, null),
__('grid.action.addNavigationMenuItem'),
'modal_add_item',
true
),
__('grid.action.addNavigationMenuItem'),
'add_item'
)
);
}
/**
* @copydoc GridHandler::loadData()
*/
protected function loadData($request, $filter)
{
$context = $request->getContext();
$contextId = \PKP\core\PKPApplication::CONTEXT_ID_NONE;
if ($context) {
$contextId = $context->getId();
}
$navigationMenuItemDao = DAORegistry::getDAO('NavigationMenuItemDAO'); /** @var NavigationMenuItemDAO $navigationMenuItemDao */
return $navigationMenuItemDao->getByContextId($contextId);
}
/**
* @copydoc GridHandler::getRowInstance()
*/
protected function getRowInstance()
{
return new NavigationMenuItemsGridRow();
}
//
// Public grid actions.
//
/**
* Update NavigationMenuItem
*
* @param array $args
* @param Request $request
*
* @return JSONMessage JSON object
*/
public function updateNavigationMenuItem($args, $request)
{
$navigationMenuItemId = (int)$request->getUserVar('navigationMenuItemId');
$context = $request->getContext();
$contextId = \PKP\core\PKPApplication::CONTEXT_ID_NONE;
if ($context) {
$contextId = $context->getId();
}
$navigationMenuItemForm = new NavigationMenuItemsForm($contextId, $navigationMenuItemId);
$navigationMenuItemForm->readInputData();
if ($navigationMenuItemForm->validate()) {
$navigationMenuItemForm->execute();
if ($navigationMenuItemId) {
// Successful edit of an existing $navigationMenuItem.
$notificationLocaleKey = 'notification.editedNavigationMenuItem';
} else {
// Successful added a new $navigationMenuItemForm.
$notificationLocaleKey = 'notification.addedNavigationMenuItem';
}
// Record the notification to user.
$notificationManager = new NotificationManager();
$user = $request->getUser();
$notificationManager->createTrivialNotification($user->getId(), PKPNotification::NOTIFICATION_TYPE_SUCCESS, ['contents' => __($notificationLocaleKey)]);
// Prepare the grid row data.
return \PKP\db\DAO::getDataChangedEvent($navigationMenuItemId);
} else {
return new JSONMessage(false);
}
}
/**
* Display form to edit a navigation menu item object.
*
* @param array $args
* @param PKPRequest $request
*
* @return JSONMessage JSON object
*/
public function editNavigationMenuItem($args, $request)
{
$navigationMenuItemId = (int) $request->getUserVar('navigationMenuItemId');
$context = $request->getContext();
$contextId = \PKP\core\PKPApplication::CONTEXT_ID_NONE;
if ($context) {
$contextId = $context->getId();
}
$navigationMenuItemForm = new NavigationMenuItemsForm($contextId, $navigationMenuItemId);
$navigationMenuItemForm->initData();
return new JSONMessage(true, $navigationMenuItemForm->fetch($request));
}
/**
* Add NavigationMenuItem
*
* @param array $args
* @param Request $request
*
* @return JSONMessage JSON object
*/
public function addNavigationMenuItem($args, $request)
{
$navigationMenuItemId = (int)$request->getUserVar('navigationMenuItemId');
$context = $request->getContext();
$contextId = \PKP\core\PKPApplication::CONTEXT_ID_NONE;
if ($context) {
$contextId = $context->getId();
}
$navigationMenuItemForm = new NavigationMenuItemsForm($contextId, $navigationMenuItemId);
$navigationMenuItemForm->initData();
return new JSONMessage(true, $navigationMenuItemForm->fetch($request));
}
/**
* Delete a navigation Menu item.
*
* @param array $args
* @param PKPRequest $request
*
* @return JSONMessage JSON object
*/
public function deleteNavigationMenuItem($args, $request)
{
if (!$request->checkCSRF()) return new JSONMessage(false);
$navigationMenuItemId = (int) $request->getUserVar('navigationMenuItemId');
$navigationMenuItemDao = DAORegistry::getDAO('NavigationMenuItemDAO'); /** @var NavigationMenuItemDAO $navigationMenuItemDao */
$navigationMenuItem = $navigationMenuItemDao->getById($navigationMenuItemId);
if ($navigationMenuItem) {
$navigationMenuItemDao->deleteObject($navigationMenuItem);
// Create notification.
$notificationManager = new NotificationManager();
$user = $request->getUser();
$notificationManager->createTrivialNotification($user->getId(), PKPNotification::NOTIFICATION_TYPE_SUCCESS, ['contents' => __('notification.removedNavigationMenuItem')]);
return \PKP\db\DAO::getDataChangedEvent($navigationMenuItemId);
}
return new JSONMessage(false);
}
}
@@ -0,0 +1,81 @@
<?php
/**
* @file controllers/grid/navigationMenus/NavigationMenuItemsGridRow.php
*
* Copyright (c) 2014-2021 Simon Fraser University
* Copyright (c) 2000-2021 John Willinsky
* Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
*
* @class NavigationMenuItemsGridRow
*
* @ingroup controllers_grid_navigationMenus
*
* @brief NavigationMenuItem grid row definition
*/
namespace PKP\controllers\grid\navigationMenus;
use PKP\controllers\grid\GridRow;
use PKP\linkAction\LinkAction;
use PKP\linkAction\request\AjaxModal;
use PKP\linkAction\request\RemoteActionConfirmationModal;
class NavigationMenuItemsGridRow extends GridRow
{
//
// Overridden methods from GridRow
//
/**
* @copydoc GridRow::initialize()
*
* @param null|mixed $template
*/
public function initialize($request, $template = null)
{
parent::initialize($request, $template);
$element = $this->getData();
assert($element instanceof \PKP\navigationMenu\NavigationMenuItem);
$rowId = $this->getId();
// Is this a new row or an existing row?
if (!empty($rowId) && is_numeric($rowId)) {
// Only add row actions if this is an existing row
$router = $request->getRouter();
$actionArgs = [
'navigationMenuItemId' => $rowId
];
$this->addAction(
new LinkAction(
'edit',
new AjaxModal(
$router->url($request, null, null, 'editNavigationMenuItem', null, $actionArgs),
__('grid.action.edit'),
'modal_edit',
true
),
__('grid.action.edit'),
'edit'
)
);
$this->addAction(
new LinkAction(
'remove',
new RemoteActionConfirmationModal(
$request->getSession(),
__('common.confirmDelete'),
__('common.remove'),
$router->url($request, null, null, 'deleteNavigationMenuItem', null, $actionArgs),
'modal_delete'
),
__('grid.action.remove'),
'delete'
)
);
}
}
}
@@ -0,0 +1,96 @@
<?php
/**
* @file controllers/grid/navigationMenus/NavigationMenusGridCellProvider.php
*
* Copyright (c) 2014-2021 Simon Fraser University
* Copyright (c) 2003-2021 John Willinsky
* Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
*
* @class NavigationMenusGridCellProvider
*
* @ingroup controllers_grid_navigationMenus
*
* @brief Cell provider for title column of a NavigationMenu grid.
*/
namespace PKP\controllers\grid\navigationMenus;
use APP\core\Application;
use APP\core\Services;
use APP\template\TemplateManager;
use PKP\controllers\grid\GridCellProvider;
use PKP\controllers\grid\GridColumn;
use PKP\controllers\grid\GridHandler;
use PKP\db\DAORegistry;
use PKP\linkAction\LinkAction;
use PKP\linkAction\request\AjaxModal;
use PKP\navigationMenu\NavigationMenuItemDAO;
class NavigationMenusGridCellProvider extends GridCellProvider
{
/**
* @copydoc GridCellProvider::getCellActions()
*/
public function getCellActions($request, $row, $column, $position = GridHandler::GRID_ACTION_POSITION_DEFAULT)
{
switch ($column->getId()) {
case 'title':
$navigationMenu = $row->getData();
$router = $request->getRouter();
$actionArgs = ['navigationMenuId' => $row->getId()];
return [new LinkAction(
'edit',
new AjaxModal(
$router->url($request, null, null, 'editNavigationMenu', null, $actionArgs),
__('grid.action.edit'),
null,
true
),
htmlspecialchars($navigationMenu->getTitle())
)];
}
return parent::getCellActions($request, $row, $column, $position);
}
/**
* Extracts variables for a given column from a data element
* so that they may be assigned to template before rendering.
*
* @param \PKP\controllers\grid\GridRow $row
* @param GridColumn $column
*
* @return array
*/
public function getTemplateVarsFromRowColumn($row, $column)
{
$navigationMenu = $row->getData();
$columnId = $column->getId();
assert($navigationMenu instanceof \PKP\navigationMenu\NavigationMenu && !empty($columnId));
switch ($columnId) {
case 'title':
return ['label' => ''];
case 'nmis':
$navigationMenuItemDao = DAORegistry::getDAO('NavigationMenuItemDAO'); /** @var NavigationMenuItemDAO $navigationMenuItemDao */
$items = $navigationMenuItemDao->getByMenuId($navigationMenu->getId())->toArray();
$navigationMenusTitles = '';
$templateMgr = TemplateManager::getManager(Application::get()->getRequest());
foreach ($items as $item) {
Services::get('navigationMenu')->transformNavMenuItemTitle($templateMgr, $item);
$navigationMenusTitles = $navigationMenusTitles . $item->getLocalizedTitle() . ', ';
}
$navigationMenusTitles = trim($navigationMenusTitles, ', ');
return ['label' => $navigationMenusTitles];
default:
break;
}
return parent::getTemplateVarsFromRowColumn($row, $column);
}
}
@@ -0,0 +1,277 @@
<?php
/**
* @file controllers/grid/navigationMenus/NavigationMenusGridHandler.php
*
* Copyright (c) 2014-2021 Simon Fraser University
* Copyright (c) 2003-2021 John Willinsky
* Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
*
* @class NavigationMenusGridHandler
*
* @ingroup controllers_grid_navigationMenus
*
* @brief Handle NavigationMenus grid requests.
*/
namespace PKP\controllers\grid\navigationMenus;
use APP\notification\NotificationManager;
use PKP\controllers\grid\GridColumn;
use PKP\controllers\grid\GridHandler;
use PKP\controllers\grid\navigationMenus\form\NavigationMenuForm;
use PKP\core\JSONMessage;
use PKP\core\PKPRequest;
use PKP\db\DAORegistry;
use PKP\linkAction\LinkAction;
use PKP\linkAction\request\AjaxModal;
use PKP\navigationMenu\NavigationMenuDAO;
use PKP\notification\PKPNotification;
use PKP\security\authorization\PolicySet;
use PKP\security\authorization\RoleBasedHandlerOperationPolicy;
use PKP\security\Role;
class NavigationMenusGridHandler extends GridHandler
{
/**
* Constructor
*/
public function __construct()
{
parent::__construct();
$this->addRoleAssignment(
Role::ROLE_ID_MANAGER,
$ops = [
'fetchGrid', 'fetchRow',
'addNavigationMenu', 'editNavigationMenu',
'updateNavigationMenu',
'deleteNavigationMenu'
]
);
$this->addRoleAssignment(Role::ROLE_ID_SITE_ADMIN, $ops);
}
//
// Overridden template methods
//
/**
* @copydoc GridHandler::authorize()
*/
public function authorize($request, &$args, $roleAssignments)
{
$context = $request->getContext();
$contextId = $context ? $context->getId() : \PKP\core\PKPApplication::CONTEXT_ID_NONE;
$rolePolicy = new PolicySet(PolicySet::COMBINING_PERMIT_OVERRIDES);
foreach ($roleAssignments as $role => $operations) {
$rolePolicy->addPolicy(new RoleBasedHandlerOperationPolicy($request, $role, $operations));
}
$this->addPolicy($rolePolicy);
$navigationMenuId = $request->getUserVar('navigationMenuId');
if ($navigationMenuId) {
// Ensure NavigationMenus is valid and for this context
$navigationMenuDao = DAORegistry::getDAO('NavigationMenuDAO'); /** @var NavigationMenuDAO $navigationMenuDao */
$navigationMenu = $navigationMenuDao->getById($navigationMenuId);
if (!$navigationMenu || $navigationMenu->getContextId() != $contextId) {
return false;
}
}
return parent::authorize($request, $args, $roleAssignments);
}
/**
* @copydoc GridHandler::initialize()
*
* @param null|mixed $args
*/
public function initialize($request, $args = null)
{
parent::initialize($request, $args);
// Basic grid configuration
$this->setTitle('manager.navigationMenus');
// Set the no items row text
$this->setEmptyRowText('grid.navigationMenus.navigationMenu.noneExist');
// Columns
$navigationMenuCellProvider = new NavigationMenusGridCellProvider();
$this->addColumn(
new GridColumn(
'title',
'common.title',
null,
null,
$navigationMenuCellProvider
)
);
$this->addColumn(
new GridColumn(
'nmis',
'manager.navigationMenuItems',
null,
null,
$navigationMenuCellProvider
)
);
// Add grid action.
$router = $request->getRouter();
$this->addAction(
new LinkAction(
'addNavigationMenu',
new AjaxModal(
$router->url($request, null, null, 'addNavigationMenu', null, null),
__('grid.action.addNavigationMenu'),
'modal_add_item',
true
),
__('grid.action.addNavigationMenu'),
'add_item'
)
);
}
/**
* @copydoc GridHandler::loadData()
*/
protected function loadData($request, $filter)
{
$context = $request->getContext();
$contextId = \PKP\core\PKPApplication::CONTEXT_ID_NONE;
if ($context) {
$contextId = $context->getId();
}
$navigationMenuDao = DAORegistry::getDAO('NavigationMenuDAO'); /** @var NavigationMenuDAO $navigationMenuDao */
return $navigationMenuDao->getByContextId($contextId);
}
/**
* @copydoc GridHandler::getRowInstance()
*/
protected function getRowInstance()
{
return new NavigationMenusGridRow();
}
//
// Public grid actions.
//
/**
* Display form to add NavigationMenus.
*
* @param array $args
* @param PKPRequest $request
*
* @return JSONMessage
*/
public function addNavigationMenu($args, $request)
{
return $this->editNavigationMenu($args, $request);
}
/**
* Display form to edit NavigationMenus.
*
* @param array $args
* @param PKPRequest $request
*
* @return JSONMessage JSON object
*/
public function editNavigationMenu($args, $request)
{
$navigationMenuId = (int)$request->getUserVar('navigationMenuId');
$context = $request->getContext();
$contextId = \PKP\core\PKPApplication::CONTEXT_ID_NONE;
if ($context) {
$contextId = $context->getId();
}
$navigationMenuForm = new NavigationMenuForm($contextId, $navigationMenuId);
$navigationMenuForm->initData();
return new JSONMessage(true, $navigationMenuForm->fetch($request));
}
/**
* Save an edited/inserted NavigationMenus.
*
* @param array $args
* @param PKPRequest $request
*
* @return JSONMessage JSON object
*/
public function updateNavigationMenu($args, $request)
{
// Identify the NavigationMenu id.
$navigationMenuId = $request->getUserVar('navigationMenuId');
$context = $request->getContext();
$contextId = \PKP\core\PKPApplication::CONTEXT_ID_NONE;
if ($context) {
$contextId = $context->getId();
}
// Form handling.
$navigationMenusForm = new NavigationMenuForm($contextId, $navigationMenuId);
$navigationMenusForm->readInputData();
if ($navigationMenusForm->validate()) {
$navigationMenusForm->execute();
if ($navigationMenuId) {
// Successful edit of an existing NavigationMenu.
$notificationLocaleKey = 'notification.editedNavigationMenu';
} else {
// Successful added a new NavigationMenu.
$notificationLocaleKey = 'notification.addedNavigationMenu';
}
// Record the notification to user.
$notificationManager = new NotificationManager();
$user = $request->getUser();
$notificationManager->createTrivialNotification($user->getId(), PKPNotification::NOTIFICATION_TYPE_SUCCESS, ['contents' => __($notificationLocaleKey)]);
// Prepare the grid row data.
return \PKP\db\DAO::getDataChangedEvent($navigationMenuId);
} else {
return new JSONMessage(false);
}
}
/**
* Delete a NavigationMenu.
*
* @param array $args
* @param PKPRequest $request
*
* @return JSONMessage JSON object
*/
public function deleteNavigationMenu($args, $request)
{
$navigationMenuId = (int) $request->getUserVar('navigationMenuId');
$context = $request->getContext();
$navigationMenuDao = DAORegistry::getDAO('NavigationMenuDAO'); /** @var NavigationMenuDAO $navigationMenuDao */
$navigationMenu = $navigationMenuDao->getById($navigationMenuId, $context ? $context->getId() : \PKP\core\PKPApplication::CONTEXT_SITE);
if ($navigationMenu && $request->checkCSRF()) {
$navigationMenuDao->deleteObject($navigationMenu);
// Create notification.
$notificationManager = new NotificationManager();
$user = $request->getUser();
$notificationManager->createTrivialNotification($user->getId(), PKPNotification::NOTIFICATION_TYPE_SUCCESS, ['contents' => __('notification.removedNavigationMenu')]);
return \PKP\db\DAO::getDataChangedEvent($navigationMenuId);
}
return new JSONMessage(false);
}
}
@@ -0,0 +1,80 @@
<?php
/**
* @file controllers/grid/navigationMenus/NavigationMenusGridRow.php
*
* Copyright (c) 2014-2021 Simon Fraser University
* Copyright (c) 2000-2021 John Willinsky
* Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
*
* @class NavigationMenusGridRow
*
* @ingroup controllers_grid_navigationMenus
*
* @brief NavigationMenu grid row definition
*/
namespace PKP\controllers\grid\navigationMenus;
use PKP\controllers\grid\GridRow;
use PKP\linkAction\LinkAction;
use PKP\linkAction\request\AjaxModal;
use PKP\linkAction\request\RemoteActionConfirmationModal;
class NavigationMenusGridRow extends GridRow
{
//
// Overridden methods from GridRow
//
/**
* @copydoc GridRow::initialize()
*
* @param null|mixed $template
*/
public function initialize($request, $template = null)
{
parent::initialize($request, $template);
$element = $this->getData();
assert($element instanceof \PKP\navigationMenu\NavigationMenu);
$rowId = $this->getId();
// Is this a new row or an existing row?
if (!empty($rowId) && is_numeric($rowId)) {
// Only add row actions if this is an existing row
$router = $request->getRouter();
$actionArgs = [
'navigationMenuId' => $rowId
];
$this->addAction(
new LinkAction(
'edit',
new AjaxModal(
$router->url($request, null, null, 'editNavigationMenu', null, $actionArgs),
__('grid.action.edit'),
'modal_edit',
true
),
__('grid.action.edit'),
'edit'
)
);
$this->addAction(
new LinkAction(
'remove',
new RemoteActionConfirmationModal(
$request->getSession(),
__('common.confirmDelete'),
__('common.remove'),
$router->url($request, null, null, 'deleteNavigationMenu', null, $actionArgs),
'modal_delete'
),
__('grid.action.remove'),
'delete'
)
);
}
}
}
@@ -0,0 +1,240 @@
<?php
/**
* @file controllers/grid/navigationMenus/form/NavigationMenuForm.php
*
* Copyright (c) 2014-2021 Simon Fraser University
* Copyright (c) 2000-2021 John Willinsky
* Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
*
* @class NavigationMenuForm
*
* @ingroup controllers_grid_navigationMenus_form
*
* @see NavigationMenu
*
* @brief Form for manager to create/edit NavigationMenus.
*/
namespace PKP\controllers\grid\navigationMenus\form;
use APP\core\Services;
use APP\template\TemplateManager;
use PKP\db\DAORegistry;
use PKP\form\Form;
use PKP\navigationMenu\NavigationMenuDAO;
use PKP\navigationMenu\NavigationMenuItemAssignment;
use PKP\navigationMenu\NavigationMenuItemAssignmentDAO;
use PKP\navigationMenu\NavigationMenuItemDAO;
use PKP\plugins\PluginRegistry;
class NavigationMenuForm extends Form
{
/** @var int Context ID */
public $_contextId;
/** @var int $_navigationMenuId The menu id being edited */
public $_navigationMenuId;
/**
* Constructor
*
* @param int $contextId Context ID
* @param int $navigationMenuId NavigationMenu Id
*/
public function __construct($contextId, $navigationMenuId = null)
{
$this->_navigationMenuId = !empty($navigationMenuId) ? (int) $navigationMenuId : null;
$this->_contextId = $contextId;
parent::__construct('controllers/grid/navigationMenus/form/navigationMenuForm.tpl');
$this->addCheck(new \PKP\form\validation\FormValidator($this, 'title', 'required', 'manager.navigationMenus.form.titleRequired'));
$this->addCheck(new \PKP\form\validation\FormValidatorPost($this));
$this->addCheck(new \PKP\form\validation\FormValidatorCSRF($this));
}
/**
* Get a list of localized field names for this form
*
* @return ?array
*/
public function getLocaleFieldNames()
{
return null;
}
/**
* @copydoc Form::fetch()
*
* @param null|mixed $template
*/
public function fetch($request, $template = null, $display = false)
{
$templateMgr = TemplateManager::getManager($request);
$themePlugins = PluginRegistry::getPlugins('themes');
if (empty($themePlugins)) {
$themePlugins = PluginRegistry::loadCategory('themes', true);
}
$activeThemeNavigationAreas = [];
$activeThemeNavigationAreas = ['' => __('common.none')];
foreach ($themePlugins as $themePlugin) {
if ($themePlugin->isActive()) {
$areas = $themePlugin->getMenuAreas();
foreach ($areas as $area) {
$activeThemeNavigationAreas[$area] = $area;
}
}
}
$context = $request->getContext();
$contextId = \PKP\core\PKPApplication::CONTEXT_ID_NONE;
if ($context) {
$contextId = $context->getId();
}
$navigationMenuItemDao = DAORegistry::getDAO('NavigationMenuItemDAO'); /** @var NavigationMenuItemDAO $navigationMenuItemDao */
$navigationMenuItems = $navigationMenuItemDao->getByContextId($contextId)
->toArray();
$assignedItems = $navigationMenuItemDao->getByMenuId($this->_navigationMenuId)
->toArray();
$unassignedItems = array_udiff($navigationMenuItems, $assignedItems, function ($a, $b) {
return $a->getId() - $b->getId();
});
foreach ($unassignedItems as $unassignedItem) {
Services::get('navigationMenu')->transformNavMenuItemTitle($templateMgr, $unassignedItem);
}
$navigationMenuItemTypes = Services::get('navigationMenu')->getMenuItemTypes();
$typeConditionalWarnings = [];
foreach ($navigationMenuItemTypes as $type => $settings) {
if (array_key_exists('conditionalWarning', $settings)) {
$typeConditionalWarnings[$type] = $settings['conditionalWarning'];
}
}
$templateMgr->assign([
'activeThemeNavigationAreas' => $activeThemeNavigationAreas,
'unassignedItems' => $unassignedItems,
'navigationMenuId' => $this->_navigationMenuId,
'title' => $this->getData('title'),
'navigationMenuArea' => $this->getData('areaName'),
'menuTree' => $this->getData('menuTree'),
'navigationMenuItemTypes' => $navigationMenuItemTypes,
'navigationMenuItemTypeConditionalWarnings' => json_encode($typeConditionalWarnings),
]);
return parent::fetch($request, $template, $display);
}
/**
* Initialize form data from current NavigationMenu.
*/
public function initData()
{
if (isset($this->_navigationMenuId) && $this->_navigationMenuId != 0) {
$navigationMenusDao = DAORegistry::getDAO('NavigationMenuDAO'); /** @var NavigationMenuDAO $navigationMenusDao */
$navigationMenu = $navigationMenusDao->getById($this->_navigationMenuId);
if ($navigationMenu != null) {
Services::get('navigationMenu')->getMenuTree($navigationMenu);
$this->_data = [
'title' => $navigationMenu->getTitle(),
'navigationMenuId' => $navigationMenu->getId(),
'navigationMenuArea' => $navigationMenu->getAreaName(),
'menuTree' => $navigationMenu->menuTree,
];
} else {
$this->_navigationMenuId = null;
}
}
}
/**
* Assign form data to user-submitted data.
*/
public function readInputData()
{
$this->readUserVars(['title', 'navigationMenuId', 'areaName', 'menuTree']);
}
/**
* Save NavigationMenu .
*/
public function execute(...$functionParams)
{
parent::execute(...$functionParams);
$navigationMenusDao = DAORegistry::getDAO('NavigationMenuDAO'); /** @var NavigationMenuDAO $navigationMenusDao */
$navigationMenuItemAssignmentDao = DAORegistry::getDAO('NavigationMenuItemAssignmentDAO'); /** @var NavigationMenuItemAssignmentDAO $navigationMenuItemAssignmentDao */
if (isset($this->_navigationMenuId)) {
$navigationMenu = $navigationMenusDao->getById($this->_navigationMenuId);
}
if (!isset($navigationMenu)) {
$navigationMenu = $navigationMenusDao->newDataObject();
}
$navigationMenu->setContextId($this->_contextId);
$navigationMenu->setTitle($this->getData('title'));
$navigationMenu->setAreaName($this->getData('areaName'));
// Update or insert NavigationMenu
if ($navigationMenu->getId() != null) {
$navigationMenusDao->updateObject($navigationMenu);
} else {
$this->_navigationMenuId = $navigationMenusDao->insertObject($navigationMenu);
}
// Update NavigationMenuItemAssignment
if ($this->_navigationMenuId) {
$navigationMenuItemAssignmentDao->deleteByMenuId($this->_navigationMenuId);
$menuTree = $this->getData('menuTree');
if (!empty($menuTree)) {
foreach ($menuTree as $menuItemId => $assignmentData) {
$assignment = new NavigationMenuItemAssignment();
$assignment->setMenuId($this->_navigationMenuId);
$assignment->setMenuItemId((int) $menuItemId);
$assignment->setSequence((int) $assignmentData['seq']);
if (isset($assignmentData['parentId'])) {
$assignment->setParentId((int) $assignmentData['parentId']);
}
$navigationMenuItemAssignmentDao->insertObject($assignment);
}
}
}
}
/**
* Perform additional validation checks
*
* @copydoc Form::validate
*/
public function validate($callHooks = true)
{
$navigationMenuDao = DAORegistry::getDAO('NavigationMenuDAO'); /** @var NavigationMenuDAO $navigationMenuDao */
$navigationMenu = $navigationMenuDao->getByTitle($this->_contextId, $this->getData('title'));
if (isset($navigationMenu) && $navigationMenu->getId() != $this->_navigationMenuId) {
$this->addError('path', __('manager.navigationMenus.form.duplicateTitle'));
}
if ($this->getData('areaName') != '') {
$navigationMenusWithArea = $navigationMenuDao->getByArea($this->_contextId, $this->getData('areaName'))->toArray();
if (count($navigationMenusWithArea) == 1 && $navigationMenusWithArea[0]->getId() != $this->_navigationMenuId) {
$this->addError('areaName', __('manager.navigationMenus.form.menuAssigned'));
}
}
return parent::validate($callHooks);
}
}
@@ -0,0 +1,260 @@
<?php
/**
* @file controllers/grid/navigationMenus/form/PKPNavigationMenuItemsForm.php
*
* Copyright (c) 2014-2021 Simon Fraser University
* Copyright (c) 2000-2021 John Willinsky
* Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
*
* @class PKPNavigationMenuItemsForm
*
* @ingroup controllers_grid_navigationMenus
*
* @brief Form for managers to create/edit navigationMenuItems.
*/
namespace PKP\controllers\grid\navigationMenus\form;
use APP\core\Services;
use APP\template\TemplateManager;
use PKP\db\DAORegistry;
use PKP\facades\Locale;
use PKP\form\Form;
use PKP\navigationMenu\NavigationMenuItem;
use PKP\navigationMenu\NavigationMenuItemDAO;
class PKPNavigationMenuItemsForm extends Form
{
/** @var int $navigationMenuItemId the ID of the navigationMenuItem */
public $navigationMenuItemId;
/** @var int */
public $_contextId;
/**
* Constructor
*
* @param int $contextId
* @param int $navigationMenuItemId
*/
public function __construct($contextId, $navigationMenuItemId)
{
$this->_contextId = $contextId;
$this->navigationMenuItemId = $navigationMenuItemId;
parent::__construct('controllers/grid/navigationMenus/form/navigationMenuItemsForm.tpl');
$this->addCheck(new \PKP\form\validation\FormValidatorPost($this));
$this->addCheck(new \PKP\form\validation\FormValidatorCSRF($this));
}
//
// Getters and setters.
//
/**
* Get the current context id.
*
* @return int
*/
public function getContextId()
{
return $this->_contextId;
}
//
// Extended methods from Form.
//
/**
* @copydoc Form::fetch()
*
* @param null|mixed $template
*/
public function fetch($request, $template = null, $display = false)
{
$templateMgr = TemplateManager::getManager($request);
$templateMgr->assign('navigationMenuItemId', $this->navigationMenuItemId);
$context = $request->getContext();
if ($context) {
$templateMgr->assign('allowedVariables', [
'contactName' => __('plugins.generic.tinymce.variables.principalContactName', ['value' => $context->getData('contactName')]),
'contactEmail' => __('plugins.generic.tinymce.variables.principalContactEmail', ['value' => $context->getData('contactEmail')]),
'supportName' => __('plugins.generic.tinymce.variables.supportContactName', ['value' => $context->getData('supportName')]),
'supportPhone' => __('plugins.generic.tinymce.variables.supportContactPhone', ['value' => $context->getData('supportPhone')]),
'supportEmail' => __('plugins.generic.tinymce.variables.supportContactEmail', ['value' => $context->getData('supportEmail')]),
]);
}
$types = Services::get('navigationMenu')->getMenuItemTypes();
$typeTitles = [0 => __('grid.navigationMenus.navigationMenu.selectType')];
foreach ($types as $type => $settings) {
$typeTitles[$type] = $settings['title'];
}
$typeDescriptions = [];
foreach ($types as $type => $settings) {
$typeDescriptions[$type] = $settings['description'];
}
$typeConditionalWarnings = [];
foreach ($types as $type => $settings) {
if (array_key_exists('conditionalWarning', $settings)) {
$typeConditionalWarnings[$type] = $settings['conditionalWarning'];
}
}
$customTemplates = Services::get('navigationMenu')->getMenuItemCustomEditTemplates();
$templateArray = [
'navigationMenuItemTypeTitles' => $typeTitles,
'navigationMenuItemTypeDescriptions' => json_encode($typeDescriptions),
'navigationMenuItemTypeConditionalWarnings' => json_encode($typeConditionalWarnings),
'customTemplates' => $customTemplates,
];
$templateMgr->assign($templateArray);
return parent::fetch($request, $template, $display);
}
/**
* Initialize form data from current navigation menu item.
*/
public function initData()
{
$navigationMenuItemDao = DAORegistry::getDAO('NavigationMenuItemDAO'); /** @var NavigationMenuItemDAO $navigationMenuItemDao */
$navigationMenuItem = $navigationMenuItemDao->getById($this->navigationMenuItemId);
if ($navigationMenuItem) {
Services::get('navigationMenu')
->setAllNMILocalizedTitles($navigationMenuItem);
$formData = [
'path' => $navigationMenuItem->getPath(),
'title' => $navigationMenuItem->getTitle(null),
'url' => $navigationMenuItem->getUrl(),
'menuItemType' => $navigationMenuItem->getType(),
];
$this->_data = $formData;
$this->setData('content', $navigationMenuItem->getContent(null)); // Localized
$this->setData('remoteUrl', $navigationMenuItem->getRemoteUrl(null)); // Localized
}
}
/**
* Assign form data to user-submitted data.
*/
public function readInputData()
{
$this->readUserVars(['navigationMenuItemId', 'path', 'content', 'title', 'remoteUrl', 'menuItemType']);
}
/**
* @copydoc Form::getLocaleFieldNames()
*/
public function getLocaleFieldNames()
{
$navigationMenuItemDao = DAORegistry::getDAO('NavigationMenuItemDAO'); /** @var NavigationMenuItemDAO $navigationMenuItemDao */
return $navigationMenuItemDao->getLocaleFieldNames();
}
/**
* Save NavigationMenuItem.
*/
public function execute(...$functionParams)
{
parent::execute(...$functionParams);
$navigationMenuItemDao = DAORegistry::getDAO('NavigationMenuItemDAO'); /** @var NavigationMenuItemDAO $navigationMenuItemDao */
$navigationMenuItem = $navigationMenuItemDao->getById($this->navigationMenuItemId);
if (!$navigationMenuItem) {
$navigationMenuItem = $navigationMenuItemDao->newDataObject();
$navigationMenuItem->setTitle($this->getData('title'), null);
} else {
$localizedTitlesFromDB = $navigationMenuItem->getTitle(null);
Services::get('navigationMenu')
->setAllNMILocalizedTitles($navigationMenuItem);
$localizedTitles = $navigationMenuItem->getTitle(null);
$inputLocalizedTitles = $this->getData('title');
foreach ($localizedTitles as $locale => $title) {
if ($inputLocalizedTitles[$locale] != $title) {
if (!isset($inputLocalizedTitles[$locale]) || trim($inputLocalizedTitles[$locale]) == '') {
$navigationMenuItem->setTitle(null, $locale);
} else {
$navigationMenuItem->setTitle($inputLocalizedTitles[$locale], $locale);
}
} else {
if (!$localizedTitlesFromDB
|| !array_key_exists($locale, $localizedTitlesFromDB)) {
$navigationMenuItem->setTitle(null, $locale);
}
}
}
}
$navigationMenuItem->setPath($this->getData('path'));
$navigationMenuItem->setContent($this->getData('content'), null); // Localized
$navigationMenuItem->setContextId($this->getContextId());
$navigationMenuItem->setRemoteUrl($this->getData('remoteUrl'), null); // Localized
$navigationMenuItem->setType($this->getData('menuItemType'));
// Update or insert navigation menu item
if ($navigationMenuItem->getId()) {
$navigationMenuItemDao->updateObject($navigationMenuItem);
} else {
$navigationMenuItemDao->insertObject($navigationMenuItem);
}
$this->navigationMenuItemId = $navigationMenuItem->getId();
return $navigationMenuItem->getId();
}
/**
* Perform additional validation checks
*
* @copydoc Form::validate
*/
public function validate($callHooks = true)
{
if ($this->getData('menuItemType') && $this->getData('menuItemType') != '') {
if ($this->getData('menuItemType') == NavigationMenuItem::NMI_TYPE_CUSTOM) {
if (!preg_match('/^[a-zA-Z0-9\/._-]+$/', $this->getData('path'))) {
$this->addError('path', __('manager.navigationMenus.form.pathRegEx'));
}
$navigationMenuItemDao = DAORegistry::getDAO('NavigationMenuItemDAO'); /** @var NavigationMenuItemDAO $navigationMenuItemDao */
$navigationMenuItem = $navigationMenuItemDao->getByPath($this->_contextId, $this->getData('path'));
if (isset($navigationMenuItem) && $navigationMenuItem->getId() != $this->navigationMenuItemId) {
$this->addError('path', __('manager.navigationMenus.form.duplicatePath'));
}
} elseif ($this->getData('menuItemType') == NavigationMenuItem::NMI_TYPE_REMOTE_URL) {
$remoteUrls = $this->getData('remoteUrl');
foreach ($remoteUrls as $locale => $remoteUrl) {
// URLs are optional for languages other than the primary locale.
if ($locale !== Locale::getPrimaryLocale() && $remoteUrl == '') {
continue;
}
if (!filter_var($remoteUrl, FILTER_VALIDATE_URL)) {
$this->addError('remoteUrl', __('manager.navigationMenus.form.customUrlError'));
}
}
}
} else {
$this->addError('path', __('manager.navigationMenus.form.typeMissing'));
}
return parent::validate($callHooks);
}
}