Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
CounterReportPlugin Class Reference
Inheritance diagram for CounterReportPlugin:
ReportPlugin Plugin PKPPlugin

Public Member Functions

 _arrangeEntries ($entries, $begin, $end)
 
 _assignTemplateCounterXML (&$templateManager, $begin, $end='', $useLegacyStats)
 
 _formColumns (&$cols, $entries)
 
 _getJournalIds ($useLegacyStats=false)
 
 _getLimitDates ($year)
 
 _getMonthlyLogRange ($journalId=null, $begin, $end, $useLegacyStats=false)
 
 _getMonthlyTotalRange ($begin, $end, $useLegacyStats=false)
 
 _getYears ($useLegacyStats=false)
 
 _report (&$request, $year, $useLegacyStats)
 
 _reportXML (&$request, $year, $useLegacyStats)
 
 _sushiXML ($useLegacyStats)
 
 display (&$args, &$request)
 
 getDescription ()
 
 getDisplayName ()
 
 getName ()
 
 isSitePlugin ()
 
 register ($category, $path)
 
 setBreadcrumbs ()
 
- Public Member Functions inherited from ReportPlugin
 display (&$args)
 
 getColumns ($metricType)
 
 getDefaultReportTemplates ($metricType)
 
 getManagementVerbs ()
 
 getMetricDisplayType ($metricType)
 
 getMetricFullName ($metricType)
 
 getMetrics ($metricType=null, $columns=array(), $filters=array(), $orderBy=array(), $range=null)
 
 getMetricTypes ()
 
 getObjectTypes ($metricType)
 
 manage ($verb, $args)
 
 setBreadcrumbs ($crumbs=array(), $isSubclass=false)
 
 smartyPluginUrl ($params, &$smarty)
 
- 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

Counter report plugin.

Definition at line 20 of file CounterReportPlugin.inc.php.

Member Function Documentation

CounterReportPlugin::_arrangeEntries (   $entries,
  $begin,
  $end 
)

Internal function to collect structures for output

Definition at line 365 of file CounterReportPlugin.inc.php.

Referenced by _assignTemplateCounterXML().

CounterReportPlugin::_assignTemplateCounterXML ( $templateManager,
  $begin,
  $end = '',
  $useLegacyStats 
)

Internal function to assign information for the Counter part of a report

Parameters
$templateManagerPKPTemplateManager
$beginstring
$endstring
$useLegacyStatsboolean

Definition at line 325 of file CounterReportPlugin.inc.php.

References _arrangeEntries(), _getJournalIds(), _getMonthlyLogRange(), DAORegistry\getDAO(), Request\getJournal(), AppLocale\getLocale(), PKPRequest\getUser(), and Config\getVar().

Referenced by _reportXML(), and _sushiXML().

CounterReportPlugin::_formColumns ( $cols,
  $entries 
)

Internal function to form some of the CSV columns

Definition at line 293 of file CounterReportPlugin.inc.php.

Referenced by _report().

CounterReportPlugin::_getJournalIds (   $useLegacyStats = false)

Get the valid journal IDs for which log entries exist in the DB.

Parameters
$useLegacyStatsboolean Use the old counter plugin data.
Returns
array

Definition at line 447 of file CounterReportPlugin.inc.php.

References DAORegistry\getDAO().

Referenced by _assignTemplateCounterXML(), and _report().

CounterReportPlugin::_getLimitDates (   $year)

Return the begin and end dates based on the passed year.

Parameters
$yearstring
Returns
array

Definition at line 410 of file CounterReportPlugin.inc.php.

Referenced by _report(), and _reportXML().

CounterReportPlugin::_getMonthlyLogRange (   $journalId = null,
  $begin,
  $end,
  $useLegacyStats = false 
)

Retrieve a monthly log entry range.

Parameters
$journalIdint
$begin
$end
$useLegacyStatsboolean Use the old counter plugin data.
Returns
2D array

Definition at line 473 of file CounterReportPlugin.inc.php.

References DAORegistry\getDAO().

Referenced by _assignTemplateCounterXML(), _getMonthlyTotalRange(), and _report().

CounterReportPlugin::_getMonthlyTotalRange (   $begin,
  $end,
  $useLegacyStats = false 
)

Retrieve a monthly log entry range.

Parameters
$begin
$end
$useLegacyStatsboolean Use the old counter plugin data.
Returns
2D array

Definition at line 513 of file CounterReportPlugin.inc.php.

References _getMonthlyLogRange().

Referenced by _report().

CounterReportPlugin::_getYears (   $useLegacyStats = false)

Get the years for which log entries exist in the DB.

Parameters
$useLegacyStatsboolean Use the old counter plugin data.
Returns
array

Definition at line 422 of file CounterReportPlugin.inc.php.

References DAORegistry\getDAO().

Referenced by display().

CounterReportPlugin::_report ( $request,
  $year,
  $useLegacyStats 
)

Generate a report file.

Parameters
$requestPKPRequest
$yearstring

Definition at line 127 of file CounterReportPlugin.inc.php.

References _formColumns(), _getJournalIds(), _getLimitDates(), _getMonthlyLogRange(), _getMonthlyTotalRange(), String\fputcsv(), and DAORegistry\getDAO().

Referenced by display().

CounterReportPlugin::_reportXML ( $request,
  $year,
  $useLegacyStats 
)

Counter report in XML

Parameters
$requestPKPRequest
$yearstring
$useLegacyStatsboolean

Definition at line 200 of file CounterReportPlugin.inc.php.

References _assignTemplateCounterXML(), _getLimitDates(), and PKPPlugin\getTemplatePath().

CounterReportPlugin::_sushiXML (   $useLegacyStats)

SUSHI report

Parameters
$useLegacyStatsboolean

Definition at line 212 of file CounterReportPlugin.inc.php.

References _assignTemplateCounterXML(), and PKPPlugin\getTemplatePath().

Referenced by display().

CounterReportPlugin::display ( $args,
$request 
)
CounterReportPlugin::getDescription ( )
See Also
PKPPlugin::getDescription()

Definition at line 51 of file CounterReportPlugin.inc.php.

CounterReportPlugin::getDisplayName ( )
See Also
PKPPlugin::getDisplayName()

Definition at line 44 of file CounterReportPlugin.inc.php.

CounterReportPlugin::getName ( )
See Also
PKPPlugin::getName()

Definition at line 37 of file CounterReportPlugin.inc.php.

CounterReportPlugin::isSitePlugin ( )
See Also
PKPPlugin::isSitePlugin()

Definition at line 58 of file CounterReportPlugin.inc.php.

CounterReportPlugin::register (   $category,
  $path 
)
See Also
PKPPlugin::register($category, $path)

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

References PKPPlugin\addLocaleData().

CounterReportPlugin::setBreadcrumbs ( )
See Also
ReportPlugin::setBreadcrumbs()

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

References Request\url().

Referenced by display().


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