ResolverPlugin Class Reference

Inheritance diagram for ResolverPlugin:

Public Member Functions
	exportHoldings ()
	fetch ($args, $request)
	getContextSpecificPluginSettingsFile ()
	getDescription ()
	getDisplayName ()
	getName ()
	register ($category, $path, $mainContextId=null)
	sanitize ($string)
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 ()
	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 resolver gateway plugin.

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

Member Function Documentation

exportHoldings()

ResolverPlugin::exportHoldings

(

)

Definition at line 131 of file ResolverPlugin.inc.php.

References Plugin\$request, PKPApplication\get(), DAORegistry\getDAO(), and sanitize().

fetch()

ResolverPlugin::fetch	(		$args,
			$request
	)

Handle fetch requests for this plugin.

Reimplemented from GatewayPlugin.

Definition at line 57 of file ResolverPlugin.inc.php.

References Plugin\$request, PKPServices\get(), DAORegistry\getDAO(), GatewayPlugin\getEnabled(), PKPTemplateManager\getManager(), PKPString\regexp_match_get(), and AppLocale\requireComponents().

getContextSpecificPluginSettingsFile()

ResolverPlugin::getContextSpecificPluginSettingsFile

(

)

Get the name of the settings file to be installed on new journal creation.

Returns

string

Reimplemented from Plugin.

Definition at line 33 of file ResolverPlugin.inc.php.

References Plugin\getPluginPath().

getDescription()

ResolverPlugin::getDescription

(

)

Get a description of this plugin.

Returns

string

Reimplemented from Plugin.

Definition at line 50 of file ResolverPlugin.inc.php.

getDisplayName()

ResolverPlugin::getDisplayName

(

)

Get the display name for this plugin.

Returns

string

Reimplemented from Plugin.

Definition at line 46 of file ResolverPlugin.inc.php.

getName()

ResolverPlugin::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 42 of file ResolverPlugin.inc.php.

register()

ResolverPlugin::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 22 of file ResolverPlugin.inc.php.

References Plugin\addLocaleData().

sanitize()

ResolverPlugin::sanitize

(

$string

)

Definition at line 127 of file ResolverPlugin.inc.php.

Referenced by exportHoldings().

---

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

• ResolverPlugin.inc.php