PiwikPlugin Class Reference

Inheritance diagram for PiwikPlugin:

Public Member Functions
	getActions ($request, $verb)
	getDescription ()
	getDisplayName ()
	manage ($args, $request)
	register ($category, $path, $mainContextId=null)
	registerScript ($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)
	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 ()
	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

Piwik plugin class.

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

Member Function Documentation

getActions()

PiwikPlugin::getActions	(		$request,
			$verb
	)

Get a list of link actions for plugin management.

Parameters

request	PKPRequest
$actionArgs	array The list of action args to be included in request URLs.

Returns

array List of LinkActions

Reimplemented from Plugin.

Definition at line 52 of file PiwikPlugin.inc.php.

References Plugin\$request, getDisplayName(), Plugin\getEnabled(), and LazyLoadPlugin\getName().

getDescription()

PiwikPlugin::getDescription

(

)

Get the plugin description.

Returns

string

Reimplemented from Plugin.

Definition at line 45 of file PiwikPlugin.inc.php.

getDisplayName()

PiwikPlugin::getDisplayName

(

)

Get the plugin display name.

Returns

string

Reimplemented from Plugin.

Definition at line 37 of file PiwikPlugin.inc.php.

Referenced by getActions().

manage()

PiwikPlugin::manage	(		$args,
			$request
	)

Perform a management function.

Parameters

$args	array
$request	PKPRequest

Returns

JSONMessage A JSON-encoded response

Reimplemented from Plugin.

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

References Plugin\$request, PKPTemplateManager\getManager(), and AppLocale\requireComponents().

register()

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

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

registerScript()

PiwikPlugin::registerScript	(		$hookName,
			$params
	)

Register the Piwik script tag

Parameters

$hookName	string
$params	array

Definition at line 104 of file PiwikPlugin.inc.php.

References Plugin\$request, PKPTemplateManager\getManager(), Plugin\getRequest(), and Plugin\getSetting().

---

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

• PiwikPlugin.inc.php