Open Journal Systems  3.3.0
GatewayPlugin Class Reference
Inheritance diagram for GatewayPlugin:
Plugin AnnouncementFeedGatewayPlugin MarkupBatchGatewayPlugin MarkupGatewayPlugin PLNGatewayPlugin ResolverPlugin WebFeedGatewayPlugin

Public Member Functions

 fetch ($args, $request)
 
 getCanDisable ()
 
 getCanEnable ()
 
 getCurrentContextId ()
 
 getEnabled ()
 
 getPolicies ($request)
 
 setEnabled ($enabled)
 
- Public Member Functions inherited from Plugin
 __construct ()
 
 _overridePluginTemplates ($hookName, $args)
 
 addLocaleData ($locale=null)
 
 getActions ($request, $actionArgs)
 
 getCategory ()
 
 getContextSpecificPluginSettingsFile ()
 
 getCurrentVersion ()
 
 getDescription ()
 
 getDirName ()
 
 getDisplayName ()
 
 getHideManagement ()
 
 getInstallControlledVocabFiles ()
 
 getInstallDataFile ()
 
 getInstallEmailTemplateDataFile ()
 
 getInstallEmailTemplatesFile ()
 
 getInstallFilterConfigFiles ()
 
 getInstallMigration ()
 
 getInstallSchemaFile ()
 
 getInstallSitePluginSettingsFile ()
 
 getLocaleFilename ($locale)
 
 getName ()
 
 getPluginPath ()
 
getRequest ()
 
 getSeq ()
 
 getSetting ($contextId, $name)
 
 getTemplatePath ($inCore=false)
 
 getTemplateResource ($template=null, $inCore=false)
 
 import ($class)
 
 installContextSpecificSettings ($hookName, $args)
 
 installControlledVocabs ($hookName, $args)
 
 installData ($hookName, $args)
 
 installEmailTemplateData ($hookName, $args)
 
 installEmailTemplates ($hookName, $args)
 
 installFilters ($hookName, $args)
 
 installLocale ($hookName, $args)
 
 installSiteSettings ($hookName, $args)
 
 isSitePlugin ()
 
 manage ($args, $request)
 
 register ($category, $path, $mainContextId=null)
 
 smartyPluginUrl ($params, $smarty)
 
 updateSchema ($hookName, $args)
 
 updateSetting ($contextId, $name, $value, $type=null)
 

Additional Inherited Members

- Data Fields inherited from Plugin
 $pluginCategory
 
 $pluginPath
 
 $request
 
- Protected Member Functions inherited from Plugin
 _registerTemplateResource ($inCore=false)
 

Detailed Description

Abstract class for gateway plugins.

Definition at line 18 of file GatewayPlugin.inc.php.

Member Function Documentation

◆ fetch()

GatewayPlugin::fetch (   $args,
  $request 
)
abstract

Handle fetch requests for this plugin.

Parameters
$argsarray
$requestobject

Reimplemented in MarkupGatewayPlugin, MarkupBatchGatewayPlugin, PLNGatewayPlugin, WebFeedGatewayPlugin, AnnouncementFeedGatewayPlugin, and ResolverPlugin.

◆ getCanDisable()

GatewayPlugin::getCanDisable ( )

Determine whether the plugin can be disabled.

Returns
boolean

Reimplemented from Plugin.

Definition at line 39 of file GatewayPlugin.inc.php.

◆ getCanEnable()

GatewayPlugin::getCanEnable ( )

Determine whether the plugin can be enabled.

Returns
boolean

Reimplemented from Plugin.

Definition at line 31 of file GatewayPlugin.inc.php.

◆ getCurrentContextId()

GatewayPlugin::getCurrentContextId ( )

Get the current context ID or the site-wide context ID (0) if no context can be found.

Definition at line 63 of file GatewayPlugin.inc.php.

References PKPApplication\get().

Referenced by getEnabled(), and setEnabled().

◆ getEnabled()

GatewayPlugin::getEnabled ( )

Determine whether or not this plugin is currently enabled.

Returns
boolean

Reimplemented from Plugin.

Reimplemented in MarkupGatewayPlugin, PLNGatewayPlugin, and AnnouncementFeedGatewayPlugin.

Definition at line 47 of file GatewayPlugin.inc.php.

References getCurrentContextId(), and Plugin\getSetting().

Referenced by ResolverPlugin\fetch().

◆ getPolicies()

GatewayPlugin::getPolicies (   $request)

Get policies to the authorization process

Parameters
$requestPKPRequest
Returns
array Set of authorization policies

Definition at line 74 of file GatewayPlugin.inc.php.

◆ setEnabled()

GatewayPlugin::setEnabled (   $enabled)

Set whether or not this plugin is currently enabled.

Parameters
$enabledboolean

Definition at line 55 of file GatewayPlugin.inc.php.

References getCurrentContextId(), and Plugin\updateSetting().


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