LegacyJR1 Class Reference

Public Member Functions
	_arrangeEntries ($entries)
	_assignTemplateCounterXML ($request, $templateManager, $begin, $end='', $useLegacyStats)
	_formColumns (&$cols, $entries)
	_getJournalIds ($useLegacyStats=false)
	_getLimitDates ($year)
	_getMonthlyLogRange ($journalId=null, $begin, $end, $useLegacyStats=false)
	_getMonthlyTotalRange ($begin, $end, $useLegacyStats=false)
	_report ($request, $year, $useLegacyStats)
	_reportXML ($request, $year, $useLegacyStats)
	display ($request)
	LegacyJR1 ($plugin)

Data Fields
	$_plugin

Detailed Description

The Legacy COUNTER JR1 (r3) report.

Definition at line 15 of file LegacyJR1.inc.php.

Member Function Documentation

_arrangeEntries()

LegacyJR1::_arrangeEntries

(

$entries

)

Internal function to collect structures for output

Parameters

$entries

array()

Definition at line 219 of file LegacyJR1.inc.php.

Referenced by _assignTemplateCounterXML().

_assignTemplateCounterXML()

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

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

Parameters

$request	PKPRequest
$templateManager	PKPTemplateManager
$begin	string
$end	string
$useLegacyStats	boolean

Definition at line 164 of file LegacyJR1.inc.php.

References _arrangeEntries(), _getJournalIds(), _getMonthlyLogRange(), DAORegistry\getDAO(), and Config\getVar().

Referenced by _reportXML().

_formColumns()

LegacyJR1::_formColumns	(	&	$cols,
			$entries
	)

Internal function to form some of the CSV columns

Parameters

$cols	array() by reference
$entries	array() $cols will be modified

Definition at line 129 of file LegacyJR1.inc.php.

Referenced by _report().

_getJournalIds()

LegacyJR1::_getJournalIds

(

$useLegacyStats = false

)

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

Parameters

$useLegacyStats

boolean Use the old counter plugin data.

Returns

array

Definition at line 282 of file LegacyJR1.inc.php.

References DAORegistry\getDAO().

Referenced by _assignTemplateCounterXML(), and _report().

_getLimitDates()

LegacyJR1::_getLimitDates

(

$year

)

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

Parameters

$year

string

Returns

array

Definition at line 270 of file LegacyJR1.inc.php.

Referenced by _report(), and _reportXML().

_getMonthlyLogRange()

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

Retrieve a monthly log entry range.

Parameters

$journalId	int
$begin
$end
$useLegacyStats	boolean Use the old counter plugin data.

Returns

2D array

Definition at line 307 of file LegacyJR1.inc.php.

References DAORegistry\getDAO().

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

_getMonthlyTotalRange()

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

Retrieve a monthly log entry range.

Parameters

$begin
$end
$useLegacyStats	boolean Use the old counter plugin data.

Returns

2D array

Definition at line 342 of file LegacyJR1.inc.php.

References _getMonthlyLogRange().

Referenced by _report().

_report()

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

Generate a report file.

Parameters

$request	PKPRequest
$year	string
$useLegacyStats	boolean Use the old counter plugin data.

Definition at line 57 of file LegacyJR1.inc.php.

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

Referenced by display().

_reportXML()

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

Counter report in XML

Parameters

$request	PKPRequest
$year	string
$useLegacyStats	boolean

Definition at line 353 of file LegacyJR1.inc.php.

References _assignTemplateCounterXML(), _getLimitDates(), and PKPTemplateManager\getManager().

display()

LegacyJR1::display

(

$request

)

Display the JR1 (R3) report

Parameters

$request

PKPRequest

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

References _report().

LegacyJR1()

LegacyJR1::LegacyJR1

(

$plugin

)

Constructor

Parameters

Plugin

$plugin

Definition at line 29 of file LegacyJR1.inc.php.

Field Documentation

$_plugin

Plugin LegacyJR1::$_plugin

The COUNTER report plugin.

Definition at line 23 of file LegacyJR1.inc.php.

---

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

• LegacyJR1.inc.php