Open Journal Systems  3.3.0
PKPBackendSubmissionsHandler Class Reference
Inheritance diagram for PKPBackendSubmissionsHandler:
APIHandler PKPHandler BackendSubmissionsHandler

Public Member Functions

 __construct ()
 
 authorize ($request, &$args, $roleAssignments)
 
 delete ($slimRequest, $response, $args)
 
 getMany ($slimRequest, $response, $args)
 
- 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)
 
 index ($args, $request)
 
 initialize ($request)
 
 markRoleAssignmentsChecked ()
 
 requireSSL ()
 
 setApiToken ($apiToken)
 
 setDispatcher ($dispatcher)
 
 setEnforceRestrictedSite ($enforceRestrictedSite)
 
 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())
 
- 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 backend operations.

Definition at line 21 of file PKPBackendSubmissionsHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

PKPBackendSubmissionsHandler::__construct ( )

Constructor

Reimplemented from APIHandler.

Reimplemented in BackendSubmissionsHandler.

Definition at line 26 of file PKPBackendSubmissionsHandler.inc.php.

Member Function Documentation

◆ authorize()

PKPBackendSubmissionsHandler::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 PKPHandler.

Definition at line 61 of file PKPBackendSubmissionsHandler.inc.php.

References PKPHandler\addPolicy().

◆ delete()

PKPBackendSubmissionsHandler::delete (   $slimRequest,
  $response,
  $args 
)

Delete a submission

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

Definition at line 177 of file PKPBackendSubmissionsHandler.inc.php.

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

◆ getMany()

PKPBackendSubmissionsHandler::getMany (   $slimRequest,
  $response,
  $args 
)

Get a list of submissions according to passed query parameters

Parameters
$slimRequestRequest Slim request object
$responseResponse object
Returns
Response

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

References HookRegistry\call(), PKPServices\get(), PKPHandler\getAuthorizedContextObject(), and APIHandler\getRequest().


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