PHP Class CounterHandler, ojs

Inheritance: extends Handler
Show file Open project: pkp/ojs Class Usage Examples

Public Properties

Property Type Description
$plugin Plugin associated with this request *

Public Methods

Method Description
__construct ( ) Constructor
_arrangeEntries ( $entries, $begin, $end ) : array Internal function to collect structures for output
_assignTemplateCounterXML ( $templateManager, $begin, $end = '' ) Internal function to assign information for the Counter part of a report
_formColumns ( &$cols, $entries ) Internal function to form some of the CSV columns
index ( $args, $request ) Display the main log analyzer page.
report ( $args, $request ) Counter report as CSV
reportXML ( $args, $request ) Counter report in XML
sushiXML ( $args, $request ) SUSHI report
validate ( $canRedirect = true ) Validate that user has site admin privileges or journal manager privileges.

Method Details

__construct() public method

Constructor
public __construct ( )

_arrangeEntries() public method

Internal function to collect structures for output
public _arrangeEntries ( $entries, $begin, $end ) : array
$entries
$begin
$end
return array

_assignTemplateCounterXML() public method

Internal function to assign information for the Counter part of a report
public _assignTemplateCounterXML ( $templateManager, $begin, $end = '' )

_formColumns() public method

Internal function to form some of the CSV columns
public _formColumns ( &$cols, $entries )

index() public method

Display the main log analyzer page.
public index ( $args, $request )

report() public method

Counter report as CSV
public report ( $args, $request )

reportXML() public method

Counter report in XML
public reportXML ( $args, $request )

sushiXML() public method

SUSHI report
public sushiXML ( $args, $request )

validate() public method

Redirects to the user index page if not properly authenticated.
public validate ( $canRedirect = true )
$canRedirect boolean Whether or not to redirect if the user cannot be validated; if not, the script simply terminates.

Property Details

$plugin public property

Plugin associated with this request *
public $plugin