TestGatewayPlugin Class Reference

Inheritance diagram for TestGatewayPlugin:

Public Member Functions
	fetch ($args, $request)
	getDescription ()
	getDisplayName ()
	getName ()
	register ($category, $path, $mainContextId=null)
Public Member Functions inherited from GatewayPlugin
	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 ()
	getDirName ()
	getHideManagement ()
	getInstallControlledVocabFiles ()
	getInstallDataFile ()
	getInstallEmailTemplateDataFile ()
	getInstallEmailTemplatesFile ()
	getInstallFilterConfigFiles ()
	getInstallMigration ()
	getInstallSchemaFile ()
	getInstallSitePluginSettingsFile ()
	getLocaleFilename ($locale)
	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)
	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

Simple example gateway plugin.

Definition at line 16 of file TestGatewayPlugin.inc.php.

Member Function Documentation

fetch()

TestGatewayPlugin::fetch	(		$args,
			$request
	)

Handle fetch requests for this plugin.

Parameters

$args	array Arguments to this request.
$request	PKPRequest Request object.

Reimplemented from GatewayPlugin.

Definition at line 48 of file TestGatewayPlugin.inc.php.

References GatewayPlugin\getEnabled().

getDescription()

TestGatewayPlugin::getDescription

(

)

Get a description of this plugin.

Returns

string

Reimplemented from Plugin.

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

getDisplayName()

TestGatewayPlugin::getDisplayName

(

)

Get the display name for this plugin.

Returns

string

Reimplemented from Plugin.

Definition at line 35 of file TestGatewayPlugin.inc.php.

getName()

TestGatewayPlugin::getName

(

)

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

Returns

String name of plugin

Reimplemented from Plugin.

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

register()

TestGatewayPlugin::register	(		$category,
			$path,
			$mainContextId = null
	)

Load and initialize the plug-in and register plugin hooks.

For backwards compatibility this method will be called whenever the plug-in's category is being loaded. If, however, registerOn() returns an array then this method will only be called when the plug-in is enabled and an entry in the result set of registerOn() matches the current request operation. An empty array matches all request operations.

Parameters

$category	String Name of category plugin was registered to
$path	String The path the plugin was found in
$mainContextId	integer To identify if the plugin is enabled we need a context. This context is usually taken from the request but sometimes there is no context in the request (e.g. when executing CLI commands). Then the main context can be given as an explicit ID.

Returns

boolean True iff plugin registered successfully; if false, the plugin will not be executed.

Reimplemented from Plugin.

Definition at line 20 of file TestGatewayPlugin.inc.php.

References Plugin\addLocaleData().

---

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

• TestGatewayPlugin.inc.php