Open Journal Systems  3.3.0
PageHandler Class Reference
Inheritance diagram for PageHandler:
Handler PKPHandler

Public Member Functions

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

Additional Inherited Members

- Static Public Member Functions inherited from PKPHandler
static getPageParamName ($rangeName)
 
static getRangeInfo ($request, $rangeName, $contextData=null)
 
static hashPageContext ($request, $contextData=array())
 
- Data Fields inherited from PKPHandler
 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_enforceRestrictedSite = true
 
 $_id
 
 $_isBackendPage = false
 
 $_roleAssignments = array()
 
 $_roleAssignmentsChecked = false
 
- Protected Attributes inherited from PKPHandler
 $_apiToken = null
 

Detailed Description

Handler for requests for page components such as the header, tasks, usernav, and CSS.

Definition at line 19 of file PageHandler.inc.php.

Member Function Documentation

◆ authorize()

PageHandler::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
$requestRequest
$argsarray request arguments
$roleAssignmentsarray the operation role assignment, see getRoleAssignment() for more details.
Returns
boolean

Reimplemented from PKPHandler.

Definition at line 27 of file PageHandler.inc.php.

References PKPHandler\addPolicy(), and PKPHandler\setEnforceRestrictedSite().

◆ css()

PageHandler::css (   $args,
  $request 
)

Get the compiled CSS

Parameters
$argsarray
$requestPKPRequest

Definition at line 60 of file PageHandler.inc.php.

References HookRegistry\call(), HookRegistry\getHooks(), PKPTemplateManager\getManager(), and PluginRegistry\loadCategory().

◆ tasks()

PageHandler::tasks (   $args,
  $request 
)

Display the tasks component

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 49 of file PageHandler.inc.php.

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


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