PHP Class PKPEditorDecisionHandler, pkp-lib

Inheritance: extends Handler
Mostra file Open project: pkp/pkp-lib Class Usage Examples

Public Methods

Method Description
__construct ( ) Constructor.
authorize ( $request, &$args, $roleAssignments )
externalReview ( $args, $request ) : string Jump from submission to external review
importPeerReviews ( $args, $request ) : JSONMessage Import all free-text/review form reviews to paste into message
initialize ( $request, $args )
newReviewRound ( $args, $request ) : string Start a new review round
promote ( $args, $request ) : string Show a promote form (responsible for accept submission modals outside review stage)
promoteInReview ( $args, $request ) : string Show a promote form (responsible for external review and accept submission modals in review stages). We need this because the authorization for promoting in review stages is different when not in review stages (need to authorize review round id).
saveExternalReview ( $args, $request ) : string Start a new review round in external review, bypassing internal
savePromote ( $args, $request ) : string Save the send review form
savePromoteInReview ( $args, $request ) : string Save the send review form (same case of the promoteInReview() method, see description there).
saveSendReviews ( $args, $request ) : string Save the send review form when user is not in review stage.
saveSendReviewsInReview ( $args, $request ) : string Save the send review form when user is in review stages.
sendReviews ( $args, $request ) : string Show a save review form (responsible for decline submission modals when not in review stage)
sendReviewsInReview ( $args, $request ) : string Show a save review form (responsible for request revisions, resubmit for review, and decline submission modals in review stages).

Protected Methods

Method Description
_getEditorDecisionForm ( $formName, $decision ) : EditorDecisionForm Get an instance of an editor decision form.
_getReviewNotificationTypes ( ) : array Get review-related decision notifications.
_getReviewRoundOps ( ) : array Get operations that need a review round id policy.
_getReviewStages ( ) : array Get review-related stage IDs.
_initiateEditorDecision ( $args, $request, $formName ) : JSONMessage Initiate an editor decision.
_resolveEditorDecisionForm ( $formName ) : string Get the fully-qualified import name for the given form name.
_saveEditorDecision ( $args, $request, $formName, $redirectOp = null, $decision = null ) : JSONMessage Save an editor decision.

Method Details

__construct() public method

Constructor.
public __construct ( )

_getEditorDecisionForm() protected method

Get an instance of an editor decision form.
protected _getEditorDecisionForm ( $formName, $decision ) : EditorDecisionForm
$formName string
$decision int
return EditorDecisionForm

_getReviewNotificationTypes() protected method

Get review-related decision notifications.
protected _getReviewNotificationTypes ( ) : array
return array

_getReviewRoundOps() protected method

Get operations that need a review round id policy.
protected _getReviewRoundOps ( ) : array
return array

_getReviewStages() protected method

Get review-related stage IDs.
protected _getReviewStages ( ) : array
return array

_initiateEditorDecision() protected method

Initiate an editor decision.
protected _initiateEditorDecision ( $args, $request, $formName ) : JSONMessage
$args array
$request PKPRequest
$formName string Name of form to call
return JSONMessage JSON object

_resolveEditorDecisionForm() protected method

Get the fully-qualified import name for the given form name.
protected _resolveEditorDecisionForm ( $formName ) : string
$formName Class name for the desired form.
return string

_saveEditorDecision() protected method

Save an editor decision.
protected _saveEditorDecision ( $args, $request, $formName, $redirectOp = null, $decision = null ) : JSONMessage
$args array
$request PKPRequest
$formName string Name of form to call
$redirectOp string A workflow stage operation to redirect to if successful (if any).
return JSONMessage JSON object

authorize() public method

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

externalReview() public method

Jump from submission to external review
public externalReview ( $args, $request ) : string
$args array
$request PKPRequest
return string Serialized JSON object

importPeerReviews() public method

Import all free-text/review form reviews to paste into message
public importPeerReviews ( $args, $request ) : JSONMessage
$args array
$request PKPRequest
return JSONMessage JSON object

initialize() public method

See also: PKPHandler::initialize()
public initialize ( $request, $args )

newReviewRound() public method

Start a new review round
public newReviewRound ( $args, $request ) : string
$args array
$request PKPRequest
return string Serialized JSON object

promote() public method

Show a promote form (responsible for accept submission modals outside review stage)
public promote ( $args, $request ) : string
$args array
$request PKPRequest
return string Serialized JSON object

promoteInReview() public method

Show a promote form (responsible for external review and accept submission modals in review stages). We need this because the authorization for promoting in review stages is different when not in review stages (need to authorize review round id).
public promoteInReview ( $args, $request ) : string
$args array
$request PKPRequest
return string Serialized JSON object

saveExternalReview() public method

Start a new review round in external review, bypassing internal
public saveExternalReview ( $args, $request ) : string
$args array
$request PKPRequest
return string Serialized JSON object

savePromote() public method

Save the send review form
public savePromote ( $args, $request ) : string
$args array
$request PKPRequest
return string Serialized JSON object

savePromoteInReview() public method

Save the send review form (same case of the promoteInReview() method, see description there).
public savePromoteInReview ( $args, $request ) : string
$args array
$request PKPRequest
return string Serialized JSON object

saveSendReviews() public method

Save the send review form when user is not in review stage.
public saveSendReviews ( $args, $request ) : string
$args array
$request PKPRequest
return string Serialized JSON object

saveSendReviewsInReview() public method

Save the send review form when user is in review stages.
public saveSendReviewsInReview ( $args, $request ) : string
$args array
$request PKPRequest
return string Serialized JSON object

sendReviews() public method

Show a save review form (responsible for decline submission modals when not in review stage)
public sendReviews ( $args, $request ) : string
$args array
$request PKPRequest
return string Serialized JSON object

sendReviewsInReview() public method

We need this because the authorization in review stages is different when not in review stages (need to authorize review round id).
public sendReviewsInReview ( $args, $request ) : string
$args array
$request PKPRequest
return string Serialized JSON object