Inheritance diagram for PKPReviewerGridHandler:

Public Member Functions
	__construct ()

	_fetchReviewerForm ($args, $request)

	_getReviewAssignmentOps ()

	_getReviewerFormClassName ($selectionType)

	_getReviewRoundOps ()

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

	createReviewer ($args, $request)

	editReminder ($args, $request)

	editReview ($args, $request)

	editThankReviewer ($args, $request)

	enrollReviewer ($args, $request)

	fetchTemplateBody ($args, $request)

	getRequestArgs ()

	getReviewRound ()

	getStageId ()

	getSubmission ()

	getUsersNotAssignedAsReviewers ($args, $request)

	gossip ($args, $request)

	initialize ($request, $args=null)

	readReview ($args, $request)

	reinstateReviewer ($args, $request)

	reloadReviewerForm ($args, $request)

	reviewHistory ($args, $request)

	reviewRead ($args, $request)

	sendEmail ($args, $request)

	sendReminder ($args, $request)

	showReviewerForm ($args, $request)

	thankReviewer ($args, $request)

	unassignReviewer ($args, $request)

	unconsiderReview ($args, $request)

	updateReinstateReviewer ($args, $request)

	updateReview ($args, $request)

	updateReviewer ($args, $request)

	updateUnassignReviewer ($args, $request)

Public Member Functions inherited from GridHandler
	__construct ($dataProvider=null)

	addAction ($action, $position=GRID_ACTION_POSITION_ABOVE)

	addColumn ($column)

	fetchCell (&$args, $request)

	fetchGrid ($args, $request)

	fetchRow ($args, $request)

	fetchRows ($args, $request)

	getActions ($position=GRID_ACTION_POSITION_ABOVE)

	getColumn ($columnId)

&	getColumns ()

&	getColumnsByFlag ($flag)

	getColumnsCount ($flag=null)

	getDataElementSequence ($gridDataElement)

	getDataProvider ()

	getEmptyRowText ()

	getFeatures ()

	getFootNote ()

&	getGridDataElements ($request)

	getGridRangeInfo ($request, $rangeName, $contextData=null)

	getIsSubcomponent ()

	getItemIterator ()

	getJSHandler ()

	getPublishChangeEvents ()

	getRequestArg ($key)

	getRequestedRow ($request, $args)

	getSelectName ()

	getTemplate ()

	getTitle ()

	getUrls ()

	hasColumn ($columnId)

	hasGridDataElements ($request)

	isDataElementSelected ($gridDataElement)

	renderRow ($request, $row)

	saveSequence ($args, $request)

	setDataElementSequence ($request, $rowId, $gridDataElement, $newSequence)

	setEmptyRowText ($emptyRowText)

	setFootNote ($footNote)

	setGridDataElements ($data)

	setTemplate ($template)

	setTitle ($title)

	setUrls ($request, $extraUrls=array())

Public Member Functions inherited from PKPHandler
	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)

	initialize ($request)

	markRoleAssignmentsChecked ()

	requireSSL ()

	setApiToken ($apiToken)

	setDispatcher ($dispatcher)

	setEnforceRestrictedSite ($enforceRestrictedSite)

	setId ($id)

	setupTemplate ($request)

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

Data Fields
	$_isCurrentUserAssignedAuthor

	$_stageId

	$_submission

Data Fields inherited from GridHandler
	$_actions = array(GRID_ACTION_POSITION_DEFAULT => array())

	$_columns = array()

	$_constants = []

	$_data

	$_dataProvider

	$_emptyRowText = 'grid.noItems'

	$_features

	$_footNote = ''

	$_itemIterator

	$_template

	$_title = ''

	$_urls

Data Fields inherited from PKPHandler
	$_authorizationDecisionManager

	$_checks = array()

	$_dispatcher

	$_enforceRestrictedSite = true

	$_id

	$_isBackendPage = false

	$_roleAssignments = array()

	$_roleAssignmentsChecked = false

Protected Member Functions
	_getAuthorDeniedBlindOps ()

	_getAuthorDeniedOps ()

	getRowInstance ()

	loadData ($request, $filter)

Protected Member Functions inherited from GridHandler
	callFeaturesHook ($hookName, $args)

	doSpecificFetchGridActions ($args, $request, $templateMgr)

&	getDataElementFromRequest ($request, &$elementId)

	getFilterForm ()

	getFilterSelectionData ($request)

	getRowDataElement ($request, &$rowId)

	getRowsSequence ($request)

	initFeatures ($request, $args)

	isFilterFormCollapsible ()

	noAutocompleteResults ()

	renderFilter ($request, $filterData=array())

	renderGridBodyPartsInternally ($request)

	renderRowInternally ($request, $row)

	renderRowsInternally ($request, &$elements)

	setFirstDataColumn ()

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

