• Home
  • PKPToolsHandler

PHP Class PKPToolsHandler, pkp-lib

Inheritance: extends ManagementHandler
Show file Open project: pkp/pkp-lib Class Usage Examples

Public Methods

Method Description
__construct ( ) Constructor.
generateReport ( $args, $request ) Generate statistics reports from passed request arguments.
importexport ( $args, $request ) Import or export data.
index ( $args, $request ) Display tools index page.
report ( $args, $request ) Delegates to plugins operations related to report generation.
reportGenerator ( $args, $request ) Display page to generate custom reports.
saveStatisticsSettings ( $args, $request ) : JSONMessage Save statistics settings.
setupTemplate ( $request )
statistics ( $args, $request ) Display the statistics area.
tools ( $args, $request ) Route to other Tools operations

Protected Methods

Method Description
getObjectTitle ( $assocId, $assocType ) : string Get data object title based on passed assoc type and id.
getReportRowValue ( $key, $record ) : string Get the row value based on the column key (usually assoc types) and the current record.
hasAppStatsSettings ( ) : boolean Override and return true if application has more statistics settings than the defined in library.

Method Details

__construct() public method

Constructor.
public __construct ( )

generateReport() public method

Generate statistics reports from passed request arguments.
public generateReport ( $args, $request )
$args array
$request PKPRequest

getObjectTitle() protected method

Get data object title based on passed assoc type and id.
protected getObjectTitle ( $assocId, $assocType ) : string
$assocId int
$assocType int
return string

getReportRowValue() protected method

Get the row value based on the column key (usually assoc types) and the current record.
protected getReportRowValue ( $key, $record ) : string
$key string|int
$record array
return string

hasAppStatsSettings() protected method

Override and return true if application has more statistics settings than the defined in library.
protected hasAppStatsSettings ( ) : boolean
return boolean

importexport() public method

Import or export data.
public importexport ( $args, $request )
$args array
$request PKPRequest

index() public method

Display tools index page.
public index ( $args, $request )
$args array
$request PKPRequest

report() public method

Delegates to plugins operations related to report generation.
public report ( $args, $request )
$args array
$request Request

reportGenerator() public method

Display page to generate custom reports.
public reportGenerator ( $args, $request )
$args array
$request Request

saveStatisticsSettings() public method

Save statistics settings.
public saveStatisticsSettings ( $args, $request ) : JSONMessage
$args array
$request PKPRequest
return JSONMessage JSON object

setupTemplate() public method

public setupTemplate ( $request )

statistics() public method

Display the statistics area.
public statistics ( $args, $request )
$args array
$request PKPRequest

tools() public method

Route to other Tools operations
public tools ( $args, $request )
$args array
$request PKPRequest