BackendSubmissionsHandler Class Reference

Inheritance diagram for BackendSubmissionsHandler:

Public Member Functions
	__construct ()
	addAppSubmissionsParams ($hookName, $args)
	addToCatalog ($slimRequest, $response, $args)
	saveDisplayFlags ($slimRequest, $response, $args)
	saveFeaturedOrder ($slimRequest, $response, $args)
Public Member Functions inherited from PKPBackendSubmissionsHandler
	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 19 of file BackendSubmissionsHandler.inc.php.

Constructor & Destructor Documentation

__construct()

BackendSubmissionsHandler::__construct

(

)

Constructor

Reimplemented from PKPBackendSubmissionsHandler.

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

References HookRegistry\register().

Member Function Documentation

addAppSubmissionsParams()

BackendSubmissionsHandler::addAppSubmissionsParams	(		$hookName,
			$args
	)

Add omp-specific parameters to the getMany request

Parameters

$hookName	string
$args	array [ @option $params array @option $slimRequest Request Slim request object @option $response Response object ]

Definition at line 72 of file BackendSubmissionsHandler.inc.php.

addToCatalog()

BackendSubmissionsHandler::addToCatalog	(		$slimRequest,
			$response,
			$args
	)

Add one or more submissions to the catalog

Parameters

$slimRequest	Request Slim request object
$response	Response object

Returns

Response

Definition at line 204 of file BackendSubmissionsHandler.inc.php.

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

saveDisplayFlags()

BackendSubmissionsHandler::saveDisplayFlags	(		$slimRequest,
			$response,
			$args
	)

Save changes to a submission's featured or new release flags

Parameters

$slimRequest	Request Slim request object
$response	Response object
$args	array { @option array featured Optional. Featured flags with assoc type, id and seq values. @option array newRelease Optional. New release flags assoc type, id and seq values. }

Returns

Response

Definition at line 124 of file BackendSubmissionsHandler.inc.php.

References DAORegistry\getDAO().

saveFeaturedOrder()

BackendSubmissionsHandler::saveFeaturedOrder	(		$slimRequest,
			$response,
			$args
	)

Save changes to the sequence of featured items in the catalog, series or category.

Parameters

$slimRequest	Request Slim request object
$response	Response object
$args	array { @option int assocType Whether these featured items are for a press, category or series. Values: ASSOC_TYPE_* @option int assocId The press, category or series id @option array featured List of assoc arrays with submission ids and seq value. @option bool append Whether to replace or append the features to the existing features for this assoc type and id. Default: false }

Returns

Response

Definition at line 175 of file BackendSubmissionsHandler.inc.php.

References DAORegistry\getDAO().

---

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

• BackendSubmissionsHandler.inc.php