Public Member Functions

ReviewerGridHandler Class Reference

Handle reviewer grid requests. More...

List of all members.

Public Member Functions

 _fetchReviewerForm ($args, &$request)
 _getReviewAssignmentOps ()
 _getReviewerFormClassName ($selectionType)
 _getReviewRoundOps ()
 _updateReviewRoundStatus ($reviewAssignment)
 authorize (&$request, $args, $roleAssignments)
 createReviewer ($args, &$request)
 deleteReviewer ($args, &$request)
 editReminder ($args, &$request)
 editThankReviewer ($args, &$request)
 enrollReviewer ($args, &$request)
& getMonograph ()
 getRequestArgs ()
 getReviewersNotAssignedToMonograph ($args, &$request)
& getReviewRound ()
& getRowInstance ()
 getStageId ()
 getUsersNotAssignedAsReviewers ($args, &$request)
 loadData ($request, $filter)
 readReview ($args, &$request)
 reloadReviewerForm ($args, &$request)
 ReviewerGridHandler ()
 reviewHistory ($args, &$request)
 reviewRead ($args, &$request)
 sendEmail ($args, &$request)
 sendReminder ($args, &$request)
 showReviewerForm ($args, &$request)
 thankReviewer ($args, &$request)
 unconsiderReview ($args, &$request)
 updateReviewer ($args, &$request)

Detailed Description

Handle reviewer grid requests.

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

Member Function Documentation

ReviewerGridHandler._fetchReviewerForm ( $  args,
&$  request 
)

Return a fetched reviewer form data in string.

Parameters:
$args Array
$request Request
Returns:
String

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

References _getReviewerFormClassName(), getMonograph(), and getReviewRound().

Referenced by reloadReviewerForm(), and showReviewerForm().

ReviewerGridHandler._getReviewAssignmentOps (  ) 

Get operations that need a review assignment policy.

Returns:
array

Definition at line 670 of file ReviewerGridHandler.inc.php.

Referenced by authorize(), and ReviewerGridHandler().

ReviewerGridHandler._getReviewerFormClassName ( $  selectionType  ) 

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

Parameters:
$selectionType String (const)
Returns:
FormClassName String

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

Referenced by _fetchReviewerForm(), and updateReviewer().

ReviewerGridHandler._getReviewRoundOps (  ) 

Get operations that need a review round policy.

Returns:
array

Definition at line 680 of file ReviewerGridHandler.inc.php.

Referenced by authorize(), and ReviewerGridHandler().

ReviewerGridHandler._updateReviewRoundStatus ( $  reviewAssignment  ) 

Update the review round status.

Definition at line 689 of file ReviewerGridHandler.inc.php.

References getMonograph().

Referenced by reviewRead(), thankReviewer(), and unconsiderReview().

ReviewerGridHandler.authorize ( &$  request,
$  args,
$  roleAssignments 
)
See also:
PKPHandler.authorize()
Parameters:
$request PKPRequest
$args array
$roleAssignments array

Definition at line 108 of file ReviewerGridHandler.inc.php.

References _getReviewAssignmentOps(), and _getReviewRoundOps().

ReviewerGridHandler.createReviewer ( $  args,
&$  request 
)

Create a new user as reviewer.

Parameters:
$args Array
$request Request
Returns:
string Serialized JSON object

Definition at line 260 of file ReviewerGridHandler.inc.php.

References updateReviewer().

ReviewerGridHandler.deleteReviewer ( $  args,
&$  request 
)

Delete a reviewer

Parameters:
$args array
$request PKPRequest
Returns:
string Serialized JSON object

Definition at line 305 of file ReviewerGridHandler.inc.php.

References getMonograph().

ReviewerGridHandler.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 544 of file ReviewerGridHandler.inc.php.

ReviewerGridHandler.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:
string Serialized JSON object

Definition at line 494 of file ReviewerGridHandler.inc.php.

ReviewerGridHandler.enrollReviewer ( $  args,
&$  request 
)

Enroll an existing user as reviewer.

Parameters:
$args Array
$request Request
Returns:
string Serialized JSON object

Definition at line 270 of file ReviewerGridHandler.inc.php.

References updateReviewer().

& ReviewerGridHandler.getMonograph (  ) 

Get the authorized monograph.

Returns:
Monograph

Definition at line 70 of file ReviewerGridHandler.inc.php.

Referenced by _fetchReviewerForm(), _updateReviewRoundStatus(), deleteReviewer(), getRequestArgs(), getReviewersNotAssignedToMonograph(), getUsersNotAssignedAsReviewers(), loadData(), readReview(), unconsiderReview(), and updateReviewer().

ReviewerGridHandler.getRequestArgs (  ) 
See also:
GridHandler.getRequestArgs()

