Inheritance diagram for PKPWorkflowHandler:

Public Member Functions
	access ($args, $request)

	authorize ($request, &$args, $roleAssignments)

	editorDecisionActions ($args, $request)

	editorial ($args, $request)

	externalReview ($args, $request)

	index ($args, $request)

	production ($args, $request)

	setupIndex ($request)

	setupTemplate ($request)

	submission ($args, $request)

	submissionProgressBar ($args, $request)

Public Member Functions inherited from PKPHandler
	__construct ()

	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)

Data Fields
	$_isBackendPage = true

Data Fields inherited from PKPHandler
	$_authorizationDecisionManager

	$_checks = array()

	$_dispatcher

	$_enforceRestrictedSite = true

	$_id

	$_isBackendPage = false

	$_roleAssignments = array()

	$_roleAssignmentsChecked = false

Protected Member Functions
	_getRepresentationsGridUrl ($request, $submission)

	_redirectToIndex ($args, $request)

	getEditorAssignmentNotificationTypeByStageId ($stageId)

	identifyStageId ($request, $args)

	notificationOptionsByStage ($user, $stageId, $contextId)

Additional Inherited Members
Static Public Member Functions inherited from PKPHandler
static	getPageParamName ($rangeName)

static	getRangeInfo ($request, $rangeName, $contextData=null)

static	hashPageContext ($request, $contextData=array())

Protected Attributes inherited from PKPHandler
	$_apiToken = null

Detailed Description

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

Member Function Documentation

◆ _getRepresentationsGridUrl()

PKPWorkflowHandler::_getRepresentationsGridUrl	(	$request,
		$submission
	)

abstractprotected

Get the URL for the galley/publication formats grid with a placeholder for the publicationId value

Parameters

Request	$request
Submission	$submission

Returns: string

Reimplemented in WorkflowHandler.

Referenced by index().

◆ _redirectToIndex()

PKPWorkflowHandler::_redirectToIndex	(	$args,
		$request
	)

protected

Redirect all old stage paths to index

Parameters

$args	array
$request	PKPRequest

Definition at line 460 of file PKPWorkflowHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), and WorkflowStageDAO\getIdFromPath().

Referenced by editorial(), externalReview(), production(), and submission().

◆ access()

PKPWorkflowHandler::access	(	$args,
		$request
	)

Redirect users to their most appropriate submission workflow stage.

Parameters

$args	array
$request	PKPRequest

Definition at line 69 of file PKPWorkflowHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), and PKPApplication\getWorkflowTypeRoles().

◆ authorize()

PKPWorkflowHandler::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

$request	Request
$args	array request arguments
$roleAssignments	array the operation role assignment, see getRoleAssignment() for more details.

Returns: boolean

Reimplemented from PKPHandler.

Definition at line 35 of file PKPWorkflowHandler.inc.php.

References PKPHandler\addPolicy(), identifyStageId(), and PKPHandler\markRoleAssignmentsChecked().

◆ editorDecisionActions()

PKPWorkflowHandler::editorDecisionActions	(	$args,
		$request
	)

Fetch JSON-encoded editor decision options.

Parameters

$args	array
$request	Request

Returns: JSONMessage JSON object

Definition at line 475 of file PKPWorkflowHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), DAORegistry\getDAO(), PKPHandler\getId(), PKPTemplateManager\getManager(), AppLocale\requireComponents(), and setupTemplate().

◆ editorial()

PKPWorkflowHandler::editorial	(	$args,
		$request
	)

Show the editorial stage

Parameters

$request	PKPRequest
$args	array

Definition at line 442 of file PKPWorkflowHandler.inc.php.

References _redirectToIndex().

◆ externalReview()

PKPWorkflowHandler::externalReview	(	$args,
		$request
	)

Show the external review stage.

Parameters

$args	array
$request	PKPRequest

Definition at line 433 of file PKPWorkflowHandler.inc.php.

References _redirectToIndex().

◆ getEditorAssignmentNotificationTypeByStageId()

PKPWorkflowHandler::getEditorAssignmentNotificationTypeByStageId ( $stageId )

abstractprotected

Return the editor assignment notification type based on stage id.

Parameters

$stageId int