Handle reviewer grid requests.

Definition at line 28 of file PKPReviewerGridHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

PKPReviewerGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

Reimplemented in AuthorReviewerGridHandler.

Definition at line 52 of file PKPReviewerGridHandler.inc.php.

References _getReviewAssignmentOps(), _getReviewRoundOps(), and PKPHandler\addRoleAssignment().

Member Function Documentation

◆ _fetchReviewerForm()

PKPReviewerGridHandler::_fetchReviewerForm	(	$args,
		$request
	)

Return a fetched reviewer form data in string.

Parameters

$args	Array
$request	Request

Returns: String

Definition at line 907 of file PKPReviewerGridHandler.inc.php.

References _getReviewerFormClassName(), PKPHandler\getAuthorizedContextObject(), getReviewRound(), and getSubmission().

Referenced by reloadReviewerForm(), and showReviewerForm().

◆ _getAuthorDeniedBlindOps()

PKPReviewerGridHandler::_getAuthorDeniedBlindOps ( )

protected

Get additional operations that an author is not allowed to access when the review type is blind or double-blind.

Returns: array

Definition at line 993 of file PKPReviewerGridHandler.inc.php.

Referenced by authorize().

◆ _getAuthorDeniedOps()

PKPReviewerGridHandler::_getAuthorDeniedOps ( )

protected

Get operations that an author is not allowed to access regardless of review type.

Returns: array

Definition at line 968 of file PKPReviewerGridHandler.inc.php.

Referenced by authorize().

◆ _getReviewAssignmentOps()

PKPReviewerGridHandler::_getReviewAssignmentOps ( )

Get operations that need a review assignment policy.

Returns: array

Definition at line 943 of file PKPReviewerGridHandler.inc.php.

Referenced by __construct(), and authorize().

◆ _getReviewerFormClassName()

PKPReviewerGridHandler::_getReviewerFormClassName ( $selectionType )

Get the name of ReviewerForm class for the current selection type.

Parameters

$selectionType String (const)

Returns: FormClassName String

Definition at line 927 of file PKPReviewerGridHandler.inc.php.

Referenced by _fetchReviewerForm(), and updateReviewer().

◆ _getReviewRoundOps()

PKPReviewerGridHandler::_getReviewRoundOps ( )

Get operations that need a review round policy.

Returns: array

Definition at line 953 of file PKPReviewerGridHandler.inc.php.

Referenced by __construct(), and authorize().

◆ authorize()

PKPReviewerGridHandler::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 GridHandler.

Reimplemented in AuthorReviewerGridHandler.

Definition at line 80 of file PKPReviewerGridHandler.inc.php.

References _getAuthorDeniedBlindOps(), _getAuthorDeniedOps(), _getReviewAssignmentOps(), _getReviewRoundOps(), PKPHandler\addPolicy(), and PKPHandler\getAuthorizedContextObject().

◆ createReviewer()

PKPReviewerGridHandler::createReviewer	(	$args,
		$request
	)

Create a new user as reviewer.

Parameters

$args	Array
$request	Request

Returns: string Serialized JSON object

Definition at line 330 of file PKPReviewerGridHandler.inc.php.

References updateReviewer().

◆ editReminder()

PKPReviewerGridHandler::editReminder	(	$args,
		$request
	)

Displays a modal to allow the editor to enter a message to send to the reviewer as a reminder

Parameters

$args	array
$request	PKPRequest

Returns: string Serialized JSON object

Definition at line 736 of file PKPReviewerGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

◆ editReview()

PKPReviewerGridHandler::editReview	(	$args,
		$request
	)

Manage reviewer access to files

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 373 of file PKPReviewerGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

◆ editThankReviewer()

PKPReviewerGridHandler::editThankReviewer	(	$args,
		$request
	)

Displays a modal to allow the editor to enter a message to send to the reviewer as a thank you.

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 633 of file PKPReviewerGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

◆ enrollReviewer()

PKPReviewerGridHandler::enrollReviewer	(	$args,
		$request
	)

Enroll an existing user as reviewer.

Parameters

$args	Array
$request	Request

Returns: string Serialized JSON object

Definition at line 340 of file PKPReviewerGridHandler.inc.php.

References updateReviewer().

◆ fetchTemplateBody()

PKPReviewerGridHandler::fetchTemplateBody	(	$args,
		$request
	)

Fetches an email template's message body and returns it via AJAX.

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 875 of file PKPReviewerGridHandler.inc.php.

References getSubmission().

◆ getRequestArgs()

PKPReviewerGridHandler::getRequestArgs ( )

See also: GridHandler::getRequestArgs()

Reimplemented from GridHandler.

Definition at line 278 of file PKPReviewerGridHandler.inc.php.

