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

Public Member Functions

 AdminHandler ()
 
 authorize ($request, &$args, $roleAssignments)
 
 index ($args, $request)
 
 initialize ($request, $args=null)
 
 settings ($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

Handle requests for site administration functions.

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

Member Function Documentation

AdminHandler::AdminHandler ( )

Constructor

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

References PKPHandler\addRoleAssignment().

AdminHandler::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 34 of file AdminHandler.inc.php.

References PKPHandler\addPolicy(), and Application\getContextDAO().

AdminHandler::index (   $args,
  $request 
)

Display site admin index page.

Parameters
$argsarray
$requestPKPRequest

Definition at line 63 of file AdminHandler.inc.php.

References Handler\getWorkingContexts().

AdminHandler::initialize (   $request,
  $args = null 
)

Initialize the handler.

Parameters
$requestPKPRequest
$argsarray

Definition at line 85 of file AdminHandler.inc.php.

References AppLocale\requireComponents().

AdminHandler::settings (   $args,
  $request 
)

Display the administration settings page.

Parameters
$argsarray
$requestPKPRequest

Definition at line 75 of file AdminHandler.inc.php.


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