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

Public Member Functions

 authorize ($request, &$args, $roleAssignments)
 
 ContextSettingsWizardHandler ()
 
 startWizard ($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

A controller that handles basic server-side operations of the context settings wizard.

Definition at line 23 of file ContextSettingsWizardHandler.inc.php.

Member Function Documentation

ContextSettingsWizardHandler::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 43 of file ContextSettingsWizardHandler.inc.php.

References PKPHandler\addPolicy().

ContextSettingsWizardHandler::ContextSettingsWizardHandler ( )

Constructor

Definition at line 28 of file ContextSettingsWizardHandler.inc.php.

References PKPHandler\addRoleAssignment().

ContextSettingsWizardHandler::startWizard (   $args,
  $request 
)

Displays the context settings wizard.

Parameters
$argsarray
$requestRequest
Returns
string a serialized JSON object

Definition at line 59 of file ContextSettingsWizardHandler.inc.php.

References AppLocale\requireComponents(), and PKPHandler\setupTemplate().


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