References getReviewRound(), and getSubmission().

Referenced by gossip(), and initialize().

◆ getReviewRound()

PKPReviewerGridHandler::getReviewRound ( )

Get review round object.

Returns: ReviewRound

Definition at line 162 of file PKPReviewerGridHandler.inc.php.

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

Referenced by _fetchReviewerForm(), getRequestArgs(), AuthorReviewerGridHandler\loadData(), loadData(), reinstateReviewer(), unassignReviewer(), updateReinstateReviewer(), updateReviewer(), and updateUnassignReviewer().

◆ getRowInstance()

PKPReviewerGridHandler::getRowInstance ( )

protected

See also: GridHandler::getRowInstance()

Returns: ReviewerGridRow

Reimplemented from GridHandler.

Reimplemented in AuthorReviewerGridHandler.

Definition at line 271 of file PKPReviewerGridHandler.inc.php.

◆ getStageId()

PKPReviewerGridHandler::getStageId ( )

Get the review stage id.

Returns: integer

Definition at line 154 of file PKPReviewerGridHandler.inc.php.

References $_stageId.

◆ getSubmission()

PKPReviewerGridHandler::getSubmission ( )

Get the authorized submission.

Returns: Submission

Definition at line 146 of file PKPReviewerGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

Referenced by _fetchReviewerForm(), fetchTemplateBody(), getRequestArgs(), AuthorReviewerGridHandler\readReview(), readReview(), reinstateReviewer(), ReviewerGridHandler\reviewRead(), unassignReviewer(), unconsiderReview(), updateReinstateReviewer(), updateReviewer(), and updateUnassignReviewer().

◆ getUsersNotAssignedAsReviewers()

PKPReviewerGridHandler::getUsersNotAssignedAsReviewers	(	$args,
		$request
	)

Get a list of all non-reviewer users in the system to populate the reviewer role assignment autocomplete.

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 406 of file PKPReviewerGridHandler.inc.php.

References DAORegistry\getDAO(), and GridHandler\noAutocompleteResults().

◆ gossip()

PKPReviewerGridHandler::gossip	(	$args,
		$request
	)

Displays a modal containing the gossip values for a reviewer

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 836 of file PKPReviewerGridHandler.inc.php.

References PKPServices\get(), PKPHandler\getAuthorizedContextObject(), DAORegistry\getDAO(), and getRequestArgs().

◆ initialize()

PKPReviewerGridHandler::initialize	(	$request,
		$args = `null`
	)

See also: PKPHandler::initialize()

Parameters

$request	PKPRequest
$args	array optional

Reimplemented from GridHandler.

Reimplemented in AuthorReviewerGridHandler.

Definition at line 182 of file PKPReviewerGridHandler.inc.php.

References GridHandler\addAction(), GridHandler\addColumn(), getRequestArgs(), AppLocale\requireComponents(), and GridHandler\setTitle().

◆ loadData()

PKPReviewerGridHandler::loadData	(	$request,
		$filter
	)

protected

See also: GridHandler::loadData()

Reimplemented from GridHandler.

Reimplemented in AuthorReviewerGridHandler.

Definition at line 291 of file PKPReviewerGridHandler.inc.php.

References DAORegistry\getDAO(), and getReviewRound().

◆ readReview()

PKPReviewerGridHandler::readReview	(	$args,
		$request
	)

Open a modal to read the reviewer's review and download any files they may have uploaded

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Reimplemented in AuthorReviewerGridHandler.

Definition at line 653 of file PKPReviewerGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), Application\getContextAssocType(), DAORegistry\getDAO(), PKPTemplateManager\getManager(), ReviewAssignment\getReviewerRecommendationOptions(), and getSubmission().

◆ reinstateReviewer()

PKPReviewerGridHandler::reinstateReviewer	(	$args,
		$request
	)

Reinstate a reviewer

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 450 of file PKPReviewerGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), getReviewRound(), and getSubmission().

◆ reloadReviewerForm()

PKPReviewerGridHandler::reloadReviewerForm	(	$args,
		$request
	)

Load the contents of the reviewer form

Parameters

$args	array
$request	Request

Returns: JSONMessage JSON object

Definition at line 318 of file PKPReviewerGridHandler.inc.php.

References _fetchReviewerForm().

◆ reviewHistory()

PKPReviewerGridHandler::reviewHistory	(	$args,
		$request
	)

Displays a modal containing history for the review assignment.

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 811 of file PKPReviewerGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), and PKPTemplateManager\getManager().

◆ reviewRead()

PKPReviewerGridHandler::reviewRead	(	$args,
		$request
	)

Mark the review as read and trigger a rewrite of the row.

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Reimplemented in ReviewerGridHandler.

