first commit
This commit is contained in:
@@ -0,0 +1,46 @@
|
||||
<?php
|
||||
/**
|
||||
* @file controllers/grid/settings/reviewForms/ReviewFormElementGridCellProvider.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 ReviewFormElementGridCellProvider
|
||||
*
|
||||
* @ingroup controllers_grid_settings_reviewForms
|
||||
*
|
||||
* @brief Subclass for review form element column's cell provider
|
||||
*/
|
||||
|
||||
namespace PKP\controllers\grid\settings\reviewForms;
|
||||
|
||||
use PKP\controllers\grid\GridCellProvider;
|
||||
use PKP\controllers\grid\GridColumn;
|
||||
|
||||
class ReviewFormElementGridCellProvider extends GridCellProvider
|
||||
{
|
||||
/**
|
||||
* 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)
|
||||
{
|
||||
$element = $row->getData();
|
||||
$columnId = $column->getId();
|
||||
assert($element instanceof \PKP\reviewForm\ReviewFormElement && !empty($columnId));
|
||||
switch ($columnId) {
|
||||
case 'question':
|
||||
$label = $element->getLocalizedQuestion();
|
||||
return ['label' => $label];
|
||||
default:
|
||||
assert(false);
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,75 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @file controllers/grid/settings/reviewForms/ReviewFormElementGridRow.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 ReviewFormElementGridRow
|
||||
*
|
||||
* @ingroup controllers_grid_settings_reviewForms
|
||||
*
|
||||
* @brief ReviewFormElements grid row definition
|
||||
*/
|
||||
|
||||
namespace PKP\controllers\grid\settings\reviewForms;
|
||||
|
||||
use PKP\controllers\grid\GridRow;
|
||||
use PKP\linkAction\LinkAction;
|
||||
use PKP\linkAction\request\AjaxModal;
|
||||
use PKP\linkAction\request\RemoteActionConfirmationModal;
|
||||
|
||||
class ReviewFormElementGridRow extends GridRow
|
||||
{
|
||||
//
|
||||
// Overridden methods from GridRow
|
||||
//
|
||||
/**
|
||||
* @copydoc GridRow::initialize()
|
||||
*
|
||||
* @param null|mixed $template
|
||||
*/
|
||||
public function initialize($request, $template = null)
|
||||
{
|
||||
parent::initialize($request, $template);
|
||||
// add grid row actions: edit, delete
|
||||
|
||||
$element = parent::getData();
|
||||
assert($element instanceof \PKP\reviewForm\ReviewFormElement);
|
||||
$rowId = $this->getId();
|
||||
|
||||
$router = $request->getRouter();
|
||||
if (!empty($rowId) && is_numeric($rowId)) {
|
||||
// add 'edit' grid row action
|
||||
$this->addAction(
|
||||
new LinkAction(
|
||||
'edit',
|
||||
new AjaxModal(
|
||||
$router->url($request, null, null, 'editReviewFormElement', null, ['rowId' => $rowId, 'reviewFormId' => $element->getReviewFormId()]),
|
||||
__('grid.action.edit'),
|
||||
'modal_edit',
|
||||
true
|
||||
),
|
||||
__('grid.action.edit'),
|
||||
'edit'
|
||||
)
|
||||
);
|
||||
// add 'delete' grid row action
|
||||
$this->addAction(
|
||||
new LinkAction(
|
||||
'delete',
|
||||
new RemoteActionConfirmationModal(
|
||||
$request->getSession(),
|
||||
__('manager.reviewFormElements.confirmDelete'),
|
||||
null,
|
||||
$router->url($request, null, null, 'deleteReviewFormElement', null, ['rowId' => $rowId, 'reviewFormId' => $element->getReviewFormId()])
|
||||
),
|
||||
__('grid.action.delete'),
|
||||
'delete'
|
||||
)
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,291 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @file controllers/grid/settings/reviewForms/ReviewFormElementsGridHandler.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 ReviewFormElementsGridHandler
|
||||
*
|
||||
* @ingroup controllers_grid_settings_reviewForms
|
||||
*
|
||||
* @brief Handle review form element grid requests.
|
||||
*/
|
||||
|
||||
namespace PKP\controllers\grid\settings\reviewForms;
|
||||
|
||||
use APP\core\Application;
|
||||
use APP\notification\NotificationManager;
|
||||
use PKP\controllers\grid\feature\OrderGridItemsFeature;
|
||||
use PKP\controllers\grid\GridColumn;
|
||||
use PKP\controllers\grid\GridHandler;
|
||||
use PKP\controllers\grid\settings\reviewForms\form\ReviewFormElementForm;
|
||||
use PKP\core\JSONMessage;
|
||||
use PKP\core\PKPRequest;
|
||||
use PKP\db\DAORegistry;
|
||||
use PKP\linkAction\LinkAction;
|
||||
use PKP\linkAction\request\AjaxModal;
|
||||
use PKP\reviewForm\ReviewFormDAO;
|
||||
use PKP\reviewForm\ReviewFormElementDAO;
|
||||
use PKP\security\authorization\PolicySet;
|
||||
use PKP\security\authorization\RoleBasedHandlerOperationPolicy;
|
||||
use PKP\security\Role;
|
||||
|
||||
class ReviewFormElementsGridHandler extends GridHandler
|
||||
{
|
||||
/** @var int Review form ID */
|
||||
public $reviewFormId;
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*/
|
||||
public function __construct()
|
||||
{
|
||||
parent::__construct();
|
||||
$this->addRoleAssignment(
|
||||
[Role::ROLE_ID_MANAGER, Role::ROLE_ID_SITE_ADMIN],
|
||||
['fetchGrid', 'fetchRow', 'saveSequence',
|
||||
'createReviewFormElement', 'editReviewFormElement', 'deleteReviewFormElement', 'updateReviewFormElement']
|
||||
);
|
||||
}
|
||||
|
||||
//
|
||||
// Implement template methods from PKPHandler.
|
||||
//
|
||||
/**
|
||||
* @see PKPHandler::authorize()
|
||||
*/
|
||||
public function authorize($request, &$args, $roleAssignments)
|
||||
{
|
||||
$rolePolicy = new PolicySet(PolicySet::COMBINING_PERMIT_OVERRIDES);
|
||||
|
||||
foreach ($roleAssignments as $role => $operations) {
|
||||
$rolePolicy->addPolicy(new RoleBasedHandlerOperationPolicy($request, $role, $operations));
|
||||
}
|
||||
$this->addPolicy($rolePolicy);
|
||||
|
||||
$this->reviewFormId = (int) $request->getUserVar('reviewFormId');
|
||||
$reviewFormDao = DAORegistry::getDAO('ReviewFormDAO'); /** @var ReviewFormDAO $reviewFormDao */
|
||||
if (!$reviewFormDao->reviewFormExists($this->reviewFormId, Application::getContextAssocType(), $request->getContext()->getId())) {
|
||||
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);
|
||||
|
||||
// Grid actions.
|
||||
$router = $request->getRouter();
|
||||
|
||||
|
||||
// Create Review Form Element link
|
||||
$this->addAction(
|
||||
new LinkAction(
|
||||
'createReviewFormElement',
|
||||
new AjaxModal(
|
||||
$router->url($request, null, null, 'createReviewFormElement', null, ['reviewFormId' => $this->reviewFormId]),
|
||||
__('manager.reviewFormElements.create'),
|
||||
'modal_add_item',
|
||||
true
|
||||
),
|
||||
__('manager.reviewFormElements.create'),
|
||||
'add_item'
|
||||
)
|
||||
);
|
||||
|
||||
|
||||
//
|
||||
// Grid columns.
|
||||
//
|
||||
$reviewFormElementGridCellProvider = new ReviewFormElementGridCellProvider();
|
||||
|
||||
// Review form element name.
|
||||
$this->addColumn(
|
||||
new GridColumn(
|
||||
'question',
|
||||
'manager.reviewFormElements.question',
|
||||
null,
|
||||
null,
|
||||
$reviewFormElementGridCellProvider,
|
||||
['html' => true, 'maxLength' => 220]
|
||||
)
|
||||
);
|
||||
|
||||
// Basic grid configuration.
|
||||
$this->setTitle('manager.reviewFormElements');
|
||||
}
|
||||
|
||||
//
|
||||
// Implement methods from GridHandler.
|
||||
//
|
||||
/**
|
||||
* @see GridHandler::addFeatures()
|
||||
*/
|
||||
public function initFeatures($request, $args)
|
||||
{
|
||||
return [new OrderGridItemsFeature()];
|
||||
}
|
||||
|
||||
/**
|
||||
* @see GridHandler::getRowInstance()
|
||||
*
|
||||
* @return ReviewFormElementGridRow
|
||||
*/
|
||||
protected function getRowInstance()
|
||||
{
|
||||
return new ReviewFormElementGridRow();
|
||||
}
|
||||
|
||||
/**
|
||||
* @copydoc GridHandler::loadData()
|
||||
*
|
||||
* @param null|mixed $filter
|
||||
*/
|
||||
protected function loadData($request, $filter = null)
|
||||
{
|
||||
// Get review form elements.
|
||||
//$rangeInfo = $this->getRangeInfo('reviewFormElements');
|
||||
$reviewFormElementDao = DAORegistry::getDAO('ReviewFormElementDAO'); /** @var ReviewFormElementDAO $reviewFormElementDao */
|
||||
$reviewFormElements = $reviewFormElementDao->getByReviewFormId($this->reviewFormId, null); //FIXME add range info?
|
||||
|
||||
return $reviewFormElements->toAssociativeArray();
|
||||
}
|
||||
|
||||
/**
|
||||
* @copydoc CategoryGridHandler::getRequestArgs()
|
||||
*/
|
||||
public function getRequestArgs()
|
||||
{
|
||||
return array_merge(['reviewFormId' => $this->reviewFormId], parent::getRequestArgs());
|
||||
}
|
||||
|
||||
/**
|
||||
* @copydoc GridHandler::getDataElementSequence()
|
||||
*/
|
||||
public function getDataElementSequence($gridDataElement)
|
||||
{
|
||||
return $gridDataElement->getSequence();
|
||||
}
|
||||
|
||||
/**
|
||||
* @copydoc GridHandler::setDataElementSequence()
|
||||
*/
|
||||
public function setDataElementSequence($request, $rowId, $gridDataElement, $newSequence)
|
||||
{
|
||||
$reviewFormElementDao = DAORegistry::getDAO('ReviewFormElementDAO'); /** @var ReviewFormElementDAO $reviewFormElementDao */
|
||||
$gridDataElement->setSequence($newSequence);
|
||||
$reviewFormElementDao->updateObject($gridDataElement);
|
||||
}
|
||||
|
||||
|
||||
//
|
||||
// Public grid actions.
|
||||
//
|
||||
/**
|
||||
* Add a new review form element.
|
||||
*
|
||||
* @param array $args
|
||||
* @param PKPRequest $request
|
||||
*
|
||||
* @return JSONMessage JSON object
|
||||
*/
|
||||
public function createReviewFormElement($args, $request)
|
||||
{
|
||||
// Form handling
|
||||
$reviewFormElementForm = new ReviewFormElementForm($this->reviewFormId);
|
||||
$reviewFormElementForm->initData();
|
||||
return new JSONMessage(true, $reviewFormElementForm->fetch($request));
|
||||
}
|
||||
|
||||
/**
|
||||
* Edit an existing review form element.
|
||||
*
|
||||
* @param array $args
|
||||
* @param PKPRequest $request
|
||||
*
|
||||
* @return JSONMessage JSON object
|
||||
*/
|
||||
public function editReviewFormElement($args, $request)
|
||||
{
|
||||
// Identify the review form element Id
|
||||
$reviewFormElementId = (int) $request->getUserVar('rowId');
|
||||
|
||||
// Display form
|
||||
$reviewFormElementForm = new ReviewFormElementForm($this->reviewFormId, $reviewFormElementId);
|
||||
$reviewFormElementForm->initData();
|
||||
return new JSONMessage(true, $reviewFormElementForm->fetch($request));
|
||||
}
|
||||
|
||||
/**
|
||||
* Save changes to a review form element.
|
||||
*
|
||||
* @param array $args
|
||||
* @param PKPRequest $request
|
||||
*
|
||||
* @return JSONMessage JSON object
|
||||
*/
|
||||
public function updateReviewFormElement($args, $request)
|
||||
{
|
||||
$reviewFormElementId = (int) $request->getUserVar('reviewFormElementId');
|
||||
|
||||
$context = $request->getContext();
|
||||
$reviewFormDao = DAORegistry::getDAO('ReviewFormDAO'); /** @var ReviewFormDAO $reviewFormDao */
|
||||
$reviewFormElementDao = DAORegistry::getDAO('ReviewFormElementDAO'); /** @var ReviewFormElementDAO $reviewFormElementDao */
|
||||
|
||||
$reviewForm = $reviewFormDao->getById($this->reviewFormId, Application::getContextAssocType(), $context->getId());
|
||||
|
||||
if (!$reviewFormDao->unusedReviewFormExists($this->reviewFormId, Application::getContextAssocType(), $context->getId()) || ($reviewFormElementId && !$reviewFormElementDao->reviewFormElementExists($reviewFormElementId, $this->reviewFormId))) {
|
||||
fatalError('Invalid review form information!');
|
||||
}
|
||||
|
||||
$reviewFormElementForm = new ReviewFormElementForm($this->reviewFormId, $reviewFormElementId);
|
||||
$reviewFormElementForm->readInputData();
|
||||
|
||||
if ($reviewFormElementForm->validate()) {
|
||||
$reviewFormElementId = $reviewFormElementForm->execute();
|
||||
|
||||
// Create the notification.
|
||||
$notificationMgr = new NotificationManager();
|
||||
$user = $request->getUser();
|
||||
$notificationMgr->createTrivialNotification($user->getId());
|
||||
|
||||
return \PKP\db\DAO::getDataChangedEvent($reviewFormElementId);
|
||||
}
|
||||
|
||||
return new JSONMessage(false);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete a review form element.
|
||||
*
|
||||
* @param array $args
|
||||
* @param PKPRequest $request
|
||||
*
|
||||
* @return JSONMessage JSON object
|
||||
*/
|
||||
public function deleteReviewFormElement($args, $request)
|
||||
{
|
||||
$reviewFormElementId = (int) $request->getUserVar('rowId');
|
||||
|
||||
$context = $request->getContext();
|
||||
$reviewFormDao = DAORegistry::getDAO('ReviewFormDAO'); /** @var ReviewFormDAO $reviewFormDao */
|
||||
|
||||
if ($request->checkCSRF() && $reviewFormDao->unusedReviewFormExists($this->reviewFormId, Application::getContextAssocType(), $context->getId())) {
|
||||
$reviewFormElementDao = DAORegistry::getDAO('ReviewFormElementDAO'); /** @var ReviewFormElementDAO $reviewFormElementDao */
|
||||
$reviewFormElementDao->deleteById($reviewFormElementId);
|
||||
return \PKP\db\DAO::getDataChangedEvent($reviewFormElementId);
|
||||
}
|
||||
|
||||
return new JSONMessage(false);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,104 @@
|
||||
<?php
|
||||
/**
|
||||
* @file controllers/grid/settings/reviewForms/ReviewFormGridCellProvider.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 ReviewFormGridCellProvider
|
||||
*
|
||||
* @ingroup controllers_grid_settings_reviewForms
|
||||
*
|
||||
* @brief Subclass for review form column's cell provider
|
||||
*/
|
||||
|
||||
namespace PKP\controllers\grid\settings\reviewForms;
|
||||
|
||||
use PKP\controllers\grid\GridCellProvider;
|
||||
use PKP\controllers\grid\GridColumn;
|
||||
use PKP\controllers\grid\GridHandler;
|
||||
use PKP\linkAction\LinkAction;
|
||||
use PKP\linkAction\request\RemoteActionConfirmationModal;
|
||||
use PKP\reviewForm\ReviewForm;
|
||||
|
||||
class ReviewFormGridCellProvider extends GridCellProvider
|
||||
{
|
||||
/**
|
||||
* 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)
|
||||
{
|
||||
$element = $row->getData();
|
||||
$columnId = $column->getId();
|
||||
assert($element instanceof ReviewForm && !empty($columnId));
|
||||
switch ($columnId) {
|
||||
case 'name':
|
||||
return ['label' => $element->getLocalizedTitle()];
|
||||
case 'inReview':
|
||||
return ['label' => $element->getIncompleteCount()];
|
||||
case 'completed':
|
||||
return ['label' => $element->getCompleteCount()];
|
||||
case 'active':
|
||||
return ['selected' => $element->getActive()];
|
||||
}
|
||||
return parent::getTemplateVarsFromRowColumn($row, $column);
|
||||
}
|
||||
|
||||
/**
|
||||
* @see GridCellProvider::getCellActions()
|
||||
*/
|
||||
public function getCellActions($request, $row, $column, $position = GridHandler::GRID_ACTION_POSITION_DEFAULT)
|
||||
{
|
||||
switch ($column->getId()) {
|
||||
case 'active':
|
||||
/** @var ReviewForm */
|
||||
$element = $row->getData();
|
||||
|
||||
$router = $request->getRouter();
|
||||
|
||||
if ($element->getActive()) {
|
||||
return [new LinkAction(
|
||||
'deactivateReviewForm',
|
||||
new RemoteActionConfirmationModal(
|
||||
$request->getSession(),
|
||||
__('manager.reviewForms.confirmDeactivate'),
|
||||
null,
|
||||
$router->url(
|
||||
$request,
|
||||
null,
|
||||
'grid.settings.reviewForms.ReviewFormGridHandler',
|
||||
'deactivateReviewForm',
|
||||
null,
|
||||
['reviewFormKey' => $element->getId()]
|
||||
)
|
||||
)
|
||||
)];
|
||||
} else {
|
||||
return [new LinkAction(
|
||||
'activateReviewForm',
|
||||
new RemoteActionConfirmationModal(
|
||||
$request->getSession(),
|
||||
__('manager.reviewForms.confirmActivate'),
|
||||
null,
|
||||
$router->url(
|
||||
$request,
|
||||
null,
|
||||
'grid.settings.reviewForms.ReviewFormGridHandler',
|
||||
'activateReviewForm',
|
||||
null,
|
||||
['reviewFormKey' => $element->getId()]
|
||||
)
|
||||
)
|
||||
)];
|
||||
}
|
||||
}
|
||||
return parent::getCellActions($request, $row, $column, $position);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,525 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @file controllers/grid/settings/reviewForms/ReviewFormGridHandler.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 ReviewFormGridHandler
|
||||
*
|
||||
* @ingroup controllers_grid_settings_reviewForms
|
||||
*
|
||||
* @brief Handle review form grid requests.
|
||||
*/
|
||||
|
||||
namespace PKP\controllers\grid\settings\reviewForms;
|
||||
|
||||
use APP\core\Application;
|
||||
use APP\notification\NotificationManager;
|
||||
use APP\template\TemplateManager;
|
||||
use PKP\controllers\grid\feature\OrderGridItemsFeature;
|
||||
use PKP\controllers\grid\GridColumn;
|
||||
use PKP\controllers\grid\GridHandler;
|
||||
use PKP\controllers\grid\settings\reviewForms\form\PreviewReviewForm;
|
||||
use PKP\controllers\grid\settings\reviewForms\form\ReviewFormForm;
|
||||
use PKP\core\JSONMessage;
|
||||
use PKP\core\PKPApplication;
|
||||
use PKP\core\PKPRequest;
|
||||
use PKP\db\DAORegistry;
|
||||
use PKP\linkAction\LinkAction;
|
||||
use PKP\linkAction\request\AjaxModal;
|
||||
use PKP\reviewForm\ReviewFormDAO;
|
||||
use PKP\reviewForm\ReviewFormElementDAO;
|
||||
use PKP\security\authorization\PolicySet;
|
||||
use PKP\security\authorization\RoleBasedHandlerOperationPolicy;
|
||||
use PKP\security\Role;
|
||||
use PKP\submission\reviewAssignment\ReviewAssignmentDAO;
|
||||
|
||||
class ReviewFormGridHandler extends GridHandler
|
||||
{
|
||||
/**
|
||||
* Constructor
|
||||
*/
|
||||
public function __construct()
|
||||
{
|
||||
parent::__construct();
|
||||
$this->addRoleAssignment(
|
||||
[Role::ROLE_ID_MANAGER, Role::ROLE_ID_SITE_ADMIN],
|
||||
['fetchGrid', 'fetchRow', 'createReviewForm', 'editReviewForm', 'updateReviewForm',
|
||||
'reviewFormBasics', 'reviewFormElements', 'copyReviewForm',
|
||||
'reviewFormPreview', 'activateReviewForm', 'deactivateReviewForm', 'deleteReviewForm',
|
||||
'saveSequence']
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
//
|
||||
// Implement template methods from PKPHandler.
|
||||
//
|
||||
/**
|
||||
* @copydoc GridHandler::initialize()
|
||||
*
|
||||
* @param null|mixed $args
|
||||
*/
|
||||
public function initialize($request, $args = null)
|
||||
{
|
||||
parent::initialize($request, $args);
|
||||
|
||||
// Basic grid configuration.
|
||||
$this->setTitle('manager.reviewForms');
|
||||
|
||||
// Grid actions.
|
||||
$router = $request->getRouter();
|
||||
|
||||
$this->addAction(
|
||||
new LinkAction(
|
||||
'createReviewForm',
|
||||
new AjaxModal(
|
||||
$router->url($request, null, null, 'createReviewForm', null, null),
|
||||
__('manager.reviewForms.create'),
|
||||
'modal_add_item',
|
||||
true
|
||||
),
|
||||
__('manager.reviewForms.create'),
|
||||
'add_item'
|
||||
)
|
||||
);
|
||||
|
||||
//
|
||||
// Grid columns.
|
||||
//
|
||||
$reviewFormGridCellProvider = new ReviewFormGridCellProvider();
|
||||
|
||||
// Review form name.
|
||||
$this->addColumn(
|
||||
new GridColumn(
|
||||
'name',
|
||||
'manager.reviewForms.title',
|
||||
null,
|
||||
null,
|
||||
$reviewFormGridCellProvider
|
||||
)
|
||||
);
|
||||
|
||||
// Review Form 'in review'
|
||||
$this->addColumn(
|
||||
new GridColumn(
|
||||
'inReview',
|
||||
'manager.reviewForms.inReview',
|
||||
null,
|
||||
null,
|
||||
$reviewFormGridCellProvider
|
||||
)
|
||||
);
|
||||
|
||||
// Review Form 'completed'.
|
||||
$this->addColumn(
|
||||
new GridColumn(
|
||||
'completed',
|
||||
'manager.reviewForms.completed',
|
||||
null,
|
||||
null,
|
||||
$reviewFormGridCellProvider
|
||||
)
|
||||
);
|
||||
|
||||
// Review form 'activate/deactivate'
|
||||
// if ($element->getActive()) {
|
||||
$this->addColumn(
|
||||
new GridColumn(
|
||||
'active',
|
||||
'common.active',
|
||||
null,
|
||||
'controllers/grid/common/cell/selectStatusCell.tpl',
|
||||
$reviewFormGridCellProvider
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* @see PKPHandler::authorize()
|
||||
*/
|
||||
public function authorize($request, &$args, $roleAssignments)
|
||||
{
|
||||
$rolePolicy = new PolicySet(PolicySet::COMBINING_PERMIT_OVERRIDES);
|
||||
|
||||
foreach ($roleAssignments as $role => $operations) {
|
||||
$rolePolicy->addPolicy(new RoleBasedHandlerOperationPolicy($request, $role, $operations));
|
||||
}
|
||||
$this->addPolicy($rolePolicy);
|
||||
|
||||
return parent::authorize($request, $args, $roleAssignments);
|
||||
}
|
||||
|
||||
//
|
||||
// Implement methods from GridHandler.
|
||||
//
|
||||
/**
|
||||
* @see GridHandler::getRowInstance()
|
||||
*
|
||||
* @return ReviewFormGridRow
|
||||
*/
|
||||
protected function getRowInstance()
|
||||
{
|
||||
return new ReviewFormGridRow();
|
||||
}
|
||||
|
||||
/**
|
||||
* @copydoc GridHandler::loadData()
|
||||
*
|
||||
* @param null|mixed $filter
|
||||
*/
|
||||
protected function loadData($request, $filter = null)
|
||||
{
|
||||
// Get all review forms.
|
||||
$reviewFormDao = DAORegistry::getDAO('ReviewFormDAO'); /** @var ReviewFormDAO $reviewFormDao */
|
||||
$context = $request->getContext();
|
||||
$reviewForms = $reviewFormDao->getByAssocId(Application::getContextAssocType(), $context->getId());
|
||||
|
||||
return $reviewForms->toAssociativeArray();
|
||||
}
|
||||
|
||||
/**
|
||||
* @copydoc GridHandler::setDataElementSequence()
|
||||
*/
|
||||
public function setDataElementSequence($request, $rowId, $gridDataElement, $newSequence)
|
||||
{
|
||||
$reviewFormDao = DAORegistry::getDAO('ReviewFormDAO'); /** @var ReviewFormDAO $reviewFormDao */
|
||||
$gridDataElement->setSequence($newSequence);
|
||||
$reviewFormDao->updateObject($gridDataElement);
|
||||
}
|
||||
|
||||
/**
|
||||
* @see lib/pkp/classes/controllers/grid/GridHandler::getDataElementSequence()
|
||||
*/
|
||||
public function getDataElementSequence($reviewForm)
|
||||
{
|
||||
return $reviewForm->getSequence();
|
||||
}
|
||||
|
||||
/**
|
||||
* @see GridHandler::addFeatures()
|
||||
*/
|
||||
public function initFeatures($request, $args)
|
||||
{
|
||||
return [new OrderGridItemsFeature()];
|
||||
}
|
||||
|
||||
|
||||
//
|
||||
// Public grid actions.
|
||||
//
|
||||
/**
|
||||
* Preview a review form.
|
||||
*
|
||||
* @param array $args
|
||||
* @param PKPRequest $request
|
||||
*
|
||||
* @return JSONMessage JSON object
|
||||
*/
|
||||
public function reviewFormPreview($args, $request)
|
||||
{
|
||||
// Identify the review form ID.
|
||||
$reviewFormId = (int) $request->getUserVar('reviewFormId');
|
||||
|
||||
// Identify the context id.
|
||||
$context = $request->getContext();
|
||||
|
||||
// Get review form object
|
||||
$reviewFormDao = DAORegistry::getDAO('ReviewFormDAO'); /** @var ReviewFormDAO $reviewFormDao */
|
||||
$reviewForm = $reviewFormDao->getById($reviewFormId, Application::getContextAssocType(), $context->getId());
|
||||
|
||||
$previewReviewForm = new PreviewReviewForm($reviewFormId);
|
||||
$previewReviewForm->initData();
|
||||
return new JSONMessage(true, $previewReviewForm->fetch($request));
|
||||
}
|
||||
|
||||
/**
|
||||
* Add a new review form.
|
||||
*
|
||||
* @param array $args
|
||||
* @param PKPRequest $request
|
||||
*
|
||||
* @return JSONMessage JSON object
|
||||
*/
|
||||
public function createReviewForm($args, $request)
|
||||
{
|
||||
// Form handling.
|
||||
$reviewFormForm = new ReviewFormForm(null);
|
||||
$reviewFormForm->initData();
|
||||
return new JSONMessage(true, $reviewFormForm->fetch($request));
|
||||
}
|
||||
|
||||
/**
|
||||
* Edit an existing review form.
|
||||
*
|
||||
* @param array $args
|
||||
* @param PKPRequest $request
|
||||
*
|
||||
* @return JSONMessage JSON object
|
||||
*/
|
||||
public function editReviewForm($args, $request)
|
||||
{
|
||||
$reviewFormDao = DAORegistry::getDAO('ReviewFormDAO'); /** @var ReviewFormDAO $reviewFormDao */
|
||||
$context = $request->getContext();
|
||||
$reviewForm = $reviewFormDao->getById(
|
||||
$request->getUserVar('rowId'),
|
||||
Application::getContextAssocType(),
|
||||
$context->getId()
|
||||
);
|
||||
|
||||
// Display 'editReviewForm' tabs
|
||||
$templateMgr = TemplateManager::getManager($request);
|
||||
$templateMgr->assign([
|
||||
'preview' => $request->getUserVar('preview'),
|
||||
'reviewFormId' => $reviewForm->getId(),
|
||||
'canEdit' => $reviewForm->getIncompleteCount() == 0 && $reviewForm->getCompleteCount() == 0,
|
||||
]);
|
||||
return new JSONMessage(true, $templateMgr->fetch('controllers/grid/settings/reviewForms/editReviewForm.tpl'));
|
||||
}
|
||||
|
||||
/**
|
||||
* Edit an existing review form's basics (title, description)
|
||||
*
|
||||
* @param array $args
|
||||
* @param PKPRequest $request
|
||||
*
|
||||
* @return JSONMessage JSON object
|
||||
*/
|
||||
public function reviewFormBasics($args, $request)
|
||||
{
|
||||
// Identify the review form Id
|
||||
$reviewFormId = (int) $request->getUserVar('reviewFormId');
|
||||
|
||||
// Form handling
|
||||
$reviewFormForm = new ReviewFormForm($reviewFormId);
|
||||
$reviewFormForm->initData();
|
||||
return new JSONMessage(true, $reviewFormForm->fetch($request));
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Display a list of the review form elements within a review form.
|
||||
*
|
||||
* @param array $args
|
||||
* @param PKPRequest $request
|
||||
*
|
||||
* @return JSONMessage JSON object
|
||||
*/
|
||||
public function reviewFormElements($args, $request)
|
||||
{
|
||||
$templateMgr = TemplateManager::getManager($request);
|
||||
$dispatcher = $request->getDispatcher();
|
||||
return $templateMgr->fetchAjax(
|
||||
'reviewFormElementsGridContainer',
|
||||
$dispatcher->url(
|
||||
$request,
|
||||
PKPApplication::ROUTE_COMPONENT,
|
||||
null,
|
||||
'grid.settings.reviewForms.ReviewFormElementsGridHandler',
|
||||
'fetchGrid',
|
||||
null,
|
||||
['reviewFormId' => (int) $request->getUserVar('reviewFormId')]
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Update an existing review form.
|
||||
*
|
||||
* @param array $args
|
||||
* @param PKPRequest $request
|
||||
*
|
||||
* @return JSONMessage JSON message
|
||||
*/
|
||||
public function updateReviewForm($args, $request)
|
||||
{
|
||||
// Identify the review form Id.
|
||||
$reviewFormId = (int) $request->getUserVar('reviewFormId');
|
||||
|
||||
// Identify the context id.
|
||||
$context = $request->getContext();
|
||||
|
||||
// Get review form object
|
||||
$reviewFormDao = DAORegistry::getDAO('ReviewFormDAO'); /** @var ReviewFormDAO $reviewFormDao */
|
||||
$reviewForm = $reviewFormDao->getById($reviewFormId, Application::getContextAssocType(), $context->getId());
|
||||
|
||||
// Form handling.
|
||||
$reviewFormForm = new ReviewFormForm(!isset($reviewFormId) || empty($reviewFormId) ? null : $reviewFormId);
|
||||
$reviewFormForm->readInputData();
|
||||
|
||||
if ($reviewFormForm->validate()) {
|
||||
$reviewFormForm->execute();
|
||||
|
||||
// Create the notification.
|
||||
$notificationMgr = new NotificationManager();
|
||||
$user = $request->getUser();
|
||||
$notificationMgr->createTrivialNotification($user->getId());
|
||||
|
||||
return \PKP\db\DAO::getDataChangedEvent($reviewFormId);
|
||||
}
|
||||
|
||||
return new JSONMessage(false);
|
||||
}
|
||||
|
||||
/**
|
||||
* Copy a review form.
|
||||
*
|
||||
* @param array $args
|
||||
* @param PKPRequest $request
|
||||
*
|
||||
* @return JSONMessage JSON object
|
||||
*/
|
||||
public function copyReviewForm($args, $request)
|
||||
{
|
||||
// Identify the current review form
|
||||
$reviewFormId = (int) $request->getUserVar('rowId');
|
||||
|
||||
// Identify the context id.
|
||||
$context = $request->getContext();
|
||||
|
||||
// Get review form object
|
||||
$reviewFormDao = DAORegistry::getDAO('ReviewFormDAO'); /** @var ReviewFormDAO $reviewFormDao */
|
||||
$reviewForm = $reviewFormDao->getById($reviewFormId, Application::getContextAssocType(), $context->getId());
|
||||
|
||||
if ($request->checkCSRF() && isset($reviewForm)) {
|
||||
$reviewForm->setActive(0);
|
||||
$reviewForm->setSequence(REALLY_BIG_NUMBER);
|
||||
$newReviewFormId = $reviewFormDao->insertObject($reviewForm);
|
||||
$reviewFormDao->resequenceReviewForms(Application::getContextAssocType(), $context->getId());
|
||||
|
||||
$reviewFormElementDao = DAORegistry::getDAO('ReviewFormElementDAO'); /** @var ReviewFormElementDAO $reviewFormElementDao */
|
||||
$reviewFormElements = $reviewFormElementDao->getByReviewFormId($reviewFormId);
|
||||
while ($reviewFormElement = $reviewFormElements->next()) {
|
||||
$reviewFormElement->setReviewFormId($newReviewFormId);
|
||||
$reviewFormElement->setSequence(REALLY_BIG_NUMBER);
|
||||
$reviewFormElementDao->insertObject($reviewFormElement);
|
||||
$reviewFormElementDao->resequenceReviewFormElements($newReviewFormId);
|
||||
}
|
||||
|
||||
// Create the notification.
|
||||
$notificationMgr = new NotificationManager();
|
||||
$user = $request->getUser();
|
||||
$notificationMgr->createTrivialNotification($user->getId());
|
||||
|
||||
return \PKP\db\DAO::getDataChangedEvent($newReviewFormId);
|
||||
}
|
||||
|
||||
return new JSONMessage(false);
|
||||
}
|
||||
|
||||
/**
|
||||
* Activate a review form.
|
||||
*
|
||||
* @param array $args
|
||||
* @param PKPRequest $request
|
||||
*
|
||||
* @return JSONMessage JSON object
|
||||
*/
|
||||
public function activateReviewForm($args, $request)
|
||||
{
|
||||
// Identify the current review form
|
||||
$reviewFormId = (int) $request->getUserVar('reviewFormKey');
|
||||
|
||||
// Identify the context id.
|
||||
$context = $request->getContext();
|
||||
|
||||
// Get review form object
|
||||
$reviewFormDao = DAORegistry::getDAO('ReviewFormDAO'); /** @var ReviewFormDAO $reviewFormDao */
|
||||
$reviewForm = $reviewFormDao->getById($reviewFormId, Application::getContextAssocType(), $context->getId());
|
||||
|
||||
if ($request->checkCSRF() && isset($reviewForm) && !$reviewForm->getActive()) {
|
||||
$reviewForm->setActive(1);
|
||||
$reviewFormDao->updateObject($reviewForm);
|
||||
|
||||
// Create the notification.
|
||||
$notificationMgr = new NotificationManager();
|
||||
$user = $request->getUser();
|
||||
$notificationMgr->createTrivialNotification($user->getId());
|
||||
|
||||
return \PKP\db\DAO::getDataChangedEvent($reviewFormId);
|
||||
}
|
||||
|
||||
return new JSONMessage(false);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Deactivate a review form.
|
||||
*
|
||||
* @param array $args
|
||||
* @param PKPRequest $request
|
||||
*
|
||||
* @return JSONMessage JSON object
|
||||
*/
|
||||
public function deactivateReviewForm($args, $request)
|
||||
{
|
||||
// Identify the current review form
|
||||
$reviewFormId = (int) $request->getUserVar('reviewFormKey');
|
||||
|
||||
// Identify the context id.
|
||||
$context = $request->getContext();
|
||||
|
||||
// Get review form object
|
||||
$reviewFormDao = DAORegistry::getDAO('ReviewFormDAO'); /** @var ReviewFormDAO $reviewFormDao */
|
||||
$reviewForm = $reviewFormDao->getById($reviewFormId, Application::getContextAssocType(), $context->getId());
|
||||
|
||||
if ($request->checkCSRF() && isset($reviewForm) && $reviewForm->getActive()) {
|
||||
$reviewForm->setActive(0);
|
||||
$reviewFormDao->updateObject($reviewForm);
|
||||
|
||||
// Create the notification.
|
||||
$notificationMgr = new NotificationManager();
|
||||
$user = $request->getUser();
|
||||
$notificationMgr->createTrivialNotification($user->getId());
|
||||
|
||||
return \PKP\db\DAO::getDataChangedEvent($reviewFormId);
|
||||
}
|
||||
|
||||
return new JSONMessage(false);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete a review form.
|
||||
*
|
||||
* @param array $args
|
||||
* @param PKPRequest $request
|
||||
*
|
||||
* @return JSONMessage JSON object
|
||||
*/
|
||||
public function deleteReviewForm($args, $request)
|
||||
{
|
||||
// Identify the current review form
|
||||
$reviewFormId = (int) $request->getUserVar('rowId');
|
||||
|
||||
// Identify the context id.
|
||||
$context = $request->getContext();
|
||||
|
||||
// Get review form object
|
||||
$reviewFormDao = DAORegistry::getDAO('ReviewFormDAO'); /** @var ReviewFormDAO $reviewFormDao */
|
||||
$reviewForm = $reviewFormDao->getById($reviewFormId, Application::getContextAssocType(), $context->getId());
|
||||
|
||||
if ($request->checkCSRF() && isset($reviewForm) && $reviewForm->getCompleteCount() == 0 && $reviewForm->getIncompleteCount() == 0) {
|
||||
$reviewAssignmentDao = DAORegistry::getDAO('ReviewAssignmentDAO'); /** @var ReviewAssignmentDAO $reviewAssignmentDao */
|
||||
$reviewAssignments = $reviewAssignmentDao->getByReviewFormId($reviewFormId);
|
||||
|
||||
foreach ($reviewAssignments as $reviewAssignment) {
|
||||
$reviewAssignment->setReviewFormId(null);
|
||||
$reviewAssignmentDao->updateObject($reviewAssignment);
|
||||
}
|
||||
|
||||
$reviewFormDao->deleteById($reviewFormId);
|
||||
|
||||
// Create the notification.
|
||||
$notificationMgr = new NotificationManager();
|
||||
$user = $request->getUser();
|
||||
$notificationMgr->createTrivialNotification($user->getId());
|
||||
|
||||
return \PKP\db\DAO::getDataChangedEvent($reviewFormId);
|
||||
}
|
||||
|
||||
return new JSONMessage(false);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,116 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @file controllers/grid/settings/reviewForms/ReviewFormGridRow.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 ReviewFormGridRow
|
||||
*
|
||||
* @ingroup controllers_grid_settings_reviewForms
|
||||
*
|
||||
* @brief ReviewForm grid row definition
|
||||
*/
|
||||
|
||||
namespace PKP\controllers\grid\settings\reviewForms;
|
||||
|
||||
use PKP\controllers\grid\GridRow;
|
||||
use PKP\linkAction\LinkAction;
|
||||
use PKP\linkAction\request\AjaxModal;
|
||||
use PKP\linkAction\request\RemoteActionConfirmationModal;
|
||||
|
||||
class ReviewFormGridRow extends GridRow
|
||||
{
|
||||
//
|
||||
// Overridden methods from GridRow
|
||||
//
|
||||
/**
|
||||
* @copydoc GridRow::initialize()
|
||||
*
|
||||
* @param null|mixed $template
|
||||
*/
|
||||
public function initialize($request, $template = null)
|
||||
{
|
||||
parent::initialize($request, $template);
|
||||
|
||||
// Is this a new row or an existing row?
|
||||
$element = $this->getData();
|
||||
assert($element instanceof \PKP\reviewForm\ReviewForm);
|
||||
|
||||
$rowId = $this->getId();
|
||||
|
||||
if (!empty($rowId) && is_numeric($rowId)) {
|
||||
// Only add row actions if this is an existing row
|
||||
$router = $request->getRouter();
|
||||
|
||||
// determine whether or not this Review Form is editable.
|
||||
$canEdit = ($element->getIncompleteCount() == 0 && $element->getCompleteCount() == 0);
|
||||
|
||||
// if review form is editable, add 'edit' grid row action
|
||||
if ($canEdit) {
|
||||
$this->addAction(
|
||||
new LinkAction(
|
||||
'edit',
|
||||
new AjaxModal(
|
||||
$router->url($request, null, null, 'editReviewForm', null, ['rowId' => $rowId]),
|
||||
__('grid.action.edit'),
|
||||
'modal_edit',
|
||||
true
|
||||
),
|
||||
__('grid.action.edit'),
|
||||
'edit'
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
// if review form is not editable, add 'copy' grid row action
|
||||
$this->addAction(
|
||||
new LinkAction(
|
||||
'copy',
|
||||
new RemoteActionConfirmationModal(
|
||||
$request->getSession(),
|
||||
__('manager.reviewForms.confirmCopy'),
|
||||
null,
|
||||
$router->url($request, null, null, 'copyReviewForm', null, ['rowId' => $rowId])
|
||||
),
|
||||
__('grid.action.copy'),
|
||||
'copy'
|
||||
)
|
||||
);
|
||||
|
||||
// add 'preview' grid row action
|
||||
$this->addAction(
|
||||
new LinkAction(
|
||||
'preview',
|
||||
new AjaxModal(
|
||||
$router->url($request, null, null, 'editReviewForm', null, ['rowId' => $rowId, 'preview' => 1]),
|
||||
__('grid.action.preview'),
|
||||
'preview',
|
||||
true
|
||||
),
|
||||
__('grid.action.preview'),
|
||||
'preview'
|
||||
)
|
||||
);
|
||||
|
||||
// if review form is editable, add 'delete' grid row action.
|
||||
if ($canEdit) {
|
||||
$this->addAction(
|
||||
new LinkAction(
|
||||
'delete',
|
||||
new RemoteActionConfirmationModal(
|
||||
$request->getSession(),
|
||||
__('manager.reviewForms.confirmDelete'),
|
||||
null,
|
||||
$router->url($request, null, null, 'deleteReviewForm', null, ['rowId' => $rowId])
|
||||
),
|
||||
__('grid.action.delete'),
|
||||
'delete'
|
||||
)
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,86 @@
|
||||
<?php
|
||||
/**
|
||||
* @file controllers/grid/settings/reviewForms/form/PKPPreviewReviewForm.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 PreviewReviewForm
|
||||
*
|
||||
* @ingroup controllers_grid_settings_reviewForms_form
|
||||
*
|
||||
* @brief Form for manager to preview review form.
|
||||
*/
|
||||
|
||||
namespace PKP\controllers\grid\settings\reviewForms\form;
|
||||
|
||||
use APP\core\Application;
|
||||
use APP\template\TemplateManager;
|
||||
use PKP\core\JSONMessage;
|
||||
use PKP\db\DAORegistry;
|
||||
use PKP\form\Form;
|
||||
use PKP\reviewForm\ReviewForm;
|
||||
use PKP\reviewForm\ReviewFormDAO;
|
||||
use PKP\reviewForm\ReviewFormElementDAO;
|
||||
use PKP\security\Validation;
|
||||
|
||||
class PreviewReviewForm extends Form
|
||||
{
|
||||
/** @var int The ID of the review form being edited */
|
||||
public $reviewFormId;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param int $reviewFormId omit for a new review form
|
||||
*/
|
||||
public function __construct($reviewFormId = null)
|
||||
{
|
||||
parent::__construct('manager/reviewForms/previewReviewForm.tpl');
|
||||
|
||||
$this->reviewFormId = (int) $reviewFormId;
|
||||
|
||||
// Validation checks for this form
|
||||
$this->addCheck(new \PKP\form\validation\FormValidatorPost($this));
|
||||
$this->addCheck(new \PKP\form\validation\FormValidatorCSRF($this));
|
||||
}
|
||||
|
||||
/**
|
||||
* @copydoc Form::fetch
|
||||
*
|
||||
* @param null|mixed $template
|
||||
*/
|
||||
public function fetch($request, $template = null, $display = false)
|
||||
{
|
||||
$json = new JSONMessage();
|
||||
|
||||
$templateMgr = TemplateManager::getManager($request);
|
||||
$templateMgr->assign('reviewFormId', $this->reviewFormId);
|
||||
|
||||
return parent::fetch($request, $template, $display);
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialize form data from current settings.
|
||||
*/
|
||||
public function initData()
|
||||
{
|
||||
if ($this->reviewFormId) {
|
||||
// Get review form
|
||||
$request = Application::get()->getRequest();
|
||||
$context = $request->getContext();
|
||||
$reviewFormDao = DAORegistry::getDAO('ReviewFormDAO'); /** @var ReviewFormDAO $reviewFormDao */
|
||||
$reviewForm = $reviewFormDao->getById($this->reviewFormId, Application::getContextAssocType(), $context->getId()); /** @var ReviewForm $reviewForm */
|
||||
|
||||
// Get review form elements
|
||||
$reviewFormElementDao = DAORegistry::getDAO('ReviewFormElementDAO'); /** @var ReviewFormElementDAO $reviewFormElementDao */
|
||||
$reviewFormElements = $reviewFormElementDao->getByReviewFormId($this->reviewFormId);
|
||||
|
||||
// Set data
|
||||
$this->setData('title', $reviewForm->getLocalizedTitle());
|
||||
$this->setData('description', $reviewForm->getLocalizedDescription());
|
||||
$this->setData('reviewFormElements', $reviewFormElements);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,214 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @file controllers/grid/settings/reviewForms/form/ReviewFormElementForm.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 ReviewFormElementForm
|
||||
*
|
||||
* @ingroup controllers_grid_settings_reviewForms_form
|
||||
*
|
||||
* @see ReviewFormElement
|
||||
*
|
||||
* @brief Form for creating and modifying review form elements.
|
||||
*
|
||||
*/
|
||||
|
||||
namespace PKP\controllers\grid\settings\reviewForms\form;
|
||||
|
||||
use APP\core\Application;
|
||||
use APP\template\TemplateManager;
|
||||
use PKP\controllers\listbuilder\ListbuilderHandler;
|
||||
use PKP\db\DAORegistry;
|
||||
use PKP\form\Form;
|
||||
use PKP\reviewForm\ReviewFormDAO;
|
||||
use PKP\reviewForm\ReviewFormElement;
|
||||
use PKP\reviewForm\ReviewFormElementDAO;
|
||||
use PKP\security\Validation;
|
||||
|
||||
class ReviewFormElementForm extends Form
|
||||
{
|
||||
/** @var int $reviewFormId The ID of the review form being edited */
|
||||
public $reviewFormId;
|
||||
|
||||
/** @var int $reviewFormElementId The ID of the review form element being edited */
|
||||
public $reviewFormElementId;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param int $reviewFormId
|
||||
* @param int $reviewFormElementId
|
||||
*/
|
||||
public function __construct($reviewFormId, $reviewFormElementId = null)
|
||||
{
|
||||
parent::__construct('manager/reviewForms/reviewFormElementForm.tpl');
|
||||
|
||||
$this->reviewFormId = $reviewFormId;
|
||||
$this->reviewFormElementId = $reviewFormElementId;
|
||||
|
||||
// Validation checks for this form
|
||||
$this->addCheck(new \PKP\form\validation\FormValidatorLocale($this, 'question', 'required', 'manager.reviewFormElements.form.questionRequired'));
|
||||
$this->addCheck(new \PKP\form\validation\FormValidator($this, 'elementType', 'required', 'manager.reviewFormElements.form.elementTypeRequired'));
|
||||
$this->addCheck(new \PKP\form\validation\FormValidatorPost($this));
|
||||
$this->addCheck(new \PKP\form\validation\FormValidatorCSRF($this));
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the names of fields for which localized data is allowed.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function getLocaleFieldNames()
|
||||
{
|
||||
$reviewFormElementDao = DAORegistry::getDAO('ReviewFormElementDAO'); /** @var ReviewFormElementDAO $reviewFormElementDao */
|
||||
return $reviewFormElementDao->getLocaleFieldNames();
|
||||
}
|
||||
|
||||
/**
|
||||
* @copydoc Form::fetch
|
||||
*
|
||||
* @param null|mixed $template
|
||||
*/
|
||||
public function fetch($request, $template = null, $display = false)
|
||||
{
|
||||
$templateMgr = TemplateManager::getManager($request);
|
||||
$reviewFormElement = new ReviewFormElement();
|
||||
$templateMgr->assign([
|
||||
'reviewFormId' => $this->reviewFormId,
|
||||
'reviewFormElementId' => $this->reviewFormElementId,
|
||||
'multipleResponsesElementTypes' => $reviewFormElement->getMultipleResponsesElementTypes(),
|
||||
'multipleResponsesElementTypesString' => ';' . implode(';', $reviewFormElement->getMultipleResponsesElementTypes()) . ';',
|
||||
'reviewFormElementTypeOptions' => $reviewFormElement->getReviewFormElementTypeOptions(),
|
||||
]);
|
||||
return parent::fetch($request, $template, $display);
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialize form data from current review form.
|
||||
*/
|
||||
public function initData()
|
||||
{
|
||||
if ($this->reviewFormElementId) {
|
||||
$request = Application::get()->getRequest();
|
||||
$context = $request->getContext();
|
||||
$reviewFormElementDao = DAORegistry::getDAO('ReviewFormElementDAO'); /** @var ReviewFormElementDAO $reviewFormElementDao */
|
||||
$reviewFormElement = $reviewFormElementDao->getById($this->reviewFormElementId, $this->reviewFormId);
|
||||
$this->_data = [
|
||||
'question' => $reviewFormElement->getQuestion(null), // Localized
|
||||
'description' => $reviewFormElement->getDescription(null), // Localized
|
||||
'required' => $reviewFormElement->getRequired(),
|
||||
'included' => $reviewFormElement->getIncluded(),
|
||||
|
||||
'elementType' => $reviewFormElement->getElementType(),
|
||||
'possibleResponses' => $reviewFormElement->getPossibleResponses(null) //Localized
|
||||
];
|
||||
} else {
|
||||
$this->_data = [
|
||||
'included' => 1
|
||||
];
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Assign form data to user-submitted data.
|
||||
*/
|
||||
public function readInputData()
|
||||
{
|
||||
$this->readUserVars(['question', 'description', 'required', 'included', 'elementType', 'possibleResponses']);
|
||||
}
|
||||
|
||||
/**
|
||||
* @copydoc Form::execute()
|
||||
*
|
||||
* @return int Review form element ID
|
||||
*/
|
||||
public function execute(...$functionArgs)
|
||||
{
|
||||
$reviewFormElementDao = DAORegistry::getDAO('ReviewFormElementDAO'); /** @var ReviewFormElementDAO $reviewFormElementDao */
|
||||
$request = Application::get()->getRequest();
|
||||
|
||||
if ($this->reviewFormElementId) {
|
||||
$context = $request->getContext();
|
||||
$reviewFormElement = $reviewFormElementDao->getById($this->reviewFormElementId);
|
||||
$reviewFormDao = DAORegistry::getDAO('ReviewFormDAO'); /** @var ReviewFormDAO $reviewFormDao */
|
||||
$reviewForm = $reviewFormDao->getById($reviewFormElement->getReviewFormId(), Application::getContextAssocType(), $context->getId());
|
||||
if (!$reviewForm) {
|
||||
fatalError('Invalid review form element ID!');
|
||||
}
|
||||
} else {
|
||||
$reviewFormElement = $reviewFormElementDao->newDataObject();
|
||||
$reviewFormElement->setReviewFormId($this->reviewFormId);
|
||||
$reviewFormElement->setSequence(REALLY_BIG_NUMBER);
|
||||
}
|
||||
|
||||
$reviewFormElement->setQuestion($this->getData('question'), null); // Localized
|
||||
$reviewFormElement->setDescription($this->getData('description'), null); // Localized
|
||||
$reviewFormElement->setRequired($this->getData('required') ? 1 : 0);
|
||||
$reviewFormElement->setIncluded($this->getData('included') ? 1 : 0);
|
||||
$reviewFormElement->setElementType($this->getData('elementType'));
|
||||
|
||||
if (in_array($this->getData('elementType'), $reviewFormElement->getMultipleResponsesElementTypes())) {
|
||||
$this->setData('possibleResponsesProcessed', $reviewFormElement->getPossibleResponses(null));
|
||||
ListbuilderHandler::unpack($request, $this->getData('possibleResponses'), [$this, 'deleteEntry'], [$this, 'insertEntry'], [$this, 'updateEntry']);
|
||||
$reviewFormElement->setPossibleResponses($this->getData('possibleResponsesProcessed'), null);
|
||||
} else {
|
||||
$reviewFormElement->setPossibleResponses(null, null);
|
||||
}
|
||||
if ($reviewFormElement->getId()) {
|
||||
$reviewFormElementDao->deleteSetting($reviewFormElement->getId(), 'possibleResponses');
|
||||
$reviewFormElementDao->updateObject($reviewFormElement);
|
||||
} else {
|
||||
$this->reviewFormElementId = $reviewFormElementDao->insertObject($reviewFormElement);
|
||||
$reviewFormElementDao->resequenceReviewFormElements($this->reviewFormId);
|
||||
}
|
||||
parent::execute(...$functionArgs);
|
||||
return $this->reviewFormElementId;
|
||||
}
|
||||
|
||||
/**
|
||||
* @copydoc ListbuilderHandler::insertEntry()
|
||||
*/
|
||||
public function insertEntry($request, $newRowId)
|
||||
{
|
||||
$possibleResponsesProcessed = (array) $this->getData('possibleResponsesProcessed');
|
||||
foreach ($newRowId['possibleResponse'] as $key => $value) {
|
||||
$possibleResponsesProcessed[$key][] = $value;
|
||||
}
|
||||
$this->setData('possibleResponsesProcessed', $possibleResponsesProcessed);
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* @copydoc ListbuilderHandler::deleteEntry()
|
||||
*/
|
||||
public function deleteEntry($request, $rowId)
|
||||
{
|
||||
$possibleResponsesProcessed = (array) $this->getData('possibleResponsesProcessed');
|
||||
foreach (array_keys($possibleResponsesProcessed) as $locale) {
|
||||
// WARNING: Listbuilders don't like zero row IDs. They are offset
|
||||
// by 1 to avoid this case, so 1 is subtracted here to normalize.
|
||||
unset($possibleResponsesProcessed[$locale][$rowId - 1]);
|
||||
}
|
||||
$this->setData('possibleResponsesProcessed', $possibleResponsesProcessed);
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* @copydoc ListbuilderHandler::updateEntry
|
||||
*/
|
||||
public function updateEntry($request, $rowId, $newRowId)
|
||||
{
|
||||
$possibleResponsesProcessed = (array) $this->getData('possibleResponsesProcessed');
|
||||
foreach ($newRowId['possibleResponse'] as $locale => $value) {
|
||||
// WARNING: Listbuilders don't like zero row IDs. They are offset
|
||||
// by 1 to avoid this case, so 1 is subtracted here to normalize.
|
||||
$possibleResponsesProcessed[$locale][$rowId - 1] = $value;
|
||||
}
|
||||
$this->setData('possibleResponsesProcessed', $possibleResponsesProcessed);
|
||||
return true;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,82 @@
|
||||
<?php
|
||||
/**
|
||||
* @file controllers/grid/settings/reviewForms/form/ReviewFormElements.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 ReviewFormElements
|
||||
*
|
||||
* @ingroup controllers_grid_settings_reviewForms_form
|
||||
*
|
||||
* @brief Form for manager to edit review form elements.
|
||||
*/
|
||||
|
||||
namespace PKP\controllers\grid\settings\reviewForms\form;
|
||||
|
||||
use APP\core\Application;
|
||||
use APP\template\TemplateManager;
|
||||
use PKP\core\JSONMessage;
|
||||
use PKP\db\DAORegistry;
|
||||
use PKP\form\Form;
|
||||
use PKP\reviewForm\ReviewFormDAO;
|
||||
use PKP\reviewForm\ReviewFormElementDAO;
|
||||
use PKP\security\Validation;
|
||||
|
||||
class ReviewFormElements extends Form
|
||||
{
|
||||
/** @var int The ID of the review form being edited */
|
||||
public $reviewFormId;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param int $reviewFormId
|
||||
*/
|
||||
public function __construct($reviewFormId)
|
||||
{
|
||||
parent::__construct('manager/reviewForms/reviewFormElements.tpl');
|
||||
|
||||
$this->reviewFormId = (int) $reviewFormId;
|
||||
|
||||
// Validation checks for this form
|
||||
$this->addCheck(new \PKP\form\validation\FormValidatorPost($this));
|
||||
$this->addCheck(new \PKP\form\validation\FormValidatorCSRF($this));
|
||||
}
|
||||
|
||||
/**
|
||||
* @copydoc Form::fetch
|
||||
*
|
||||
* @param null|mixed $template
|
||||
*/
|
||||
public function fetch($request, $template = null, $display = false)
|
||||
{
|
||||
$json = new JSONMessage();
|
||||
|
||||
$templateMgr = TemplateManager::getManager($request);
|
||||
$templateMgr->assign('reviewFormId', $this->reviewFormId);
|
||||
|
||||
return parent::fetch($request, $template, $display);
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialize form data from current settings.
|
||||
*/
|
||||
public function initData()
|
||||
{
|
||||
if (isset($this->reviewFormId)) {
|
||||
// Get review form
|
||||
$reviewFormDao = DAORegistry::getDAO('ReviewFormDAO'); /** @var ReviewFormDAO $reviewFormDao */
|
||||
$reviewForm = $reviewFormDao->getById($this->reviewFormId, Application::getContextAssocType(), Application::get()->getRequest()->getContext()->getId());
|
||||
|
||||
// Get review form elements
|
||||
$reviewFormElementDao = DAORegistry::getDAO('ReviewFormElementDAO'); /** @var ReviewFormElementDAO $reviewFormElementDao */
|
||||
$reviewFormElements = $reviewFormElementDao->getByReviewFormId($this->reviewFormId, null);
|
||||
|
||||
// Set data
|
||||
$this->setData('reviewFormId', $this->reviewFormId);
|
||||
$this->setData('reviewFormElements', $reviewFormElements);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,128 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @file controllers/grid/settings/reviewForms/form/ReviewFormForm.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 ReviewFormForm
|
||||
*
|
||||
* @ingroup controllers_grid_settings_reviewForms_form
|
||||
*
|
||||
* @brief Form for manager to edit a review form.
|
||||
*/
|
||||
|
||||
namespace PKP\controllers\grid\settings\reviewForms\form;
|
||||
|
||||
use APP\core\Application;
|
||||
use APP\template\TemplateManager;
|
||||
use PKP\core\JSONMessage;
|
||||
use PKP\db\DAORegistry;
|
||||
use PKP\form\Form;
|
||||
use PKP\reviewForm\ReviewFormDAO;
|
||||
|
||||
class ReviewFormForm extends Form
|
||||
{
|
||||
/** @var int The ID of the review form being edited, if any */
|
||||
public $reviewFormId;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param int $reviewFormId omit for a new review form
|
||||
*/
|
||||
public function __construct($reviewFormId = null)
|
||||
{
|
||||
parent::__construct('manager/reviewForms/reviewFormForm.tpl');
|
||||
$this->reviewFormId = $reviewFormId ? (int) $reviewFormId : null;
|
||||
|
||||
// Validation checks for this form
|
||||
$this->addCheck(new \PKP\form\validation\FormValidatorLocale($this, 'title', 'required', 'manager.reviewForms.form.titleRequired'));
|
||||
$this->addCheck(new \PKP\form\validation\FormValidatorPost($this));
|
||||
$this->addCheck(new \PKP\form\validation\FormValidatorCSRF($this));
|
||||
}
|
||||
|
||||
/**
|
||||
* Assign form data to user-submitted data.
|
||||
*/
|
||||
public function readInputData()
|
||||
{
|
||||
$this->readUserVars(['title', 'description']);
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialize form data from current settings.
|
||||
*/
|
||||
public function initData()
|
||||
{
|
||||
if ($this->reviewFormId) {
|
||||
$request = Application::get()->getRequest();
|
||||
$context = $request->getContext();
|
||||
$reviewFormDao = DAORegistry::getDAO('ReviewFormDAO'); /** @var ReviewFormDAO $reviewFormDao */
|
||||
$reviewForm = $reviewFormDao->getById($this->reviewFormId, Application::getContextAssocType(), $context->getId());
|
||||
|
||||
$this->setData('title', $reviewForm->getTitle(null));
|
||||
$this->setData('description', $reviewForm->getDescription(null));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @copydoc Form::fetch
|
||||
*
|
||||
* @param null|mixed $template
|
||||
*/
|
||||
public function fetch($request, $template = null, $display = false)
|
||||
{
|
||||
$json = new JSONMessage();
|
||||
|
||||
$templateMgr = TemplateManager::getManager($request);
|
||||
$templateMgr->assign('reviewFormId', $this->reviewFormId);
|
||||
|
||||
return parent::fetch($request, $template, $display);
|
||||
}
|
||||
|
||||
/**
|
||||
* @copydoc Form::execute()
|
||||
*/
|
||||
public function execute(...$functionArgs)
|
||||
{
|
||||
$request = Application::get()->getRequest();
|
||||
$context = $request->getContext();
|
||||
$reviewFormDao = DAORegistry::getDAO('ReviewFormDAO'); /** @var ReviewFormDAO $reviewFormDao */
|
||||
|
||||
if ($this->reviewFormId) {
|
||||
$reviewForm = $reviewFormDao->getById($this->reviewFormId, Application::getContextAssocType(), $context->getId());
|
||||
} else {
|
||||
$reviewForm = $reviewFormDao->newDataObject();
|
||||
$reviewForm->setAssocType(Application::getContextAssocType());
|
||||
$reviewForm->setAssocId($context->getId());
|
||||
$reviewForm->setActive(0);
|
||||
$reviewForm->setSequence(REALLY_BIG_NUMBER);
|
||||
}
|
||||
|
||||
$reviewForm->setTitle($this->getData('title'), null); // Localized
|
||||
$reviewForm->setDescription($this->getData('description'), null); // Localized
|
||||
|
||||
if ($this->reviewFormId) {
|
||||
$reviewFormDao->updateObject($reviewForm);
|
||||
$this->reviewFormId = $reviewForm->getId();
|
||||
} else {
|
||||
$this->reviewFormId = $reviewFormDao->insertObject($reviewForm);
|
||||
$reviewFormDao->resequenceReviewForms(Application::getContextAssocType(), $context->getId());
|
||||
}
|
||||
parent::execute(...$functionArgs);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a list of field names for which localized settings are used
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function getLocaleFieldNames()
|
||||
{
|
||||
$reviewFormDao = DAORegistry::getDAO('ReviewFormDAO'); /** @var ReviewFormDAO $reviewFormDao */
|
||||
return $reviewFormDao->getLocaleFieldNames();
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user