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

Public Member Functions

 _writeUsageEventInLogFile ($usageEvent)
 
 callbackLoadCategory ($hookName, $args)
 
 callbackParseCronTab ($hookName, $args)
 
 getDescription ()
 
 getDisplayName ()
 
 getFilesPath ()
 
getGeoLocationTool ()
 
 getInstallSchemaFile ()
 
 getInstallSitePluginSettingsFile ()
 
 getManagementVerbLinkAction ($request, $verb)
 
 getManagementVerbs ()
 
 getTemplatePath ($inCore=false)
 
 getUsageEventCurrentDayLogName ()
 
 getUsageEventLogsPath ()
 
 isSitePlugin ()
 
 logUsageEvent ($hookName, $args)
 
 manage ($verb, $args, &$message, &$messageParams, &$pluginModalContent=null)
 
 PKPUsageStatsPlugin ()
 
 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)
 

Public Attributes

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

Detailed Description

Provide usage statistics to data objects.

Definition at line 19 of file PKPUsageStatsPlugin.inc.php.

Member Function Documentation

PKPUsageStatsPlugin::_writeUsageEventInLogFile (   $usageEvent)
Parameters
$usageEventarray

Definition at line 297 of file PKPUsageStatsPlugin.inc.php.

PKPUsageStatsPlugin::callbackLoadCategory (   $hookName,
  $args 
)
See Also
PluginRegistry::loadCategory()

Definition at line 186 of file PKPUsageStatsPlugin.inc.php.

PKPUsageStatsPlugin::callbackParseCronTab (   $hookName,
  $args 
)
See Also
AcronPlugin::parseCronTab()

Definition at line 209 of file PKPUsageStatsPlugin.inc.php.

PKPUsageStatsPlugin::getDescription ( )
See Also
PKPPlugin::getDescription()

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

PKPUsageStatsPlugin::getDisplayName ( )
See Also
PKPPlugin::getDisplayName()

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

Referenced by getManagementVerbLinkAction().

PKPUsageStatsPlugin::getFilesPath ( )

Get the plugin's files path.

Returns
string

Definition at line 267 of file PKPUsageStatsPlugin.inc.php.

& PKPUsageStatsPlugin::getGeoLocationTool ( )

Get the geolocation tool to process geo localization data.

Returns
GeoLocationTool

Definition at line 253 of file PKPUsageStatsPlugin.inc.php.

PKPUsageStatsPlugin::getInstallSchemaFile ( )
See Also
PKPPlugin::getInstallSchemaFile()

Definition at line 97 of file PKPUsageStatsPlugin.inc.php.

PKPUsageStatsPlugin::getInstallSitePluginSettingsFile ( )
See Also
PKPPlugin::getInstallSitePluginSettingsFile()

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

References Plugin\getPluginPath().

PKPUsageStatsPlugin::getManagementVerbLinkAction (   $request,
  $verb 
)
PKPUsageStatsPlugin::getManagementVerbs ( )
PKPUsageStatsPlugin::getTemplatePath (   $inCore = false)
See Also
Plugin::getTemplatePath($inCore)

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

PKPUsageStatsPlugin::getUsageEventCurrentDayLogName ( )

Get current day usage event log name.

Returns
string

Definition at line 286 of file PKPUsageStatsPlugin.inc.php.

PKPUsageStatsPlugin::getUsageEventLogsPath ( )

Get the plugin's usage event logs path.

Returns
string

Definition at line 278 of file PKPUsageStatsPlugin.inc.php.

PKPUsageStatsPlugin::isSitePlugin ( )
See Also
PKPPlugin::isSitePlugin()

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

References Plugin\getPluginPath().

PKPUsageStatsPlugin::logUsageEvent (   $hookName,
  $args 
)

Log the usage event into a file.

Parameters
$hookNamestring
$argsarray
Returns
boolean

Definition at line 222 of file PKPUsageStatsPlugin.inc.php.

References $_currentUsageEvent.

PKPUsageStatsPlugin::manage (   $verb,
  $args,
$message,
$messageParams,
$pluginModalContent = null 
)
See Also
PKPPlugin::manage()

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

PKPUsageStatsPlugin::PKPUsageStatsPlugin ( )

Constructor.

Definition at line 30 of file PKPUsageStatsPlugin.inc.php.

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

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

References Plugin\getSetting(), and HookRegistry\register().

Member Data Documentation

$_currentUsageEvent PKPUsageStatsPlugin::$_currentUsageEvent

array

Definition at line 25 of file PKPUsageStatsPlugin.inc.php.

Referenced by logUsageEvent().


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