Definition at line 560 of file PKPReviewerGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), Core\getCurrentDate(), DAORegistry\getDAO(), DAO\getDataChangedEvent(), and SubmissionLog\logEvent().

◆ sendEmail()

PKPReviewerGridHandler::sendEmail	(	$args,
		$request
	)

Displays a modal to send an email message to the user.

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 780 of file PKPReviewerGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

◆ sendReminder()

PKPReviewerGridHandler::sendReminder	(	$args,
		$request
	)

Send the reviewer reminder and close the modal

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 755 of file PKPReviewerGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

◆ showReviewerForm()

PKPReviewerGridHandler::showReviewerForm	(	$args,
		$request
	)

Add a reviewer.

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 308 of file PKPReviewerGridHandler.inc.php.

References _fetchReviewerForm().

◆ thankReviewer()

PKPReviewerGridHandler::thankReviewer	(	$args,
		$request
	)

Send the acknowledgement email, if desired, and trigger a row refresh action.

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 707 of file PKPReviewerGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), and DAO\getDataChangedEvent().

◆ unassignReviewer()

PKPReviewerGridHandler::unassignReviewer	(	$args,
		$request
	)

Unassign a reviewer

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 432 of file PKPReviewerGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), getReviewRound(), and getSubmission().

◆ unconsiderReview()

PKPReviewerGridHandler::unconsiderReview	(	$args,
		$request
	)

An action triggered by a confirmation modal to allow an editor to unconsider a review.

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 517 of file PKPReviewerGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), Core\getCurrentDate(), DAORegistry\getDAO(), DAO\getDataChangedEvent(), getSubmission(), and SubmissionLog\logEvent().

◆ updateReinstateReviewer()

PKPReviewerGridHandler::updateReinstateReviewer	(	$args,
		$request
	)

Save the reviewer reinstatement

Parameters

mixed	$args
	$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 468 of file PKPReviewerGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), DAO\getDataChangedEvent(), getReviewRound(), and getSubmission().

◆ updateReview()

PKPReviewerGridHandler::updateReview	(	$args,
		$request
	)

Save a change to reviewer access to files

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 387 of file PKPReviewerGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), and DAO\getDataChangedEvent().

◆ updateReviewer()

PKPReviewerGridHandler::updateReviewer	(	$args,
		$request
	)

Edit a reviewer

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 350 of file PKPReviewerGridHandler.inc.php.

References _getReviewerFormClassName(), DAO\getDataChangedEvent(), getReviewRound(), and getSubmission().

Referenced by createReviewer(), and enrollReviewer().

◆ updateUnassignReviewer()

PKPReviewerGridHandler::updateUnassignReviewer	(	$args,
		$request
	)

Save the reviewer unassignment

Parameters

mixed	$args
	$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 493 of file PKPReviewerGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), DAO\getDataChangedEvent(), getReviewRound(), and getSubmission().

Field Documentation

◆ $_isCurrentUserAssignedAuthor

boolean PKPReviewerGridHandler::$_isCurrentUserAssignedAuthor

Is the current user assigned as an author to this submission

Definition at line 46 of file PKPReviewerGridHandler.inc.php.

◆ $_stageId

integer PKPReviewerGridHandler::$_stageId

Definition at line 40 of file PKPReviewerGridHandler.inc.php.

Referenced by getStageId().

◆ $_submission

Submission PKPReviewerGridHandler::$_submission

Definition at line 34 of file PKPReviewerGridHandler.inc.php.

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

PKPReviewerGridHandler.inc.php

Public Member Functions

Data Fields

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _fetchReviewerForm()

◆ _getAuthorDeniedBlindOps()

◆ _getAuthorDeniedOps()

◆ _getReviewAssignmentOps()

◆ _getReviewerFormClassName()

◆ _getReviewRoundOps()

◆ authorize()

◆ createReviewer()

◆ editReminder()

◆ editReview()

◆ editThankReviewer()

◆ enrollReviewer()

◆ fetchTemplateBody()

◆ getRequestArgs()

◆ getReviewRound()

◆ getRowInstance()

◆ getStageId()

◆ getSubmission()

◆ getUsersNotAssignedAsReviewers()

◆ gossip()

◆ initialize()

◆ loadData()

◆ readReview()

◆ reinstateReviewer()

◆ reloadReviewerForm()

◆ reviewHistory()

◆ reviewRead()

◆ sendEmail()

◆ sendReminder()

◆ showReviewerForm()

◆ thankReviewer()

◆ unassignReviewer()

◆ unconsiderReview()

◆ updateReinstateReviewer()

◆ updateReview()

◆ updateReviewer()

◆ updateUnassignReviewer()

Field Documentation

◆ $_isCurrentUserAssignedAuthor

◆ $_stageId

◆ $_submission