SubscriptionSSOSettingsForm.php

<?php

/**
 * @file SubscriptionSSOSettingsForm.inc.php
 *
 * Copyright (c) 2014-2023 Simon Fraser University
 * Copyright (c) 2014-2023 John Willinsky
 * Distributed under the GNU GPL v3. For full terms see the file LICENSE.
 *
 * @class SubscriptionSSOSettingsForm
 * @brief Form for journal managers to modify subscription SSO plugin settings
 */

namespace APP\plugins\generic\subscriptionSSO;

use PKP\form\Form;
use APP\template\TemplateManager;

class SubscriptionSSOSettingsForm extends Form {

	/** @var int */
	var $_journalId;

	/** @var GenericPlugin */
	var $_plugin;

	/**
	 * Constructor
	 * @param object $plugin
	 * @param int $journalId
	 */
	function __construct($plugin, $journalId) {
		$this->_journalId = $journalId;
		$this->_plugin = $plugin;

		parent::__construct($plugin->getTemplateResource('settingsForm.tpl'));

		$this->addCheck(new \PKP\form\validation\FormValidatorRegExp($this, 'incomingParameterName', 'required', 'plugins.generic.subscriptionSSO.settings.incomingParameterName.required', '/^[a-zA-Z0-9\/._-]+$/'));
		$this->addCheck(new \PKP\form\validation\FormValidatorUrl($this, 'verificationUrl', 'required', 'plugins.generic.subscriptionSSO.settings.verificationUrl.required'));
		$this->addCheck(new \PKP\form\validation\FormValidator($this, 'resultRegexp', 'required', 'plugins.generic.subscriptionSSO.settings.resultRegexp.required'));
		$this->addCheck(new \PKP\form\validation\FormValidatorUrl($this, 'redirectUrl', 'required', 'plugins.generic.subscriptionSSO.settings.redirectUrl.required'));
		$this->addCheck(new \PKP\form\validation\FormValidatorRegExp($this, 'hoursValid', 'required', 'plugins.generic.subscriptionSSO.settings.hoursValid.required', '/^[0-9]+$/'));
	}

	/**
	 * Initialize form data.
	 */
	function initData() {
		$journalId = $this->_journalId;
		$plugin = $this->_plugin;

		$this->_data = [
			'incomingParameterName' => $plugin->getSetting($journalId, 'incomingParameterName'),
			'verificationUrl' => $plugin->getSetting($journalId, 'verificationUrl'),
			'resultRegexp' => $plugin->getSetting($journalId, 'resultRegexp'),
			'redirectUrl' => $plugin->getSetting($journalId, 'redirectUrl'),
			'hoursValid' => $plugin->getSetting($journalId, 'hoursValid')
		];
	}

	/**
	 * Assign form data to user-submitted data.
	 */
	function readInputData() {
		$this->readUserVars(['incomingParameterName', 'verificationUrl', 'resultRegexp', 'redirectUrl', 'hoursValid']);
	}

	/**
	 * @copydoc Form::fetch()
	 */
	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()
	 */
	function execute(...$functionArgs) {
		$plugin = $this->_plugin;
		$journalId = $this->_journalId;

		$plugin->updateSetting($journalId, 'incomingParameterName', $this->getData('incomingParameterName'), 'string');
		$plugin->updateSetting($journalId, 'verificationUrl', $this->getData('verificationUrl'), 'string');
		$plugin->updateSetting($journalId, 'resultRegexp', $this->getData('resultRegexp'), 'string');
		$plugin->updateSetting($journalId, 'redirectUrl', $this->getData('redirectUrl'), 'string');
		$plugin->updateSetting($journalId, 'hoursValid', $this->getData('hoursValid'), 'string');

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