Returns: int

Reimplemented in WorkflowHandler.

Referenced by notificationOptionsByStage().

◆ identifyStageId()

PKPWorkflowHandler::identifyStageId	(	$request,
		$args
	)

protected

Translate the requested operation to a stage id.

Parameters

$request	Request
$args	array

Returns: integer One of the WORKFLOW_STAGE_* constants.

Definition at line 724 of file PKPWorkflowHandler.inc.php.

References WorkflowStageDAO\getIdFromPath(), and WorkflowStageDAO\getPathFromId().

Referenced by authorize(), and submissionProgressBar().

◆ index()

PKPWorkflowHandler::index	(	$args,
		$request
	)

Show the workflow stage, with the stage path as an #anchor.

Parameters

$args	array
$request	PKPRequest

Reimplemented from PKPHandler.

Definition at line 106 of file PKPWorkflowHandler.inc.php.

References _getRepresentationsGridUrl(), PKPServices\get(), PKPLocale\getAllLocales(), PKPHandler\getAuthorizedContextObject(), DAORegistry\getDAO(), PKPTemplateManager\getManager(), PluginRegistry\getPlugins(), WorkflowStageDAO\getWorkflowStageKeysAndPaths(), PKPApplication\getWorkflowTypeRoles(), setupIndex(), and setupTemplate().

◆ notificationOptionsByStage()

PKPWorkflowHandler::notificationOptionsByStage	(	$user,
		$stageId,
		$contextId
	)

protected

Determine if a particular stage has a notification pending. If so, return true. This is used to set the CSS class of the submission progress bar.

Parameters

$user	User
$stageId	integer
$contextId	integer

Returns: boolean

Definition at line 754 of file PKPWorkflowHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), DAORegistry\getDAO(), and getEditorAssignmentNotificationTypeByStageId().

◆ production()

PKPWorkflowHandler::production	(	$args,
		$request
	)

Show the production stage

Parameters

$request	PKPRequest
$args	array

Definition at line 451 of file PKPWorkflowHandler.inc.php.

References _redirectToIndex().

◆ setupIndex()

PKPWorkflowHandler::setupIndex ( $request )

Placeholder method to be overridden by apps in order to add app-specific data to the template

Parameters

$request Request

Reimplemented in WorkflowHandler.

Definition at line 712 of file PKPWorkflowHandler.inc.php.

Referenced by index().

◆ setupTemplate()

PKPWorkflowHandler::setupTemplate ( $request )

Setup variables for the template

Parameters

$request Request

Reimplemented from PKPHandler.

Definition at line 701 of file PKPWorkflowHandler.inc.php.

References AppLocale\requireComponents().

Referenced by editorDecisionActions(), index(), and submissionProgressBar().

◆ submission()

PKPWorkflowHandler::submission	(	$args,
		$request
	)

Show the submission stage.

Parameters

$args	array
$request	PKPRequest

Definition at line 424 of file PKPWorkflowHandler.inc.php.

References _redirectToIndex().

◆ submissionProgressBar()

PKPWorkflowHandler::submissionProgressBar	(	$args,
		$request
	)

Fetch the JSON-encoded submission progress bar.

Parameters

$args	array
$request	Request

Returns: JSONMessage JSON object

Definition at line 682 of file PKPWorkflowHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), PKPTemplateManager\getManager(), WorkflowStageDAO\getWorkflowStageKeysAndPaths(), identifyStageId(), and setupTemplate().

Field Documentation

◆ $_isBackendPage

PKPWorkflowHandler::$_isBackendPage = true

Definition at line 27 of file PKPWorkflowHandler.inc.php.

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

PKPWorkflowHandler.inc.php

Public Member Functions

Data Fields

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _getRepresentationsGridUrl()

◆ _redirectToIndex()

◆ access()

◆ authorize()

◆ editorDecisionActions()

◆ editorial()

◆ externalReview()

◆ getEditorAssignmentNotificationTypeByStageId()

◆ identifyStageId()

◆ index()

◆ notificationOptionsByStage()

◆ production()

◆ setupIndex()

◆ setupTemplate()

◆ submission()

◆ submissionProgressBar()

Field Documentation

◆ $_isBackendPage