Inheritance diagram for PKPToolsHandler:

Public Member Functions
	__construct ()

	generateReport ($args, $request)

	importexport ($args, $request)

	index ($args, $request)

	permissions ($args, $request)

	report ($args, $request)

	reportGenerator ($args, $request)

	resetPermissions ($args, $request)

	saveStatisticsSettings ($args, $request)

	setupTemplate ($request)

	statistics ($args, $request)

	tools ($args, $request)

Public Member Functions inherited from ManagementHandler
	access ($args, $request)

	announcements ($args, $request)

	authorize ($request, &$args, $roleAssignments)

	context ($args, $request)

	distribution ($args, $request)

	initialize ($request)

	settings ($args, $request)

	website ($args, $request)

	workflow ($args, $request)

Public Member Functions inherited from PKPHandler
	addPolicy ($authorizationPolicy, $addToTop=false)

	addRoleAssignment ($roleIds, $operations)

	getApiToken ()

&	getAuthorizedContext ()

&	getAuthorizedContextObject ($assocType)

&	getDispatcher ()

	getFirstUserContext ($user, $contexts)

	getId ()

	getLastAuthorizationMessage ()

	getRoleAssignment ($roleId)

	getRoleAssignments ()

	getSiteRedirectContext ($request)

	getTargetContext ($request, &$contextsCount=null)

	markRoleAssignmentsChecked ()

	requireSSL ()

	setApiToken ($apiToken)

	setDispatcher ($dispatcher)

	setEnforceRestrictedSite ($enforceRestrictedSite)

	setId ($id)

	validate ($requiredContexts=null, $request=null)

Data Fields
	$_isBackendPage = true

Data Fields inherited from ManagementHandler
	$_isBackendPage = true

Data Fields inherited from PKPHandler
	$_authorizationDecisionManager

	$_checks = array()

	$_dispatcher

	$_enforceRestrictedSite = true

	$_id

	$_isBackendPage = false

	$_roleAssignments = array()

	$_roleAssignmentsChecked = false

Protected Member Functions
	getObjectTitle ($assocId, $assocType)

	getReportRowValue ($key, $record)

	hasAppStatsSettings ()

Additional Inherited Members
Static Public Member Functions inherited from PKPHandler
static	getPageParamName ($rangeName)

static	getRangeInfo ($request, $rangeName, $contextData=null)

static	hashPageContext ($request, $contextData=array())

Protected Attributes inherited from PKPHandler
	$_apiToken = null

Detailed Description

Handle requests for Tool pages.

Definition at line 21 of file PKPToolsHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

PKPToolsHandler::__construct ( )

Constructor.

Reimplemented from PKPHandler.

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

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ generateReport()

PKPToolsHandler::generateReport	(	$args,
		$request
	)

Generate statistics reports from passed request arguments.

Parameters

$args	array
$request	PKPRequest

Definition at line 197 of file PKPToolsHandler.inc.php.

References Application\getContextAssocType(), getObjectTitle(), getReportRowValue(), AppLocale\requireComponents(), and setupTemplate().

Referenced by tools().

◆ getObjectTitle()

PKPToolsHandler::getObjectTitle	(	$assocId,
		$assocType
	)

protected

Get data object title based on passed assoc type and id.

Parameters

$assocId	int
$assocType	int

Returns: string

Definition at line 390 of file PKPToolsHandler.inc.php.

References Application\getContextAssocType(), Application\getContextDAO(), DAORegistry\getDAO(), and Application\getSectionDAO().

Referenced by generateReport().

◆ getReportRowValue()

PKPToolsHandler::getReportRowValue	(	$key,
		$record
	)

protected

Get the row value based on the column key (usually assoc types) and the current record.

Parameters

$key	string\|int
$record	array

Returns: string

Definition at line 379 of file PKPToolsHandler.inc.php.

Referenced by generateReport().

◆ hasAppStatsSettings()

PKPToolsHandler::hasAppStatsSettings ( )

protected

Override and return true if application has more statistics settings than the defined in library.

Returns: boolean

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

Referenced by statistics().

