first commit

lib/pkp/controllers/grid/settings/reviewForms/form/PreviewReviewForm.php

@@ -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);
+        }
+    }
+}

lib/pkp/controllers/grid/settings/reviewForms/form/ReviewFormElementForm.php

@@ -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;
+    }
+}

lib/pkp/controllers/grid/settings/reviewForms/form/ReviewFormElements.php

@@ -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);
+        }
+    }
+}

lib/pkp/controllers/grid/settings/reviewForms/form/ReviewFormForm.php

@@ -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();
+    }
+}