Inheritance diagram for PKPEditorDecisionHandler:

Public Member Functions
	authorize ($request, &$args, $roleAssignments)

	externalReview ($args, $request)

	importPeerReviews ($args, $request)

	initialize ($request)

	newReviewRound ($args, $request)

	promote ($args, $request)

	promoteInReview ($args, $request)

	saveExternalReview ($args, $request)

	savePromote ($args, $request)

	savePromoteInReview ($args, $request)

	saveRecommendation ($args, $request)

	saveSendReviews ($args, $request)

	saveSendReviewsInReview ($args, $request)

	sendRecommendation ($args, $request)

	sendReviews ($args, $request)

	sendReviewsInReview ($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)

	index ($args, $request)

	markRoleAssignmentsChecked ()

	requireSSL ()

	setApiToken ($apiToken)

	setDispatcher ($dispatcher)

	setEnforceRestrictedSite ($enforceRestrictedSite)

	setId ($id)

	setupTemplate ($request)

	validate ($requiredContexts=null, $request=null)

Protected Member Functions
	_getEditorDecisionForm ($formName, $decision)

	_getReviewNotificationTypes ()

	_getReviewRoundOps ()

	_getReviewStages ()

	_initiateEditorDecision ($args, $request, $formName)

	_resolveEditorDecisionForm ($formName)

	_saveEditorDecision ($args, $request, $formName, $redirectOp=null, $decision=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 Attributes inherited from PKPHandler
	$_apiToken = null

Detailed Description

Definition at line 21 of file PKPEditorDecisionHandler.inc.php.

Member Function Documentation

◆ _getEditorDecisionForm()

PKPEditorDecisionHandler::_getEditorDecisionForm	(	$formName,
		$decision
	)

protected

Get an instance of an editor decision form.

Parameters

$formName	string
$decision	int

Returns: EditorDecisionForm

Definition at line 379 of file PKPEditorDecisionHandler.inc.php.

References _getReviewStages(), _resolveEditorDecisionForm(), and PKPHandler\getAuthorizedContextObject().

Referenced by _initiateEditorDecision(), and _saveEditorDecision().

◆ _getReviewNotificationTypes()

PKPEditorDecisionHandler::_getReviewNotificationTypes ( )

protected

Get review-related decision notifications.

Returns: array

Reimplemented in EditorDecisionHandler.

Definition at line 523 of file PKPEditorDecisionHandler.inc.php.

Referenced by _saveEditorDecision().

◆ _getReviewRoundOps()

PKPEditorDecisionHandler::_getReviewRoundOps ( )

protected

Get operations that need a review round id policy.

Returns: array

Definition at line 352 of file PKPEditorDecisionHandler.inc.php.

Referenced by EditorDecisionHandler\__construct(), and authorize().

◆ _getReviewStages()

PKPEditorDecisionHandler::_getReviewStages ( )

protected

Get review-related stage IDs.

Returns: array

Reimplemented in EditorDecisionHandler.

Definition at line 515 of file PKPEditorDecisionHandler.inc.php.

Referenced by _getEditorDecisionForm(), saveRecommendation(), and sendRecommendation().

◆ _initiateEditorDecision()

PKPEditorDecisionHandler::_initiateEditorDecision	(	$args,
		$request,
		$formName
	)

protected

Initiate an editor decision.

Parameters

$args	array
$request	PKPRequest
$formName	string Name of form to call

Returns: JSONMessage JSON object

Definition at line 415 of file PKPEditorDecisionHandler.inc.php.

References _getEditorDecisionForm().

Referenced by externalReview(), newReviewRound(), promote(), promoteInReview(), sendReviews(), and sendReviewsInReview().

◆ _resolveEditorDecisionForm()

PKPEditorDecisionHandler::_resolveEditorDecisionForm ( $formName )

protected

Get the fully-qualified import name for the given form name.

Parameters

$formName Class name for the desired form.

Returns: string

Reimplemented in EditorDecisionHandler.

Definition at line 361 of file PKPEditorDecisionHandler.inc.php.

Referenced by _getEditorDecisionForm().

◆ _saveEditorDecision()

PKPEditorDecisionHandler::_saveEditorDecision	(	$args,
		$request,
		$formName,
		$redirectOp = `null`,
		$decision = `null`
	)

protected

Save an editor decision.

Parameters

$args	array
$request	PKPRequest
$formName	string Name of form to call
$redirectOp	string A workflow stage operation to redirect to if successful (if any).

Returns: JSONMessage JSON object

Definition at line 435 of file PKPEditorDecisionHandler.inc.php.

References _getEditorDecisionForm(), _getReviewNotificationTypes(), PKPHandler\getAuthorizedContextObject(), DAORegistry\getDAO(), DAO\getDataChangedEvent(), and PKPHandler\getDispatcher().

Referenced by EditorDecisionHandler\_saveGeneralPromote(), saveExternalReview(), EditorDecisionHandler\saveNewReviewRound(), saveSendReviews(), and saveSendReviewsInReview().

◆ authorize()

PKPEditorDecisionHandler::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.

Reimplemented in EditorDecisionHandler.

Definition at line 29 of file PKPEditorDecisionHandler.inc.php.

References _getReviewRoundOps(), PKPHandler\addPolicy(), and PKPHandler\getAuthorizedContextObject().

◆ externalReview()

PKPEditorDecisionHandler::externalReview	(	$args,
		$request
	)

Jump from submission to external review

Parameters

$args	array
$request	PKPRequest

Returns: string Serialized JSON object

Definition at line 85 of file PKPEditorDecisionHandler.inc.php.

References _initiateEditorDecision().

◆ importPeerReviews()

PKPEditorDecisionHandler::importPeerReviews	(	$args,
		$request
	)

Import all free-text/review form reviews to paste into message

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 196 of file PKPEditorDecisionHandler.inc.php.

References PKPString\enumerateAlphabetically(), PKPHandler\getAuthorizedContextObject(), DAORegistry\getDAO(), AppLocale\requireComponents(), and PKPString\stripUnsafeHtml().

◆ initialize()

PKPEditorDecisionHandler::initialize ( $request )

Subclasses can override this method to configure the handler.

NB: This method will be called after validation and authorization.

Parameters

$request PKPRequest

Reimplemented from PKPHandler.

Definition at line 55 of file PKPEditorDecisionHandler.inc.php.

References AppLocale\requireComponents().

◆ newReviewRound()

PKPEditorDecisionHandler::newReviewRound	(	$args,
		$request
	)

Start a new review round

Parameters

$args	array
$request	PKPRequest

Returns: string Serialized JSON object

Definition at line 75 of file PKPEditorDecisionHandler.inc.php.

References _initiateEditorDecision().

◆ promote()

PKPEditorDecisionHandler::promote	(	$args,
		$request
	)

Show a promote form (responsible for accept submission modals outside review stage)

Parameters

$args	array
$request	PKPRequest

Returns: string Serialized JSON object

Definition at line 153 of file PKPEditorDecisionHandler.inc.php.

References _initiateEditorDecision().

◆ promoteInReview()

PKPEditorDecisionHandler::promoteInReview	(	$args,
		$request
	)

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).

