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

Public Member Functions

 _writeUsageEventInLogFile ($usageEvent)
 
 callbackLoadCategory ($hookName, $args)
 
 callbackParseCronTab ($hookName, $args)
 
 getDescription ()
 
 getDisplayName ()
 
 getFilesPath ()
 
getGeoLocationTool ()
 
 getInstallSchemaFile ()
 
 getInstallSitePluginSettingsFile ()
 
 getManagementVerbs ()
 
 getTemplatePath ()
 
 getUsageEventCurrentDayLogName ()
 
 getUsageEventLogsPath ()
 
 isSitePlugin ()
 
 logUsageEvent ($hookName, $args)
 
 manage ($verb, $args, &$message, &$messageParams)
 
 register ($category, $path)
 
 UsageStatsPlugin ()
 
- 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 statistics to data objects.

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

Member Function Documentation

UsageStatsPlugin::_writeUsageEventInLogFile (   $usageEvent)
Parameters
$usageEventarray

Definition at line 271 of file UsageStatsPlugin.inc.php.

References getUsageEventCurrentDayLogName(), and getUsageEventLogsPath().

Referenced by logUsageEvent().

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

Definition at line 183 of file UsageStatsPlugin.inc.php.

References PKPPlugin\getPluginPath().

UsageStatsPlugin::getDescription ( )
See Also
PKPPlugin::getDescription()

Definition at line 72 of file UsageStatsPlugin.inc.php.

UsageStatsPlugin::getDisplayName ( )
See Also
PKPPlugin::getDisplayName()

Definition at line 65 of file UsageStatsPlugin.inc.php.

UsageStatsPlugin::getFilesPath ( )

Get the plugin's files path.

Returns
string

Definition at line 241 of file UsageStatsPlugin.inc.php.

Referenced by getUsageEventLogsPath().

& UsageStatsPlugin::getGeoLocationTool ( )

Get the geolocation tool to process geo localization data.

Returns
GeoLocationTool

Definition at line 227 of file UsageStatsPlugin.inc.php.

UsageStatsPlugin::getInstallSchemaFile ( )
UsageStatsPlugin::getInstallSitePluginSettingsFile ( )
UsageStatsPlugin::getManagementVerbs ( )
UsageStatsPlugin::getTemplatePath ( )
See Also
PKPPlugin::getTemplatePath()

Definition at line 100 of file UsageStatsPlugin.inc.php.

UsageStatsPlugin::getUsageEventCurrentDayLogName ( )

Get current day usage event log name.

Returns
string

Definition at line 260 of file UsageStatsPlugin.inc.php.

Referenced by _writeUsageEventInLogFile().

UsageStatsPlugin::getUsageEventLogsPath ( )

Get the plugin's usage event logs path.

Returns
string

Definition at line 252 of file UsageStatsPlugin.inc.php.

References getFilesPath().

Referenced by _writeUsageEventInLogFile().

UsageStatsPlugin::isSitePlugin ( )
See Also
PKPPlugin::isSitePlugin()

Definition at line 79 of file UsageStatsPlugin.inc.php.

UsageStatsPlugin::logUsageEvent (   $hookName,
  $args 
)

Log the usage event into a file.

Parameters
$hookNamestring
$argsarray
Returns
boolean

Definition at line 196 of file UsageStatsPlugin.inc.php.

References _writeUsageEventInLogFile().

UsageStatsPlugin::manage (   $verb,
  $args,
$message,
$messageParams 
)
See Also
PKPPlugin::manage()

Definition at line 107 of file UsageStatsPlugin.inc.php.

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

Definition at line 42 of file UsageStatsPlugin.inc.php.

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

UsageStatsPlugin::UsageStatsPlugin ( )

Constructor.

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


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