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

Public Member Functions

 authorize ($request, &$args, $roleAssignments)
 
 index ($args, $request)
 
 PKPSubmissionHandler ()
 
 saveStep ($args, $request)
 
 setupTemplate ($request)
 
 step ($args, $request)
 
 wizard ($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)
 

Protected Member Functions

 _canExpedite ($user, $context)
 
 _getStepCount ()
 
 _getStepsNumberAndLocaleKeys ()
 

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

Base handler for submission requests.

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

Member Function Documentation

PKPSubmissionHandler::_canExpedite (   $user,
  $context 
)
protected

Determines whether or not this user can expedite this submission.

Parameters
User$user
Context$context

Definition at line 243 of file PKPSubmissionHandler.inc.php.

References DAORegistry\getDAO().

Referenced by step().

PKPSubmissionHandler::_getStepCount ( )
protected

Get the number of submission steps.

Returns
int

Definition at line 234 of file PKPSubmissionHandler.inc.php.

Referenced by authorize(), and step().

PKPSubmissionHandler::_getStepsNumberAndLocaleKeys ( )
protected

Get the step numbers and their corresponding title locale keys.

Returns
array

Definition at line 226 of file PKPSubmissionHandler.inc.php.

Referenced by setupTemplate().

PKPSubmissionHandler::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 30 of file PKPSubmissionHandler.inc.php.

References _getStepCount(), PKPHandler\addPolicy(), and PKPHandler\getAuthorizedContextObject().

PKPSubmissionHandler::index (   $args,
  $request 
)

Redirect to the new submission wizard by default.

Parameters
$argsarray
$requestRequest

Definition at line 83 of file PKPSubmissionHandler.inc.php.

PKPSubmissionHandler::PKPSubmissionHandler ( )

Constructor

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

PKPSubmissionHandler::saveStep (   $args,
  $request 
)

Save a submission step.

Parameters
$argsarray first parameter is the step being saved
$requestRequest

Definition at line 176 of file PKPSubmissionHandler.inc.php.

References HookRegistry\call(), PKPHandler\getAuthorizedContextObject(), JSONMessage\getString(), and setupTemplate().

PKPSubmissionHandler::setupTemplate (   $request)

Setup common template variables.

Parameters
$requestRequest

Definition at line 213 of file PKPSubmissionHandler.inc.php.

References _getStepsNumberAndLocaleKeys(), and AppLocale\requireComponents().

Referenced by saveStep(), step(), and wizard().

PKPSubmissionHandler::step (   $args,
  $request 
)

Display a step for the submission wizard. Displays submission index page if a valid step is not specified.

Parameters
$argsarray
$requestRequest

Definition at line 114 of file PKPSubmissionHandler.inc.php.

References _canExpedite(), _getStepCount(), PKPHandler\getAuthorizedContextObject(), SubmissionsListGridCellProvider\getPageAndOperationByUserRoles(), JSONMessage\getString(), and setupTemplate().

PKPSubmissionHandler::wizard (   $args,
  $request 
)

Display the tab set for the submission wizard.

Parameters
$argsarray
$requestPKPRequest

Definition at line 92 of file PKPSubmissionHandler.inc.php.

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


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