PHP Class PKPWorkflowHandler, pkp-lib

Inheritance: extends Handler
Afficher le fichier Open project: pkp/pkp-lib Class Usage Examples

Méthodes publiques

Méthode 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.

Méthodes protégées

Méthode 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

Méthode Description
_displayWorkflow ( $args, $request ) Displays the workflow tab structure.

Method Details

__construct() public méthode

Constructor
public __construct ( )

_redirectToIndex() protected méthode

Redirect all old stage paths to index
protected _redirectToIndex ( &$args, $request )
$args array
$request PKPRequest

access() public méthode

Redirect users to their most appropriate submission workflow stage.
public access ( $args, $request )
$args array
$request PKPRequest

authorize() public méthode

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

editorDecisionActions() public méthode

Fetch JSON-encoded editor decision options.
public editorDecisionActions ( $args, $request ) : JSONMessage
$args array
$request Request
Résultat JSONMessage JSON object

editorial() public méthode

Show the editorial stage
public editorial ( &$args, $request )
$args array
$request PKPRequest

externalReview() public méthode

Show the external review stage.
public externalReview ( $args, $request )
$args array
$request PKPRequest

getEditorAssignmentNotificationTypeByStageId() abstract protected méthode

Return the editor assignment notification type based on stage id.
abstract protected getEditorAssignmentNotificationTypeByStageId ( $stageId ) : integer
$stageId int
Résultat integer

identifyStageId() protected méthode

Translate the requested operation to a stage id.
protected identifyStageId ( $request, $args ) : integer
$request Request
$args array
Résultat integer One of the WORKFLOW_STAGE_* constants.

index() public méthode

Show the workflow stage, with the stage path as an #anchor.
public index ( $args, $request )
$args array
$request PKPRequest

initialize() public méthode

public initialize ( $request, $args )

isSubmissionReady() abstract protected méthode

Checks whether or not the submission is ready to appear in catalog.
abstract protected isSubmissionReady ( $submission ) : boolean
$submission Submission
Résultat boolean

notificationOptionsByStage() protected méthode

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
Résultat boolean

production() public méthode

Show the production stage
public production ( &$args, $request )
$args array
$request PKPRequest

setupTemplate() public méthode

Setup variables for the template
public setupTemplate ( $request )
$request Request

submission() public méthode

Show the submission stage.
public submission ( $args, $request )
$args array
$request PKPRequest

submissionHeader() public méthode

Fetch the JSON-encoded submission header.
public submissionHeader ( $args, $request ) : JSONMessage
$args array
$request Request
Résultat JSONMessage JSON object

submissionProgressBar() public méthode

Fetch the JSON-encoded submission progress bar.
public submissionProgressBar ( $args, $request ) : JSONMessage
$args array
$request Request
Résultat JSONMessage JSON object