Definition at line 207 of file ReviewerGridHandler.inc.php.

References getMonograph(), getReviewRound(), and getStageId().

ReviewerGridHandler.getReviewersNotAssignedToMonograph ( $  args,
&$  request 
)

Get potential reviewers for editor's reviewer selection autocomplete.

Parameters:
$args array
$request PKPRequest
Returns:
string Serialized JSON object

Definition at line 332 of file ReviewerGridHandler.inc.php.

References getMonograph(), and getReviewRound().

& ReviewerGridHandler.getReviewRound (  ) 

Get review round object.

Returns:
ReviewRound

Definition at line 86 of file ReviewerGridHandler.inc.php.

Referenced by _fetchReviewerForm(), getRequestArgs(), getReviewersNotAssignedToMonograph(), loadData(), and updateReviewer().

& ReviewerGridHandler.getRowInstance (  ) 
See also:
GridHandler.getRowInstance()
Returns:
ReviewerGridRow

Definition at line 199 of file ReviewerGridHandler.inc.php.

ReviewerGridHandler.getStageId (  ) 

Get the review stage id.

Returns:
integer

Definition at line 78 of file ReviewerGridHandler.inc.php.

Referenced by getRequestArgs(), and loadData().

ReviewerGridHandler.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:
string Serialized JSON object

Definition at line 363 of file ReviewerGridHandler.inc.php.

References getMonograph().

ReviewerGridHandler.loadData ( $  request,
$  filter 
)
See also:
GridHandler.loadData()

Definition at line 220 of file ReviewerGridHandler.inc.php.

References getMonograph(), getReviewRound(), and getStageId().

ReviewerGridHandler.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:
string serialized JSON object

Definition at line 393 of file ReviewerGridHandler.inc.php.

References getMonograph().

ReviewerGridHandler.reloadReviewerForm ( $  args,
&$  request 
)

Load the contents of the reviewer form

Parameters:
$args array
$request Request
Returns:
string JSON

Definition at line 248 of file ReviewerGridHandler.inc.php.

References _fetchReviewerForm().

ReviewerGridHandler.ReviewerGridHandler (  ) 

Constructor

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

References _getReviewAssignmentOps(), and _getReviewRoundOps().

ReviewerGridHandler.reviewHistory ( $  args,
&$  request 
)

Displays a modal containing history for the review assignment.

Parameters:
$args array
$request PKPRequest
Returns:
string Serialized JSON object

Definition at line 611 of file ReviewerGridHandler.inc.php.

ReviewerGridHandler.reviewRead ( $  args,
&$  request 
)

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

Parameters:
$args array
$request PKPRequest
Returns:
string serialized JSON object

Definition at line 467 of file ReviewerGridHandler.inc.php.

References _updateReviewRoundStatus().

ReviewerGridHandler.sendEmail ( $  args,
&$  request 
)

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

Parameters:
$args array
$request PKPRequest
Returns:
string Serialized JSON object

Definition at line 590 of file ReviewerGridHandler.inc.php.

ReviewerGridHandler.sendReminder ( $  args,
&$  request 
)

Send the reviewer reminder and close the modal

Parameters:
$args array
$request PKPRequest
Returns:
string Serialized JSON object

Definition at line 564 of file ReviewerGridHandler.inc.php.

ReviewerGridHandler.showReviewerForm ( $  args,
&$  request 
)

Add a reviewer.

Parameters:
$args array
$request PKPRequest
Returns:
string Serialized JSON object

Definition at line 237 of file ReviewerGridHandler.inc.php.

References _fetchReviewerForm().

ReviewerGridHandler.thankReviewer ( $  args,
&$  request 
)

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

Parameters:
$args array
$request PKPRequest
Returns:
string serialized JSON object

Definition at line 514 of file ReviewerGridHandler.inc.php.

References _updateReviewRoundStatus().

ReviewerGridHandler.unconsiderReview ( $  args,
&$  request 
)

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

Parameters:
$args array
$request PKPRequest
Returns:
string serialized JSON object

Definition at line 418 of file ReviewerGridHandler.inc.php.

References _updateReviewRoundStatus(), getMonograph(), and MonographLog.logEvent().

ReviewerGridHandler.updateReviewer ( $  args,
&$  request 
)

Edit a reviewer

Parameters:
$args array
$request PKPRequest
Returns:
string Serialized JSON object

Definition at line 280 of file ReviewerGridHandler.inc.php.

References _getReviewerFormClassName(), getMonograph(), and getReviewRound().

Referenced by createReviewer(), and enrollReviewer().

The documentation for this class was generated from the following file:
Generated on Mon Sep 17 2012 13:58:58 for Open Monograph Press by  doxygen 1.7.1