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

Public Member Functions

 __construct ()
 
 fetchChoices ($args, $request)
 
 getStepCount ()
 
 getStepsNumberAndLocaleKeys ()
 
 setupTemplate ($request)
 
- Public Member Functions inherited from PKPSubmissionHandler
 add ($slimRequest, $response, $args)
 
 addPublication ($slimRequest, $response, $args)
 
 authorize ($request, &$args, $roleAssignments)
 
 authorize ($request, &$args, $roleAssignments)
 
 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)
 
 step ($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 20 of file SubmissionHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

SubmissionHandler::__construct ( )

Constructor

Reimplemented from PKPSubmissionHandler.

Definition at line 24 of file SubmissionHandler.inc.php.

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ fetchChoices()

SubmissionHandler::fetchChoices (   $args,
  $request 
)

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

Parameters
$argsarray
$requestRequest

Definition at line 39 of file SubmissionHandler.inc.php.

References AppLocale\getLocale().

◆ getStepCount()

SubmissionHandler::getStepCount ( )

Get the number of submission steps.

Returns
int

Reimplemented from PKPSubmissionHandler.

Definition at line 91 of file SubmissionHandler.inc.php.

◆ getStepsNumberAndLocaleKeys()

SubmissionHandler::getStepsNumberAndLocaleKeys ( )

Get the step numbers and their corresponding title locale keys.

Returns
array

Reimplemented from PKPSubmissionHandler.

Definition at line 77 of file SubmissionHandler.inc.php.

◆ setupTemplate()

SubmissionHandler::setupTemplate (   $request)

Setup common template variables.

Parameters
$requestRequest

Reimplemented from PKPSubmissionHandler.

Definition at line 68 of file SubmissionHandler.inc.php.

References AppLocale\requireComponents().


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