Open Preprint Systems  3.3.0
SubmissionHandler Class Reference
Inheritance diagram for SubmissionHandler:
PKPSubmissionHandler APIHandler PKPHandler

Public Member Functions

 __construct ()
 
 __construct ()
 
 authorize ($request, &$args, $roleAssignments)
 
 fetchChoices ($args, $request)
 
 getStepCount ()
 
 getStepsNumberAndLocaleKeys ()
 
 relatePublication ($slimRequest, $response, $args)
 
 setupTemplate ($request)
 
 step ($args, $request)
 
- Public Member Functions inherited from PKPSubmissionHandler
 add ($slimRequest, $response, $args)
 
 addPublication ($slimRequest, $response, $args)
 
 delete ($slimRequest, $response, $args)
 
 deletePublication ($slimRequest, $response, $args)
 
 edit ($slimRequest, $response, $args)
 
 editPublication ($slimRequest, $response, $args)
 
 get ($slimRequest, $response, $args)
 
 getMany ($slimRequest, $response, $args)
 
 getParticipants ($slimRequest, $response, $args)
 
 getPublication ($slimRequest, $response, $args)
 
 getPublications ($slimRequest, $response, $args)
 
 index ($args, $request)
 
 publishPublication ($slimRequest, $response, $args)
 
 saveStep ($args, $request)
 
 unpublishPublication ($slimRequest, $response, $args)
 
 versionPublication ($slimRequest, $response, $args)
 
 wizard ($args, $request)
 
- Public Member Functions inherited from APIHandler
 convertStringsToSchema ($schema, $params)
 
 getApp ()
 
 getEndpointPattern ()
 
 getEndpoints ()
 
 getEntityId ($parameterName)
 
 getParameter ($parameterName, $default=null)
 
 getRequest ()
 
 getSlimRequest ()
 
 setSlimRequest ($slimRequest)
 
 setupEndpoints ()
 
- Public Member Functions inherited from PKPHandler
 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)
 
 initialize ($request)
 
 markRoleAssignmentsChecked ()
 
 requireSSL ()
 
 setApiToken ($apiToken)
 
 setDispatcher ($dispatcher)
 
 setEnforceRestrictedSite ($enforceRestrictedSite)
 
 setId ($id)
 
 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 PKPSubmissionHandler
 $_isBackendPage = true
 
- Data Fields inherited from PKPHandler
 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_enforceRestrictedSite = true
 
 $_id
 
 $_isBackendPage = false
 
 $_roleAssignments = array()
 
 $_roleAssignmentsChecked = false
 
- Protected Member Functions inherited from APIHandler
 _validateStatDates ($params, $dateStartParam='dateStart', $dateEndParam='dateEnd')
 
- Protected Attributes inherited from APIHandler
 $_app
 
 $_endpoints = array()
 
 $_handlerPath = null
 
 $_pathPattern
 
 $_request
 
 $_slimRequest = null
 
- Protected Attributes inherited from PKPHandler
 $_apiToken = null
 

Detailed Description

Handle API requests for submission operations.

Handle requests for the submission wizard.

Definition at line 21 of file api/v1/submissions/SubmissionHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct() [1/2]

SubmissionHandler::__construct ( )

Constructor

Reimplemented from PKPSubmissionHandler.

Definition at line 26 of file api/v1/submissions/SubmissionHandler.inc.php.

References APIHandler\__construct(), and APIHandler\getEndpointPattern().

◆ __construct() [2/2]

SubmissionHandler::__construct ( )

Constructor

Reimplemented from PKPSubmissionHandler.

Definition at line 24 of file pages/submission/SubmissionHandler.inc.php.

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ authorize()

SubmissionHandler::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 PKPSubmissionHandler.

Definition at line 129 of file api/v1/submissions/SubmissionHandler.inc.php.

References PKPHandler\addPolicy(), PKPHandler\authorize(), and APIHandler\getSlimRequest().

◆ fetchChoices()

SubmissionHandler::fetchChoices (   $args,
  $request 
)

Retrieves a JSON list of available choices for a tagit metadata input field.

Parameters
$argsarray
$requestRequest

Definition at line 75 of file pages/submission/SubmissionHandler.inc.php.

References AppLocale\getLocale().

◆ getStepCount()

SubmissionHandler::getStepCount ( )

Get the number of submission steps.

Returns
int

Reimplemented from PKPSubmissionHandler.

Definition at line 126 of file pages/submission/SubmissionHandler.inc.php.

Referenced by step().

◆ getStepsNumberAndLocaleKeys()

SubmissionHandler::getStepsNumberAndLocaleKeys ( )

Get the step numbers and their corresponding title locale keys.

Returns
array

Reimplemented from PKPSubmissionHandler.

Definition at line 112 of file pages/submission/SubmissionHandler.inc.php.

◆ relatePublication()

SubmissionHandler::relatePublication (   $slimRequest,
  $response,
  $args 
)

Create relations for publications

Parameters
$slimRequestRequest Slim request object
$responseResponse object
array$argsarguments
Returns
Response

Definition at line 192 of file api/v1/submissions/SubmissionHandler.inc.php.

References PKPServices\get(), PKPHandler\getAuthorizedContextObject(), DAORegistry\getDAO(), and APIHandler\getRequest().

◆ setupTemplate()

SubmissionHandler::setupTemplate (   $request)

Setup common template variables.

Parameters
$requestRequest

Reimplemented from PKPSubmissionHandler.

Definition at line 103 of file pages/submission/SubmissionHandler.inc.php.

References AppLocale\requireComponents().

◆ step()

SubmissionHandler::step (   $args,
  $request 
)

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

Parameters
$argsarray
$requestRequest
Returns
JSONMessage JSON object

Reimplemented from PKPSubmissionHandler.

Definition at line 37 of file pages/submission/SubmissionHandler.inc.php.

References PKPServices\get(), PKPHandler\getAuthorizedContextObject(), PKPTemplateManager\getManager(), and getStepCount().


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