PLNGatewayPlugin Class Reference

Inheritance diagram for PLNGatewayPlugin:

Public Member Functions
	__construct ($parentPluginName)
	fetch ($args, $request)
	getDescription ()
	getDisplayName ()
	getEnabled ()
	getHideManagement ()
	getName ()
	getPLNPlugin ()
	getPluginPath ()
	getTemplatePath ($inCore=false)
Public Member Functions inherited from GatewayPlugin
	getCanDisable ()
	getCanEnable ()
	getCurrentContextId ()
	getPolicies ($request)
	setEnabled ($enabled)
Public Member Functions inherited from Plugin
	__construct ()
	_overridePluginTemplates ($hookName, $args)
	addLocaleData ($locale=null)
	getActions ($request, $actionArgs)
	getCategory ()
	getContextSpecificPluginSettingsFile ()
	getCurrentVersion ()
	getDirName ()
	getInstallControlledVocabFiles ()
	getInstallDataFile ()
	getInstallEmailTemplateDataFile ()
	getInstallEmailTemplatesFile ()
	getInstallFilterConfigFiles ()
	getInstallMigration ()
	getInstallSchemaFile ()
	getInstallSitePluginSettingsFile ()
	getLocaleFilename ($locale)
&	getRequest ()
	getSeq ()
	getSetting ($contextId, $name)
	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)

Data Fields
	$parentPluginName
Data Fields inherited from Plugin
	$pluginCategory
	$pluginPath
	$request

Additional Inherited Members
Protected Member Functions inherited from Plugin
	_registerTemplateResource ($inCore=false)

Detailed Description

Gateway component of web PLN plugin.

Definition at line 24 of file PLNGatewayPlugin.inc.php.

Constructor & Destructor Documentation

__construct()

PLNGatewayPlugin::__construct

(

$parentPluginName

)

Constructor.

Parameters

$parentPluginName

string

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

References $parentPluginName.

Member Function Documentation

fetch()

PLNGatewayPlugin::fetch	(		$args,
			$request
	)

Handle fetch requests for this plugin.

Parameters

$args	array
$request	object

Reimplemented from GatewayPlugin.

Definition at line 108 of file PLNGatewayPlugin.inc.php.

References $application, Plugin\$request, PKPApplication\getApplication(), DAORegistry\getDAO(), PKPTemplateManager\getManager(), getPLNPlugin(), getPluginPath(), and Config\getVar().

getDescription()

PLNGatewayPlugin::getDescription

(

)

Get a description of this plugin.

Returns

string

Reimplemented from Plugin.

Definition at line 65 of file PLNGatewayPlugin.inc.php.

getDisplayName()

PLNGatewayPlugin::getDisplayName

(

)

Get the display name for this plugin.

Returns

string

Reimplemented from Plugin.

Definition at line 58 of file PLNGatewayPlugin.inc.php.

getEnabled()

PLNGatewayPlugin::getEnabled

(

)

Get whether or not this plugin is enabled. (Should always return true, as the parent plugin will take care of loading this one when needed)

Returns

boolean

Reimplemented from GatewayPlugin.

Definition at line 100 of file PLNGatewayPlugin.inc.php.

References getPLNPlugin().

getHideManagement()

PLNGatewayPlugin::getHideManagement

(

)

Hide this plugin from the management interface (it's subsidiary)

Returns

boolean

Reimplemented from Plugin.

Definition at line 44 of file PLNGatewayPlugin.inc.php.

getName()

PLNGatewayPlugin::getName

(

)

Protected methods (may be overridden by custom plugins) Get the name of this plugin. The name must be unique within its category, and should be suitable for part of a filename (ie short, no spaces, and no dependencies on cases being unique).

Returns

string name of plugin

Reimplemented from Plugin.

Definition at line 51 of file PLNGatewayPlugin.inc.php.

getPLNPlugin()

PLNGatewayPlugin::getPLNPlugin

(

)

Get the PLN plugin

Returns

object

Definition at line 73 of file PLNGatewayPlugin.inc.php.

References PluginRegistry\getPlugin().

Referenced by fetch(), getEnabled(), getPluginPath(), and getTemplatePath().

getPluginPath()

PLNGatewayPlugin::getPluginPath

(

)

Override the builtin to get the correct plugin path.

Returns

string

Reimplemented from Plugin.

Definition at line 81 of file PLNGatewayPlugin.inc.php.

References getPLNPlugin().

Referenced by fetch().

getTemplatePath()

PLNGatewayPlugin::getTemplatePath

(

$inCore = false

)

Override the builtin to get the correct template path.

Returns

string

Reimplemented from Plugin.

Definition at line 90 of file PLNGatewayPlugin.inc.php.

References getPLNPlugin().

Field Documentation

$parentPluginName

$parentPluginName PLNGatewayPlugin::$parentPluginName

string Name of parent plugin

Definition at line 29 of file PLNGatewayPlugin.inc.php.

Referenced by __construct().

---

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

• PLNGatewayPlugin.inc.php