Parameters

$args	array
$request	PKPRequest

Returns: string Serialized JSON object

Definition at line 165 of file PKPEditorDecisionHandler.inc.php.

References _initiateEditorDecision().

◆ saveExternalReview()

PKPEditorDecisionHandler::saveExternalReview	(	$args,
		$request
	)

Start a new review round in external review, bypassing internal

Parameters

$args	array
$request	PKPRequest

Returns: string Serialized JSON object

Definition at line 95 of file PKPEditorDecisionHandler.inc.php.

References _saveEditorDecision(), and PKPHandler\getAuthorizedContextObject().

◆ savePromote()

PKPEditorDecisionHandler::savePromote	(	$args,
		$request
	)

Save the send review form

Parameters

$args	array
$request	PKPRequest

Returns: string Serialized JSON object

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

◆ savePromoteInReview()

PKPEditorDecisionHandler::savePromoteInReview	(	$args,
		$request
	)

Save the send review form (same case of the promoteInReview() method, see description there).

Parameters

$args	array
$request	PKPRequest

Returns: string Serialized JSON object

Definition at line 186 of file PKPEditorDecisionHandler.inc.php.

◆ saveRecommendation()

PKPEditorDecisionHandler::saveRecommendation	(	$args,
		$request
	)

Show the editor recommendation form

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage

Definition at line 323 of file PKPEditorDecisionHandler.inc.php.

References _getReviewStages(), and PKPHandler\getAuthorizedContextObject().

◆ saveSendReviews()

PKPEditorDecisionHandler::saveSendReviews	(	$args,
		$request
	)

Save the send review form when user is not in review stage.

Parameters

$args	array
$request	PKPRequest

Returns: string Serialized JSON object

Definition at line 133 of file PKPEditorDecisionHandler.inc.php.

References _saveEditorDecision().

◆ saveSendReviewsInReview()

PKPEditorDecisionHandler::saveSendReviewsInReview	(	$args,
		$request
	)

Save the send review form when user is in review stages.

Parameters

$args	array
$request	PKPRequest

Returns: string Serialized JSON object

Definition at line 143 of file PKPEditorDecisionHandler.inc.php.

References _saveEditorDecision().

◆ sendRecommendation()

PKPEditorDecisionHandler::sendRecommendation	(	$args,
		$request
	)

Show the editor recommendation form

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage

Definition at line 302 of file PKPEditorDecisionHandler.inc.php.

References _getReviewStages(), and PKPHandler\getAuthorizedContextObject().

◆ sendReviews()

PKPEditorDecisionHandler::sendReviews	(	$args,
		$request
	)

Show a save review form (responsible for decline submission modals when not in review stage)

Parameters

$args	array
$request	PKPRequest

Returns: string Serialized JSON object

Definition at line 110 of file PKPEditorDecisionHandler.inc.php.

References _initiateEditorDecision().

◆ sendReviewsInReview()

PKPEditorDecisionHandler::sendReviewsInReview	(	$args,
		$request
	)

Show a save review form (responsible for request revisions, resubmit for review, and decline submission modals in review stages). We need this because the authorization in review stages is different when not in review stages (need to authorize review round id).

Parameters

$args	array
$request	PKPRequest

Returns: string Serialized JSON object

Definition at line 123 of file PKPEditorDecisionHandler.inc.php.

References _initiateEditorDecision().

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

PKPEditorDecisionHandler.inc.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _getEditorDecisionForm()

◆ _getReviewNotificationTypes()

◆ _getReviewRoundOps()

◆ _getReviewStages()

◆ _initiateEditorDecision()

◆ _resolveEditorDecisionForm()

◆ _saveEditorDecision()

◆ authorize()

◆ externalReview()

◆ importPeerReviews()

◆ initialize()

◆ newReviewRound()

◆ promote()

◆ promoteInReview()

◆ saveExternalReview()

◆ savePromote()

◆ savePromoteInReview()

◆ saveRecommendation()

◆ saveSendReviews()

◆ saveSendReviewsInReview()

◆ sendRecommendation()

◆ sendReviews()

◆ sendReviewsInReview()