CHIEFSOFT\ameye
356 lines
11 KiB
PHP
356 lines
11 KiB
PHP
<?php
|
|
|
|
/**
|
|
* @file controllers/grid/settings/sections/SectionGridHandler.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 SectionGridHandler
|
|
*
|
|
* @ingroup controllers_grid_settings_section
|
|
*
|
|
* @brief Handle section grid requests.
|
|
*/
|
|
|
|
namespace APP\controllers\grid\settings\sections;
|
|
|
|
use APP\controllers\grid\settings\sections\form\SectionForm;
|
|
use APP\core\Application;
|
|
use APP\core\Request;
|
|
use APP\facades\Repo;
|
|
use APP\notification\NotificationManager;
|
|
use PKP\context\SubEditorsDAO;
|
|
use PKP\controllers\grid\feature\OrderGridItemsFeature;
|
|
use PKP\controllers\grid\GridColumn;
|
|
use PKP\controllers\grid\settings\SetupGridHandler;
|
|
use PKP\core\JSONMessage;
|
|
use PKP\db\DAO;
|
|
use PKP\db\DAORegistry;
|
|
use PKP\linkAction\LinkAction;
|
|
use PKP\linkAction\request\AjaxModal;
|
|
use PKP\notification\PKPNotification;
|
|
use PKP\security\Role;
|
|
|
|
class SectionGridHandler extends SetupGridHandler
|
|
{
|
|
/**
|
|
* Constructor
|
|
*/
|
|
public function __construct()
|
|
{
|
|
parent::__construct();
|
|
$this->addRoleAssignment(
|
|
[Role::ROLE_ID_MANAGER, Role::ROLE_ID_SITE_ADMIN],
|
|
['fetchGrid', 'fetchRow', 'addSection', 'editSection', 'updateSection', 'deleteSection', 'saveSequence', 'deactivateSection','activateSection']
|
|
);
|
|
}
|
|
|
|
|
|
//
|
|
// Overridden template methods
|
|
//
|
|
/**
|
|
* @copydoc SetupGridHandler::initialize()
|
|
*
|
|
* @param null|mixed $args
|
|
*/
|
|
public function initialize($request, $args = null)
|
|
{
|
|
parent::initialize($request, $args);
|
|
$journal = $request->getJournal();
|
|
|
|
// Set the grid title.
|
|
$this->setTitle('section.sections');
|
|
|
|
// Elements to be displayed in the grid
|
|
$subEditorsDao = DAORegistry::getDAO('SubEditorsDAO'); /** @var SubEditorsDAO $subEditorsDao */
|
|
$sections = Repo::section()->getCollector()->filterByContextIds([$journal->getId()])->getMany();
|
|
|
|
$gridData = [];
|
|
foreach ($sections as $section) {
|
|
// Get the section editors data for the row
|
|
$users = $subEditorsDao->getBySubmissionGroupIds([$section->getId()], Application::ASSOC_TYPE_SECTION, $journal->getId());
|
|
if ($users->isEmpty()) {
|
|
$editorsString = __('common.none');
|
|
} else {
|
|
$editorsString = Repo::user()
|
|
->getCollector()
|
|
->filterByUserIds($users->map(fn ($user) => $user->userId)->toArray())
|
|
->getMany()
|
|
->map(fn ($user) => $user->getFullName())
|
|
->join(__('common.commaListSeparator'));
|
|
}
|
|
|
|
$sectionId = $section->getId();
|
|
$gridData[$sectionId] = [
|
|
'title' => $section->getLocalizedTitle(),
|
|
'editors' => $editorsString,
|
|
'inactive' => $section->getIsInactive(),
|
|
'seq' => $section->getSequence()
|
|
];
|
|
}
|
|
uasort($gridData, function ($a, $b) {
|
|
return $a['seq'] - $b['seq'];
|
|
});
|
|
|
|
$this->setGridDataElements($gridData);
|
|
|
|
// Add grid-level actions
|
|
$router = $request->getRouter();
|
|
$this->addAction(
|
|
new LinkAction(
|
|
'addSection',
|
|
new AjaxModal(
|
|
$router->url($request, null, null, 'addSection', null, ['gridId' => $this->getId()]),
|
|
__('manager.sections.create'),
|
|
'modal_manage'
|
|
),
|
|
__('manager.sections.create'),
|
|
'add_section'
|
|
)
|
|
);
|
|
|
|
//
|
|
// Grid columns.
|
|
//
|
|
$sectionGridCellProvider = new SectionGridCellProvider();
|
|
|
|
// Section name
|
|
$this->addColumn(
|
|
new GridColumn(
|
|
'title',
|
|
'common.title'
|
|
)
|
|
);
|
|
// Section 'editors'
|
|
$this->addColumn(new GridColumn('editors', 'user.role.editors'));
|
|
//Section 'inactive'
|
|
$this->addColumn(
|
|
new GridColumn(
|
|
'inactive',
|
|
'common.inactive',
|
|
null,
|
|
'controllers/grid/common/cell/selectStatusCell.tpl',
|
|
$sectionGridCellProvider,
|
|
['alignment' => GridColumn::COLUMN_ALIGNMENT_CENTER,
|
|
'width' => 20]
|
|
)
|
|
);
|
|
}
|
|
|
|
//
|
|
// Overridden methods from GridHandler
|
|
//
|
|
/**
|
|
* @copydoc GridHandler::initFeatures()
|
|
*/
|
|
public function initFeatures($request, $args)
|
|
{
|
|
return [new OrderGridItemsFeature()];
|
|
}
|
|
|
|
/**
|
|
* Get the row handler - override the default row handler
|
|
*
|
|
* @return SectionGridRow
|
|
*/
|
|
protected function getRowInstance()
|
|
{
|
|
return new SectionGridRow();
|
|
}
|
|
|
|
/**
|
|
* @copydoc GridHandler::getDataElementSequence()
|
|
*/
|
|
public function getDataElementSequence($row)
|
|
{
|
|
return $row['seq'];
|
|
}
|
|
|
|
/**
|
|
* @copydoc GridHandler::setDataElementSequence()
|
|
*/
|
|
public function setDataElementSequence($request, $rowId, $gridDataElement, $newSequence)
|
|
{
|
|
$journal = $request->getJournal();
|
|
$section = Repo::section()->get($rowId, $journal->getId());
|
|
$section->setSequence($newSequence);
|
|
Repo::section()->edit($section, []);
|
|
}
|
|
|
|
//
|
|
// Public Section Grid Actions
|
|
//
|
|
/**
|
|
* An action to add a new section
|
|
*
|
|
* @param array $args
|
|
* @param Request $request
|
|
*/
|
|
public function addSection($args, $request)
|
|
{
|
|
// Calling editSection with an empty ID will add
|
|
// a new section.
|
|
return $this->editSection($args, $request);
|
|
}
|
|
|
|
/**
|
|
* An action to edit a section
|
|
*
|
|
* @param array $args
|
|
* @param Request $request
|
|
*
|
|
* @return string Serialized JSON object
|
|
* @return JSONMessage JSON object
|
|
*/
|
|
public function editSection($args, $request)
|
|
{
|
|
$sectionId = $args['sectionId'] ?? null;
|
|
$this->setupTemplate($request);
|
|
|
|
$sectionForm = new SectionForm($request, $sectionId);
|
|
$sectionForm->initData();
|
|
return new JSONMessage(true, $sectionForm->fetch($request));
|
|
}
|
|
|
|
/**
|
|
* Update a section
|
|
*
|
|
* @param array $args
|
|
* @param Request $request
|
|
*
|
|
* @return JSONMessage JSON object
|
|
*/
|
|
public function updateSection($args, $request)
|
|
{
|
|
$sectionId = $request->getUserVar('sectionId');
|
|
|
|
$sectionForm = new SectionForm($request, $sectionId);
|
|
$sectionForm->readInputData();
|
|
|
|
if ($sectionForm->validate()) {
|
|
$sectionForm->execute();
|
|
$notificationManager = new NotificationManager();
|
|
$notificationManager->createTrivialNotification($request->getUser()->getId());
|
|
return DAO::getDataChangedEvent($sectionForm->getSectionId());
|
|
}
|
|
return new JSONMessage(false);
|
|
}
|
|
|
|
/**
|
|
* Delete a section
|
|
*
|
|
* @param array $args
|
|
* @param Request $request
|
|
*
|
|
* @return JSONMessage JSON object
|
|
*/
|
|
public function deleteSection($args, $request)
|
|
{
|
|
if (!$request->checkCSRF()) {
|
|
return new JSONMessage(false, __('form.csrfInvalid'));
|
|
}
|
|
|
|
$journal = $request->getJournal();
|
|
|
|
$section = Repo::section()->get($request->getUserVar('sectionId'), $journal->getId());
|
|
if (!$section) {
|
|
return new JSONMessage(false, __('manager.setup.errorDeletingItem'));
|
|
}
|
|
|
|
// Validate if it can be deleted
|
|
$sectionEmpty = Repo::section()->isEmpty($section->getId(), $journal->getId());
|
|
if (!$sectionEmpty) {
|
|
return new JSONMessage(false, __('manager.sections.alertDelete'));
|
|
}
|
|
|
|
$activeSectionsCount = Repo::section()->getCollector()->filterByContextIds([$journal->getId()])->excludeInactive()->getCount();
|
|
$activeSectionsCount = (!$section->getIsInactive()) ? $activeSectionsCount - 1 : $activeSectionsCount;
|
|
if ($activeSectionsCount < 1) {
|
|
return new JSONMessage(false, __('manager.sections.confirmDeactivateSection.error'));
|
|
}
|
|
|
|
Repo::section()->delete($section);
|
|
return DAO::getDataChangedEvent($section->getId());
|
|
}
|
|
|
|
/**
|
|
* Deactivate a section.
|
|
*
|
|
* @param array $args
|
|
* @param Request $request
|
|
*
|
|
* @return JSONMessage JSON object
|
|
*/
|
|
public function deactivateSection($args, $request)
|
|
{
|
|
// Identify the current section
|
|
$sectionId = (int) $request->getUserVar('sectionKey');
|
|
|
|
// Identify the context id.
|
|
$context = $request->getContext();
|
|
|
|
// Validate if it can be inactive
|
|
$activeSectionsCount = Repo::section()->getCollector()->filterByContextIds([$context->getId()])->excludeInactive()->getCount();
|
|
if ($activeSectionsCount > 1) {
|
|
$section = Repo::section()->get($sectionId, $context->getId());
|
|
|
|
if ($request->checkCSRF() && isset($section) && !$section->getIsInactive()) {
|
|
$section->setIsInactive(1);
|
|
Repo::section()->edit($section, []);
|
|
|
|
// Create the notification.
|
|
$notificationMgr = new NotificationManager();
|
|
$user = $request->getUser();
|
|
$notificationMgr->createTrivialNotification($user->getId());
|
|
|
|
return DAO::getDataChangedEvent($sectionId);
|
|
}
|
|
} else {
|
|
// Create the notification.
|
|
$notificationMgr = new NotificationManager();
|
|
$user = $request->getUser();
|
|
$notificationMgr->createTrivialNotification($user->getId(), PKPNotification::NOTIFICATION_TYPE_ERROR, ['contents' => __('manager.sections.confirmDeactivateSection.error')]);
|
|
return DAO::getDataChangedEvent($sectionId);
|
|
}
|
|
|
|
return new JSONMessage(false);
|
|
}
|
|
|
|
/**
|
|
* Activate a section.
|
|
*
|
|
* @param array $args
|
|
* @param Request $request
|
|
*
|
|
* @return JSONMessage JSON object
|
|
*/
|
|
public function activateSection($args, $request)
|
|
{
|
|
// Identify the current section
|
|
$sectionId = (int) $request->getUserVar('sectionKey');
|
|
|
|
// Identify the context id.
|
|
$context = $request->getContext();
|
|
|
|
// Get section object
|
|
$section = Repo::section()->get($sectionId, $context->getId());
|
|
|
|
if ($request->checkCSRF() && isset($section) && $section->getIsInactive()) {
|
|
$section->setIsInactive(0);
|
|
Repo::section()->edit($section, []);
|
|
|
|
// Create the notification.
|
|
$notificationMgr = new NotificationManager();
|
|
$user = $request->getUser();
|
|
$notificationMgr->createTrivialNotification($user->getId());
|
|
|
|
return DAO::getDataChangedEvent($sectionId);
|
|
}
|
|
|
|
return new JSONMessage(false);
|
|
}
|
|
}
|