PHP Class PKPWorkflowHandler, pkp-lib

Inheritance: extends Handler

Show file Open project: pkp/pkp-lib Class Usage Examples

Public Methods

Method	Description
__construct ( )	Constructor
access ( $args, $request )	Redirect users to their most appropriate submission workflow stage.
authorize ( $request, &$args, $roleAssignments )
editorDecisionActions ( $args, $request ) : JSONMessage	Fetch JSON-encoded editor decision options.
editorial ( &$args, $request )	Show the editorial stage
externalReview ( $args, $request )	Show the external review stage.
index ( $args, $request )	Show the workflow stage, with the stage path as an #anchor.
initialize ( $request, $args )
production ( &$args, $request )	Show the production stage
setupTemplate ( $request )	Setup variables for the template
submission ( $args, $request )	Show the submission stage.
submissionHeader ( $args, $request ) : JSONMessage	Fetch the JSON-encoded submission header.
submissionProgressBar ( $args, $request ) : JSONMessage	Fetch the JSON-encoded submission progress bar.

Protected Methods

Method	Description
_redirectToIndex ( &$args, $request )	Redirect all old stage paths to index
getEditorAssignmentNotificationTypeByStageId ( $stageId ) : integer	Return the editor assignment notification type based on stage id.
identifyStageId ( $request, $args ) : integer	Translate the requested operation to a stage id.
isSubmissionReady ( $submission ) : boolean	Checks whether or not the submission is ready to appear in catalog.
notificationOptionsByStage ( $user, $stageId, $contextId ) : boolean	Determine if a particular stage has a notification pending. If so, return true.

Private Methods

Method	Description
_displayWorkflow ( $args, $request )	Displays the workflow tab structure.

Method Details

__construct() public method

Constructor

public __construct ( )

_redirectToIndex() protected method

Redirect all old stage paths to index

protected _redirectToIndex ( &$args, $request )
$args		array
$request		PKPRequest

access() public method

Redirect users to their most appropriate submission workflow stage.

public access ( $args, $request )
$args		array
$request		PKPRequest

authorize() public method

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

editorDecisionActions() public method

Fetch JSON-encoded editor decision options.

public editorDecisionActions ( $args, $request ) : JSONMessage
$args		array
$request		Request
return	JSONMessage	JSON object

editorial() public method

Show the editorial stage

public editorial ( &$args, $request )
$args		array
$request		PKPRequest

externalReview() public method

Show the external review stage.

public externalReview ( $args, $request )
$args		array
$request		PKPRequest

getEditorAssignmentNotificationTypeByStageId() abstract protected method

Return the editor assignment notification type based on stage id.

abstract protected getEditorAssignmentNotificationTypeByStageId ( $stageId ) : integer
$stageId		int
return	integer

identifyStageId() protected method

Translate the requested operation to a stage id.

protected identifyStageId ( $request, $args ) : integer
$request		Request
$args		array
return	integer	One of the WORKFLOW_STAGE_* constants.

index() public method

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

public index ( $args, $request )
$args		array
$request		PKPRequest

initialize() public method

public initialize ( $request, $args )

isSubmissionReady() abstract protected method

Checks whether or not the submission is ready to appear in catalog.

abstract protected isSubmissionReady ( $submission ) : boolean
$submission		Submission
return	boolean

notificationOptionsByStage() protected method

This is used to set the CSS class of the submission progress bar.

protected notificationOptionsByStage ( $user, $stageId, $contextId ) : boolean
$user		PKPUser
$stageId		integer
$contextId		integer
return	boolean

production() public method

Show the production stage

public production ( &$args, $request )
$args		array
$request		PKPRequest

setupTemplate() public method

Setup variables for the template

public setupTemplate ( $request )
$request		Request

submission() public method

Show the submission stage.

public submission ( $args, $request )
$args		array
$request		PKPRequest

submissionHeader() public method

Fetch the JSON-encoded submission header.

public submissionHeader ( $args, $request ) : JSONMessage
$args		array
$request		Request
return	JSONMessage	JSON object

submissionProgressBar() public method

Fetch the JSON-encoded submission progress bar.

public submissionProgressBar ( $args, $request ) : JSONMessage
$args		array
$request		Request
return	JSONMessage	JSON object