Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
PKPUsageEventPlugin Class Reference
Inheritance diagram for PKPUsageEventPlugin:
GenericPlugin UsageEventPlugin

Public Member Functions

 getDescription ()
 
 getDisplayName ()
 
 getEnabled ()
 
 getInstallSitePluginSettingsFile ()
 
 getManagementVerbs ()
 
 getName ()
 
 getUniqueSiteId ()
 
 getUsageEvent ($hookName, $args)
 
 isSitePlugin ()
 
 register ($category, $path)
 
- Public Member Functions inherited from GenericPlugin
 GenericPlugin ()
 
 getManagementVerbs ()
 
 manage ($verb, $args, &$message, &$messageParams, &$pluginModalContent=null)
 
- Public Member Functions inherited from LazyLoadPlugin
 getEnabled ()
 
 getName ()
 
 LazyLoadPlugin ()
 
 register ($category, $path)
 
 setEnabled ($enabled)
 
- Public Member Functions inherited from Plugin
 _getContextSpecificInstallationHook ()
 
 addLocaleData ($locale=null)
 
 getCategory ()
 
 getContextSpecificPluginSettingsFile ()
 
 getContextSpecificSetting ($context, $name)
 
 getCurrentVersion ()
 
 getDescription ()
 
 getDisplayName ()
 
 getHideManagement ()
 
 getInstallDataFile ()
 
 getInstallEmailTemplateDataFile ()
 
 getInstallEmailTemplatesFile ()
 
 getInstallFilterConfigFiles ()
 
 getInstallSchemaFile ()
 
 getInstallSitePluginSettingsFile ()
 
 getLocaleFilename ($locale)
 
 getManagementVerbLinkAction ($request, $verb)
 
 getManagementVerbs ()
 
 getName ()
 
 getPluginPath ()
 
getRequest ()
 
 getSeq ()
 
 getSetting ($contextId, $name)
 
 getSettingMainContext ()
 
 getTemplatePath ($inCore=false)
 
 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, &$pluginModalContent=null)
 
 Plugin ()
 
 register ($category, $path)
 
 smartyPluginUrl ($params, &$smarty)
 
 updateContextSpecificSetting ($context, $name, $value, $type=null)
 
 updateSchema ($hookName, $args)
 
 updateSetting ($contextId, $name, $value, $type=null)
 

Protected Member Functions

 buildUsageEvent ($hookName, $args)
 
 getEventHooks ()
 
 getHtmlPageAssocTypes ()
 
 getUsageEventData ($hookName, $hookArgs, $request, $router, $templateMgr, $context)
 
 isPubIdObjectType ($pubObject)
 

Additional Inherited Members

- Public Attributes inherited from Plugin
 $pluginCategory
 
 $pluginPath
 
 $request
 

Detailed Description

Base class for usage event plugin. Provide usage events to other statistics plugins.

Definition at line 24 of file PKPUsageEventPlugin.inc.php.

Member Function Documentation

PKPUsageEventPlugin::buildUsageEvent (   $hookName,
  $args 
)
protected
PKPUsageEventPlugin::getDescription ( )
See Also
Plugin::getDescription()

Definition at line 69 of file PKPUsageEventPlugin.inc.php.

PKPUsageEventPlugin::getDisplayName ( )
See Also
Plugin::getDisplayName()

Definition at line 62 of file PKPUsageEventPlugin.inc.php.

PKPUsageEventPlugin::getEnabled ( )
See Also
LazyLoadPlugin::getEnabled()

Definition at line 76 of file PKPUsageEventPlugin.inc.php.

PKPUsageEventPlugin::getEventHooks ( )
protected

Get all hooks that must be used to generate usage events.

Returns
array

Definition at line 133 of file PKPUsageEventPlugin.inc.php.

Referenced by register().

PKPUsageEventPlugin::getHtmlPageAssocTypes ( )
abstractprotected

Get all assoc types that have their usage event produced by html page access.

Returns
array

Referenced by buildUsageEvent().

PKPUsageEventPlugin::getInstallSitePluginSettingsFile ( )
PKPUsageEventPlugin::getManagementVerbs ( )
PKPUsageEventPlugin::getName ( )
See Also
LazyLoadPlugin::getName()

Definition at line 48 of file PKPUsageEventPlugin.inc.php.

PKPUsageEventPlugin::getUniqueSiteId ( )

Get the unique site id.

Returns
mixed string or null

Definition at line 102 of file PKPUsageEventPlugin.inc.php.

References Plugin\getSetting().

Referenced by buildUsageEvent().

PKPUsageEventPlugin::getUsageEvent (   $hookName,
  $args 
)

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

Definition at line 113 of file PKPUsageEventPlugin.inc.php.

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

PKPUsageEventPlugin::getUsageEventData (   $hookName,
  $hookArgs,
  $request,
  $router,
  $templateMgr,
  $context 
)
protected

Get usage event details based on the passed hook. Subclasses should extend to implement application specifics.

Parameters
$hookNamestring
$hookArgsarray
$requestPKPRequest
$routerPageRouter
$templateMgrPKPTemplateManager
$contextContext
Returns
array With the following data: DataObject the published object, boolean download success, integer used published object assoc type, string used published object id foreign keys lookup (all parent associated objects id, preceeded with a single letter to identify the object), string canonical url page, string canonical url operation, array with canonical url parameters.
See Also
PKPUsageEventPlugin::buildUsageEvent()

Definition at line 324 of file PKPUsageEventPlugin.inc.php.

References Plugin\$request, and Application\getContextAssocType().

Referenced by buildUsageEvent().

PKPUsageEventPlugin::isPubIdObjectType (   $pubObject)
abstractprotected

Whether or not the passed object is of a type that can have different public identifiers, like DOI, URN, etc.

Parameters
$pubObjectDataObject
Returns
boolean

Referenced by buildUsageEvent().

PKPUsageEventPlugin::isSitePlugin ( )
See Also
Plugin::isSitePlugin()

Definition at line 83 of file PKPUsageEventPlugin.inc.php.

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

Definition at line 32 of file PKPUsageEventPlugin.inc.php.

References getEventHooks(), and HookRegistry\register().


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