◆ importexport()

PKPToolsHandler::importexport	(	$args,
		$request
	)

Import or export data.

Parameters

$args	array
$request	PKPRequest

Definition at line 99 of file PKPToolsHandler.inc.php.

References PKPTemplateManager\getManager(), PluginRegistry\getPlugin(), PluginRegistry\getPlugins(), PluginRegistry\loadCategory(), and setupTemplate().

◆ index()

PKPToolsHandler::index	(	$args,
		$request
	)

Display tools index page.

Parameters

$request	PKPRequest
$args	array

Reimplemented from PKPHandler.

Definition at line 87 of file PKPToolsHandler.inc.php.

References PKPTemplateManager\getManager(), and setupTemplate().

Referenced by tools().

◆ permissions()

PKPToolsHandler::permissions	(	$args,
		$request
	)

Display the permissipns area.

Parameters

$args	array
$request	PKPRequest

Definition at line 431 of file PKPToolsHandler.inc.php.

References PKPTemplateManager\getManager(), and setupTemplate().

Referenced by tools().

◆ report()

PKPToolsHandler::report	(	$args,
		$request
	)

Delegates to plugins operations related to report generation.

Parameters

$args	array
$request	Request

Definition at line 148 of file PKPToolsHandler.inc.php.

References PluginRegistry\loadCategory(), and setupTemplate().

Referenced by tools().

◆ reportGenerator()

PKPToolsHandler::reportGenerator	(	$args,
		$request
	)

Display page to generate custom reports.

Parameters

$args	array
$request	Request

Definition at line 167 of file PKPToolsHandler.inc.php.

References PKPTemplateManager\getManager(), AppLocale\requireComponents(), and setupTemplate().

Referenced by tools().

◆ resetPermissions()

PKPToolsHandler::resetPermissions	(	$args,
		$request
	)

Reset article/monograph permissions

Parameters

$args	array
$request	PKPRequest

Definition at line 444 of file PKPToolsHandler.inc.php.

References PKPNotificationOperationManager\createTrivialNotification(), and DAORegistry\getDAO().

Referenced by tools().

◆ saveStatisticsSettings()

PKPToolsHandler::saveStatisticsSettings	(	$args,
		$request
	)

Save statistics settings.

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 354 of file PKPToolsHandler.inc.php.

Referenced by tools().

◆ setupTemplate()

PKPToolsHandler::setupTemplate ( $request )

Set up the basic template.

Parameters

$request PKPRequest

Reimplemented from PKPHandler.

Definition at line 41 of file PKPToolsHandler.inc.php.

References AppLocale\requireComponents().

Referenced by generateReport(), importexport(), index(), permissions(), report(), reportGenerator(), and statistics().

◆ statistics()

PKPToolsHandler::statistics	(	$args,
		$request
	)

Display the statistics area.

Parameters

$args	array
$request	PKPRequest

Definition at line 119 of file PKPToolsHandler.inc.php.

References $application, PKPApplication\get(), PKPTemplateManager\getManager(), hasAppStatsSettings(), PluginRegistry\loadCategory(), and setupTemplate().

Referenced by tools().

◆ tools()

PKPToolsHandler::tools	(	$args,
		$request
	)

Route to other Tools operations

Parameters

$args	array
$request	PKPRequest

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

References generateReport(), index(), permissions(), report(), reportGenerator(), resetPermissions(), saveStatisticsSettings(), and statistics().

Field Documentation

◆ $_isBackendPage

PKPToolsHandler::$_isBackendPage = true

Definition at line 24 of file PKPToolsHandler.inc.php.

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

PKPToolsHandler.inc.php

Public Member Functions

Data Fields

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ generateReport()

◆ getObjectTitle()

◆ getReportRowValue()

◆ hasAppStatsSettings()

◆ importexport()

◆ index()

◆ permissions()

◆ report()

◆ reportGenerator()

◆ resetPermissions()

◆ saveStatisticsSettings()

◆ setupTemplate()

◆ statistics()

◆ tools()

Field Documentation

◆ $_isBackendPage