first commit

plugins/generic/announcementFeed/AnnouncementFeedSettingsForm.php

@@ -0,0 +1,96 @@
+<?php
+
+/**
+ * @file plugins/generic/announcementFeed/AnnouncementFeedSettingsForm.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 AnnouncementFeedSettingsForm
+ *
+ * @brief Form for journal managers to modify announcement feed plugin settings
+ */
+
+namespace APP\plugins\generic\announcementFeed;
+
+use APP\template\TemplateManager;
+use PKP\form\Form;
+
+class AnnouncementFeedSettingsForm extends Form
+{
+    /** @var int */
+    protected $_journalId;
+
+    /** @var object */
+    protected $_plugin;
+
+    /**
+     * Constructor
+     *
+     * @param object $plugin
+     * @param int $journalId
+     */
+    public function __construct($plugin, $journalId)
+    {
+        $this->_journalId = $journalId;
+        $this->_plugin = $plugin;
+
+        parent::__construct($plugin->getTemplateResource('settingsForm.tpl'));
+        $this->addCheck(new \PKP\form\validation\FormValidatorPost($this));
+        $this->addCheck(new \PKP\form\validation\FormValidatorCSRF($this));
+    }
+
+    /**
+     * Initialize form data.
+     */
+    public function initData()
+    {
+        $journalId = $this->_journalId;
+        $plugin = $this->_plugin;
+
+        $this->setData('displayPage', $plugin->getSetting($journalId, 'displayPage'));
+        $this->setData('recentItems', $plugin->getSetting($journalId, 'recentItems'));
+    }
+
+    /**
+     * Assign form data to user-submitted data.
+     */
+    public function readInputData()
+    {
+        $this->readUserVars(['displayPage', 'recentItems']);
+
+        // check that recent items value is a positive integer
+        if ((int) $this->getData('recentItems') <= 0) {
+            $this->setData('recentItems', '');
+        }
+    }
+
+    /**
+     * Fetch the form.
+     *
+     * @copydoc Form::fetch()
+     *
+     * @param null|mixed $template
+     */
+    public function fetch($request, $template = null, $display = false)
+    {
+        $templateMgr = TemplateManager::getManager($request);
+        $templateMgr->assign('pluginName', $this->_plugin->getName());
+        return parent::fetch($request, $template, $display);
+    }
+
+    /**
+     * @copydoc Form::execute()
+     */
+    public function execute(...$functionArgs)
+    {
+        $plugin = $this->_plugin;
+        $journalId = $this->_journalId;
+
+        $plugin->updateSetting($journalId, 'displayPage', $this->getData('displayPage'));
+        $plugin->updateSetting($journalId, 'recentItems', $this->getData('recentItems'));
+
+        parent::execute(...$functionArgs);
+    }
+}