Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
PageHandler Class Reference
Inheritance diagram for PageHandler:
Handler PKPHandler

Public Member Functions

 authorize ($request, &$args, $roleAssignments)
 
 css ($args, $request)
 
 header ($args, $request)
 
 PageHandler ()
 
 sidebar ($args, $request)
 
- Public Member Functions inherited from Handler
 getSiteRedirectContext ($request)
 
 getTargetContext ($request, $bestGuess=true)
 
 getWorkingContexts ($request)
 
 Handler ()
 
- Public Member Functions inherited from PKPHandler
 addCheck (&$handlerValidator)
 
 addPolicy ($authorizationPolicy, $addToTop=false)
 
 addRoleAssignment ($roleIds, $operations)
 
 authorize ($request, &$args, $roleAssignments, $enforceRestrictedSite=true)
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
getDispatcher ()
 
 getFirstUserContext ($user, $contexts)
 
 getId ()
 
 getLastAuthorizationMessage ()
 
 getLoginExemptions ()
 
 getRoleAssignment ($roleId)
 
 getRoleAssignments ()
 
 getWorkingContexts ($request)
 
 index ($args, $request)
 
 initialize ($request, $args=null)
 
 PKPHandler ()
 
 setDispatcher ($dispatcher)
 
 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())
 
- Public Attributes inherited from PKPHandler
 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_id
 
 $_roleAssignments = array()
 

Detailed Description

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

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

Member Function Documentation

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.
$enforceRestrictedSiteboolean True iff site restrictions are to be enforced
Returns
boolean

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

References PKPHandler\addPolicy(), and Config\getVar().

PageHandler::css (   $args,
  $request 
)

Get the compiled CSS

Parameters
$argsarray
$requestPKPRequest

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

References HookRegistry\call(), and header().

PageHandler::header (   $args,
  $request 
)

Display the header.

Parameters
$argsarray
$requestPKPRequest

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

References AboutContextHandler\getAboutInfo(), Handler\getWorkingContexts(), AppLocale\requireComponents(), and PKPHandler\setupTemplate().

Referenced by css().

PageHandler::PageHandler ( )

Constructor

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

PageHandler::sidebar (   $args,
  $request 
)

Display the sidebar.

Parameters
$argsarray
$requestPKPRequest

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

References PKPHandler\setupTemplate().


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