| Server IP : 104.20.45.2 / Your IP : 172.16.20.3 Web Server : Apache/2.4.25 (Debian) System : Linux f64a392e70de 5.4.0-216-generic #236-Ubuntu SMP Fri Apr 11 19:53:21 UTC 2025 x86_64 User : application ( 1000) PHP Version : 5.6.40 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : OFF | Pkexec : OFF Directory : /app/classes/plugins/ |
Upload File : |
<?php
/**
* @file classes/plugins/GatewayPlugin.inc.php
*
* Copyright (c) 2013-2019 Simon Fraser University
* Copyright (c) 2003-2019 John Willinsky
* Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
*
* @class GatewayPlugin
* @ingroup plugins
*
* @brief Abstract class for gateway plugins
*/
import('classes.plugins.Plugin');
class GatewayPlugin extends Plugin {
function GatewayPlugin() {
parent::Plugin();
}
/**
* Get the name of this plugin. The name must be unique within
* its category.
* @return String name of plugin
*/
function getName() {
assert(false); // Should always be overridden
}
/**
* Get the display name of this plugin. This name is displayed on the
* Journal Manager's plugin management page, for example.
* @return String
*/
function getDisplayName() {
// This name should never be displayed because child classes
// will override this method.
return 'Abstract Gateway Plugin';
}
/**
* Get a description of the plugin.
*/
function getDescription() {
return 'This is the GatewayPlugin base class. Its functions can be overridden by subclasses to provide import/export functionality for various formats.';
}
/**
* Display verbs for the management interface.
*/
function getManagementVerbs() {
$verbs = array();
if ($this->getEnabled()) {
$verbs[] = array(
'disable',
__('manager.plugins.disable')
);
} else {
$verbs[] = array(
'enable',
__('manager.plugins.enable')
);
}
return $verbs;
}
/**
* Determine whether or not this plugin is enabled.
*/
function getEnabled() {
$journal =& Request::getJournal();
if (!$journal) return false;
return $this->getSetting($journal->getId(), 'enabled');
}
/**
* Set the enabled/disabled state of this plugin
*/
function setEnabled($enabled) {
$journal =& Request::getJournal();
if ($journal) {
$this->updateSetting(
$journal->getId(),
'enabled',
$enabled?true:false
);
return true;
}
return false;
}
/**
* Perform management functions
*/
function manage($verb, $args) {
$templateManager =& TemplateManager::getManager();
$templateManager->register_function('plugin_url', array(&$this, 'smartyPluginUrl'));
switch ($verb) {
case 'enable': $this->setEnabled(true); break;
case 'disable': $this->setEnabled(false); break;
}
return false;
}
/**
* Handle fetch requests for this plugin.
* @param $args array
* @param $request object
*/
function fetch($args, $request) {
// Subclasses should override this function.
return false;
}
}
?>