DashboardHandler Class Reference

Inheritance diagram for DashboardHandler:

Public Member Functions
	__construct ()
	authorize ($request, &$args, $roleAssignments)
	index ($args, $request)
	setupTemplate ($request=null)
	tasks ($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)
	initialize ($request)
	markRoleAssignmentsChecked ()
	requireSSL ()
	setApiToken ($apiToken)
	setDispatcher ($dispatcher)
	setEnforceRestrictedSite ($enforceRestrictedSite)
	setId ($id)
	validate ($requiredContexts=null, $request=null)

Data Fields
	$_isBackendPage = true
Data Fields inherited from PKPHandler
	$_authorizationDecisionManager
	$_checks = array()
	$_dispatcher
	$_enforceRestrictedSite = true
	$_id
	$_isBackendPage = false
	$_roleAssignments = array()
	$_roleAssignmentsChecked = false

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 user's dashboard.

Definition at line 22 of file DashboardHandler.inc.php.

Constructor & Destructor Documentation

__construct()

DashboardHandler::__construct

(

)

Constructor

Reimplemented from PKPHandler.

Definition at line 30 of file DashboardHandler.inc.php.

References PKPHandler\addRoleAssignment().

Member Function Documentation

authorize()

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

Authorize this request.

Routers will call this method automatically thereby enforcing authorization. This method will be called before the validate() method and before passing control on to the handler operation.

NB: This method will be called once for every request only.

Parameters

$request	Request
$args	array request arguments
$roleAssignments	array the operation role assignment, see getRoleAssignment() for more details.

Returns

boolean

Reimplemented from PKPHandler.

Definition at line 40 of file DashboardHandler.inc.php.

References PKPHandler\addPolicy().

index()

DashboardHandler::index	(		$args,
			$request
	)

Display about index page.

Parameters

$request	PKPRequest
$args	array

Reimplemented from PKPHandler.

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

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

setupTemplate()

DashboardHandler::setupTemplate

(

$request = null

)

Setup common template variables.

Parameters

$request

PKPRequest

Reimplemented from PKPHandler.

Definition at line 194 of file DashboardHandler.inc.php.

References AppLocale\requireComponents().

Referenced by index(), and tasks().

tasks()

DashboardHandler::tasks	(		$args,
			$request
	)

View tasks tab

Parameters

$args	array
$request	PKPRequest

Returns

JSONMessage JSON object

Definition at line 183 of file DashboardHandler.inc.php.

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

Field Documentation

$_isBackendPage

DashboardHandler::$_isBackendPage = true

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

---

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

• DashboardHandler.inc.php