TexturePlugin Class Reference

Inheritance diagram for TexturePlugin:

Public Member Functions
	callbackLoadHandler ($hookName, $args)
	getDescription ()
	getDisplayName ()
	getPluginUrl ($request)
	getTextureUrl ($request)
	register ($category, $path, $mainContextId=null)
	templateFetchCallback ($hookName, $params)
Public Member Functions inherited from LazyLoadPlugin
	getCanDisable ()
	getCanEnable ()
	getCurrentContextId ()
	getEnabled ($contextId=null)
	getName ()
	setEnabled ($enabled)
Public Member Functions inherited from Plugin
	__construct ()
	_overridePluginTemplates ($hookName, $args)
	addLocaleData ($locale=null)
	getActions ($request, $actionArgs)
	getCategory ()
	getContextSpecificPluginSettingsFile ()
	getCurrentVersion ()
	getDirName ()
	getEnabled ()
	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

Class TexturePlugin

Definition at line 22 of file TexturePlugin.inc.php.

Member Function Documentation

callbackLoadHandler()

TexturePlugin::callbackLoadHandler	(		$hookName,
			$args
	)

See also

PKPPageRouter::route()

Definition at line 75 of file TexturePlugin.inc.php.

References $op, LazyLoadPlugin\getName(), and Plugin\getPluginPath().

getDescription()

TexturePlugin::getDescription

(

)

Get a description of this plugin.

Returns

string

Reimplemented from Plugin.

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

getDisplayName()

TexturePlugin::getDisplayName

(

)

Get the display name for this plugin.

Returns

string

Reimplemented from Plugin.

Definition at line 26 of file TexturePlugin.inc.php.

getPluginUrl()

TexturePlugin::getPluginUrl

(

$request

)

Get plugin URL

Parameters

$request

PKPRequest

Returns

string

Definition at line 68 of file TexturePlugin.inc.php.

References Plugin\$request, and Plugin\getPluginPath().

Referenced by getTextureUrl().

getTextureUrl()

TexturePlugin::getTextureUrl

(

$request

)

Get texture editor URL

Parameters

$request

PKPRequest

Returns

string

Definition at line 59 of file TexturePlugin.inc.php.

References Plugin\$request, and getPluginUrl().

register()

TexturePlugin::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 LazyLoadPlugin.

Definition at line 40 of file TexturePlugin.inc.php.

References Plugin\_registerTemplateResource(), Plugin\getEnabled(), and HookRegistry\register().

templateFetchCallback()

TexturePlugin::templateFetchCallback	(		$hookName,
			$params
	)

Adds additional links to submission files grid row

Parameters

$hookName	string The name of the invoked hook
$params	array Hook parameters

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

References Plugin\$request, and Plugin\getRequest().

---

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

• TexturePlugin.inc.php