UsageEventPlugin Class Reference

Inheritance diagram for UsageEventPlugin:

Public Member Functions
	getEventHooks ()
Public Member Functions inherited from PKPUsageEventPlugin
	getDescription ()
	getDisplayName ()
	getEnabled ($contextId=null)
	getInstallSitePluginSettingsFile ()
	getName ()
	getUniqueSiteId ()
	getUsageEvent ($hookName, $args)
	isSitePlugin ()
	register ($category, $path, $mainContextId=null)
Public Member Functions inherited from LazyLoadPlugin
	getCanDisable ()
	getCanEnable ()
	getCurrentContextId ()
	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 ()
	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)
	manage ($args, $request)
	smartyPluginUrl ($params, $smarty)
	updateSchema ($hookName, $args)
	updateSetting ($contextId, $name, $value, $type=null)

Protected Member Functions
	getDownloadFinishedEventHooks ()
	getHtmlPageAssocTypes ()
	getUsageEventData ($hookName, $hookArgs, $request, $router, $templateMgr, $context)
	isPubIdObjectType ($pubObject)
Protected Member Functions inherited from PKPUsageEventPlugin
	buildUsageEvent ($hookName, $args)
Protected Member Functions inherited from Plugin
	_registerTemplateResource ($inCore=false)

Additional Inherited Members
Data Fields inherited from Plugin
	$pluginCategory
	$pluginPath
	$request

Detailed Description

Implement application specifics for generating usage events.

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

Member Function Documentation

getDownloadFinishedEventHooks()

UsageEventPlugin::getDownloadFinishedEventHooks ( )

protected

Get all hooks that define the finished file download.

Returns

array

Reimplemented from PKPUsageEventPlugin.

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

getEventHooks()

UsageEventPlugin::getEventHooks

(

)

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

Returns

array

Reimplemented from PKPUsageEventPlugin.

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

getHtmlPageAssocTypes()

UsageEventPlugin::getHtmlPageAssocTypes ( )

protected

See also

PKPUsageEventPlugin::getHtmlPageAssocTypes()

Reimplemented from PKPUsageEventPlugin.

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

getUsageEventData()

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

protected

Reimplemented from PKPUsageEventPlugin.

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

References $op, Plugin\$request, and DAORegistry\getDAO().

isPubIdObjectType()

UsageEventPlugin::isPubIdObjectType (   $pubObject )

protected

See also

PKPUsageEventPlugin::isPubIdObjectType()

Reimplemented from PKPUsageEventPlugin.

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

---

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

• UsageEventPlugin.inc.php