Open Journal Systems  2.4.8
 All Classes Namespaces Functions Variables Groups Pages
GatewayPlugin Class Reference
Inheritance diagram for GatewayPlugin:
Plugin PKPPlugin AnnouncementFeedGatewayPlugin METSGatewayPlugin PLNGatewayPlugin ResolverPlugin ThesisFeedGatewayPlugin WebFeedGatewayPlugin

Public Member Functions

 fetch ($args, $request)
 getDescription ()
 getDisplayName ()
 getEnabled ()
 getManagementVerbs ()
 getName ()
 manage ($verb, $args)
 setEnabled ($enabled)
- Public Member Functions inherited from Plugin
 getContextSpecificPluginSettingsFile ()
 getNewJournalPluginSettingsFile ()
 getSetting ($journalId, $name)
 Plugin ()
 updateSetting ($journalId, $name, $value, $type=null)
- Public Member Functions inherited from PKPPlugin
 _getContextSpecificInstallationHook ()
 addHelpData ($locale=null)
 addLocaleData ($locale=null)
 getCategory ()
 getContextSpecificPluginSettingsFile ()
 getContextSpecificSetting ($context, $name)
 getCurrentVersion ()
 getDescription ()
 getDisplayName ()
 getHelpMappingFilename ()
 getHideManagement ()
 getInstallDataFile ()
 getInstallEmailTemplateDataFile ()
 getInstallEmailTemplatesFile ()
 getInstallFilterConfigFiles ()
 getInstallSchemaFile ()
 getInstallSitePluginSettingsFile ()
 getLocaleFilename ($locale)
 getManagementVerbs ()
 getName ()
 getPluginPath ()
 getSeq ()
 getSettingMainContext ()
 getTemplatePath ()
 import ($class)
 installContextSpecificSettings ($hookName, $args)
 installData ($hookName, $args)
 installEmailTemplateData ($hookName, $args)
 installEmailTemplates ($hookName, $args)
 installFilters ($hookName, $args)
 installLocale ($hookName, $args)
 installSiteSettings ($hookName, $args)
 isSitePlugin ()
 manage ($verb, $args, &$message, &$messageParams, $request=null)
 PKPPlugin ()
 register ($category, $path)
 smartyPluginUrl ($params, &$smarty)
 updateContextSpecificSetting ($context, $name, $value, $type=null)
 updateSchema ($hookName, $args)

Detailed Description

Abstract class for gateway plugins.

Definition at line 18 of file

Member Function Documentation

GatewayPlugin::fetch (   $args,

Handle fetch requests for this plugin.


Definition at line 112 of file

GatewayPlugin::getDescription ( )

Get a description of the plugin.

Definition at line 46 of file

GatewayPlugin::getDisplayName ( )

Get the display name of this plugin. This name is displayed on the Journal Manager's plugin management page, for example.


Definition at line 37 of file

GatewayPlugin::getEnabled ( )

Determine whether or not this plugin is enabled.

Definition at line 72 of file

References Request\getJournal(), and Plugin\getSetting().

Referenced by ResolverPlugin\fetch(), METSGatewayPlugin\fetch(), and getManagementVerbs().

GatewayPlugin::getManagementVerbs ( )

Display verbs for the management interface.

Definition at line 53 of file

References getEnabled().

GatewayPlugin::getName ( )

Get the name of this plugin. The name must be unique within its category.

String name of plugin

Definition at line 28 of file

GatewayPlugin::manage (   $verb,

Perform management functions

Definition at line 97 of file

References setEnabled().

GatewayPlugin::setEnabled (   $enabled)

Set the enabled/disabled state of this plugin

Definition at line 81 of file

References Request\getJournal(), and Plugin\updateSetting().

Referenced by manage().

The documentation for this class was generated from the following file: