Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
UsageEventPlugin Class Reference
Inheritance diagram for UsageEventPlugin:
GenericPlugin

Public Member Functions

 _buildUsageEvent ($hookName, $args)
 
 getDescription ()
 
 getDisplayName ()
 
 getEnabled ()
 
 getManagementVerbs ()
 
 getUniqueSiteId ()
 
 getUsageEvent ($hookName, $args)
 
 isSitePlugin ()
 
 register ($category, $path)
 
- 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

Provide usage event to other statistics plugins.

Definition at line 23 of file UsageEventPlugin.inc.php.

Member Function Documentation

UsageEventPlugin::_buildUsageEvent (   $hookName,
  $args 
)

Build an usage event.

Parameters
$hookNamestring
$argsarray
Returns
array

Definition at line 122 of file UsageEventPlugin.inc.php.

References PKPApplication\getApplication(), Core\getCurrentDate(), DAORegistry\getDAO(), getUniqueSiteId(), PluginRegistry\loadCategory(), and Plugin\updateSetting().

Referenced by getUsageEvent().

UsageEventPlugin::getDescription ( )
See Also
PKPPlugin::getDescription()

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

UsageEventPlugin::getDisplayName ( )
See Also
PKPPlugin::getDisplayName()

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

UsageEventPlugin::getEnabled ( )
See Also
LazyLoadPlugin::getEnabled()

Definition at line 64 of file UsageEventPlugin.inc.php.

UsageEventPlugin::getManagementVerbs ( )
UsageEventPlugin::getUniqueSiteId ( )

Get the unique site id.

Returns
mixed string or null

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

References Plugin\getSetting().

Referenced by _buildUsageEvent().

UsageEventPlugin::getUsageEvent (   $hookName,
  $args 
)

Get usage event and pass it to the registered plugins, if any.

Definition at line 101 of file UsageEventPlugin.inc.php.

References _buildUsageEvent(), HookRegistry\call(), and HookRegistry\getHooks().

UsageEventPlugin::isSitePlugin ( )
See Also
PKPPlugin::isSitePlugin()

Definition at line 71 of file UsageEventPlugin.inc.php.

UsageEventPlugin::register (   $category,
  $path 
)
See Also
LazyLoadPlugin::register()

Definition at line 31 of file UsageEventPlugin.inc.php.

References HookRegistry\register().


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