Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
PiwikPlugin Class Reference
Inheritance diagram for PiwikPlugin:

Public Member Functions

 getEnabled ()
 getManagementVerbs ()
 getName ()
 insertFooter ($hookName, $params)
 manage ($verb, $args)
 register ($category, $path)
 setBreadcrumbs ($isSubclass=false)
 setEnabled ($enabled)
 smartyPluginUrl ($params, &$smarty)
- Public Member Functions inherited from GenericPlugin
 GenericPlugin ()
 getManagementVerbs ($verbs=array())
 manage ($verb, $args, &$message, &$messageParams)
- Public Member Functions inherited from LazyLoadPlugin
 getEnabled ()
 getName ()
 LazyLoadPlugin ()
 register ($category, $path)
 setEnabled ($enabled)
- Public Member Functions inherited from Plugin
 getContextSpecificPluginSettingsFile ()
 getNewJournalPluginSettingsFile ()
 getSetting ($journalId, $name)
 Plugin ()
 updateSetting ($journalId, $name, $value, $type=null)
- Public Member Functions inherited from PKPPlugin
 _getContextSpecificInstallationHook ()
 addHelpData ($locale=null)
 addLocaleData ($locale=null)
 getCategory ()
 getContextSpecificPluginSettingsFile ()
 getContextSpecificSetting ($context, $name)
 getCurrentVersion ()
 getDescription ()
 getDisplayName ()
 getHelpMappingFilename ()
 getHideManagement ()
 getInstallDataFile ()
 getInstallEmailTemplateDataFile ()
 getInstallEmailTemplatesFile ()
 getInstallFilterConfigFiles ()
 getInstallSchemaFile ()
 getInstallSitePluginSettingsFile ()
 getLocaleFilename ($locale)
 getManagementVerbs ()
 getName ()
 getPluginPath ()
 getSeq ()
 getSettingMainContext ()
 getTemplatePath ()
 import ($class)
 installContextSpecificSettings ($hookName, $args)
 installData ($hookName, $args)
 installEmailTemplateData ($hookName, $args)
 installEmailTemplates ($hookName, $args)
 installFilters ($hookName, $args)
 installLocale ($hookName, $args)
 installSiteSettings ($hookName, $args)
 isSitePlugin ()
 manage ($verb, $args, &$message, &$messageParams, $request=null)
 PKPPlugin ()
 register ($category, $path)
 smartyPluginUrl ($params, &$smarty)
 updateContextSpecificSetting ($context, $name, $value, $type=null)
 updateSchema ($hookName, $args)

Detailed Description

Piwik plugin class.

Definition at line 19 of file

Member Function Documentation

PiwikPlugin::getEnabled ( )

Determine whether or not this plugin is enabled.

Definition at line 141 of file

References Request\getJournal(), and Plugin\getSetting().

Referenced by getManagementVerbs(), insertFooter(), manage(), and register().

PiwikPlugin::getManagementVerbs ( )

Display verbs for the management interface.

Definition at line 118 of file

References getEnabled().

PiwikPlugin::getName ( )

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).

String name of plugin

Definition at line 58 of file

Referenced by smartyPluginUrl().

PiwikPlugin::insertFooter (   $hookName,

Insert Piwik page tag to footer

Definition at line 162 of file

References getEnabled(), Request\getJournal(), and Plugin\getSetting().

PiwikPlugin::manage (   $verb,
PiwikPlugin::register (   $category,

Called as a plugin is registered to the registry

$categoryString Name of category plugin was registered to
boolean True iff plugin initialized successfully; if false, the plugin will not be registered.

Definition at line 27 of file

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

PiwikPlugin::setBreadcrumbs (   $isSubclass = false)

Set the page's breadcrumbs, given the plugin's tree of items to append.


Definition at line 95 of file

References Request\url().

PiwikPlugin::setEnabled (   $enabled)

Set the enabled/disabled state of this plugin

Definition at line 150 of file

References Request\getJournal(), and Plugin\updateSetting().

Referenced by manage().

PiwikPlugin::smartyPluginUrl (   $params,

Extend the {url ...} smarty to support this plugin.

Definition at line 73 of file

References PKPPlugin\getCategory(), and getName().

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