TextEditorExtrasSettingsForm.php

<?php
/**
 * @file plugins/generic/textEditorExtras/TextEditorExtrasSettingsForm.php
 *
 * Copyright (c) 2017-2023 Simon Fraser University
 * Copyright (c) 2017-2023 John Willinsky
 * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
 *
 * @class TextEditorExtrasPlugin
 * @brief Settings form for the TextEditorExtras plugin.
 */

namespace APP\plugins\generic\textEditorExtras;

use PKP\form\Form;
use PKP\form\validation\FormValidatorPost;
use PKP\form\validation\FormValidatorCSRF;
use APP\notification\NotificationManager;
use APP\core\Application;
use APP\template\TemplateManager;
use PKPNotification;

class TextEditorExtrasSettingsForm extends Form {

    /** @var TextEditorExtrasPlugin  */
    public $plugin;
    /**
     * @copydoc Form::__construct()
     */
    public function __construct($plugin) {

        // Define the settings template and store a copy of the plugin object
        parent::__construct($plugin->getTemplateResource('settings.tpl'));
        $this->plugin = $plugin;

        // Always add POST and CSRF validation to secure your form.
        $this->addCheck(new FormValidatorPost($this));
        $this->addCheck(new FormValidatorCSRF($this));
    }

    /**
     * Load settings already saved in the database
     *
     * Settings are stored by context, so that each journal or press
     * can have different settings.
     */
    public function initData() {
      $contextId = Application::get()->getRequest()->getContext()->getId();

      // Customized to get settings form to work.
      $additions = [
        "masthead" => ["description" => []],
        "submissionGuidanceSettings" => [
          "authorGuidelines" => [],
          "beginSubmissionHelp" => [],
          "submissionChecklist" => [],
          "uploadFilesHelp" => [],
          "contributorsHelp" => [],
          "detailsHelp" => [],
          "forTheEditorsHelp" => [],
          "reviewHelp" => [],
          "copyrightNotice" => []
        ],
        "license" => ["licenseTerms" => []],
        "reviewerGuidance" => ["reviewGuidelines" => [], "competingInterests" => []],
        "editEmailTemplate" => ["body" => []],
        "titleAbstract" => ["abstract" => []],
        "announcement" => ["description" => [], "descriptionShort" => []]
      ];
      $settings = $this->plugin->getSetting($contextId, 'additions');
      if (isset($settings)) {
        $additions = array_merge_recursive($additions, $settings);
      }
      $this->setData('additions', $additions);
      parent::initData();
    }

    /**
     * Load data that was submitted with the form
     */
    public function readInputData() {
        $this->readUserVars(['additions']);
        parent::readInputData();
    }

    /**
     * Fetch any additional data needed for your form.
     *
     * Data assigned to the form using $this->setData() during the
     * initData() or readInputData() methods will be passed to the
     * template.
     *
     * @return string
     */
    public function fetch($request, $template = null, $display = false) {

        // Pass the plugin name to the template so that it can be
        // used in the URL that the form is submitted to
        $templateMgr = TemplateManager::getManager($request);
        $templateMgr->assign('pluginName', $this->plugin->getName());

        return parent::fetch($request, $template, $display);
    }

    /**
     * Save the settings
     *
     * @return null|mixed
     */
    public function execute(...$functionArgs) {
        $contextId = Application::get()->getRequest()->getContext()->getId();
        $this->plugin->updateSetting($contextId, 'additions', $this->getData('additions'));

        // Tell the user that the save was successful.
        $notificationMgr = new NotificationManager();
        $notificationMgr->createTrivialNotification(
            Application::get()->getRequest()->getUser()->getId(),
            PKPNotification::NOTIFICATION_TYPE_SUCCESS,
            ['contents' => __('common.changesSaved')]
        );

        return parent::execute(...$functionArgs);
    }
}