Public Member Functions | Public Attributes

ReviewerForm Class Reference

Base Form for adding a reviewer to a submission. N.B. Requires a subclass to implement the "reviewerId" to be added. More...

Inheritance diagram for ReviewerForm:
AdvancedSearchReviewerForm AdvancedSearchReviewerForm CreateReviewerForm CreateReviewerForm EnrollExistingReviewerForm EnrollExistingReviewerForm SearchByNameReviewerForm SearchByNameReviewerForm

List of all members.

Public Member Functions

 _isValidReviewer (&$press, &$monograph, &$reviewRound, $reviewerId)
 _isValidReviewer (&$press, &$monograph, &$reviewRound, $reviewerId)
 execute ($args, &$request)
 execute ($args, &$request)
 fetch (&$request)
 fetch (&$request)
& getMonograph ()
& getMonograph ()
 getMonographId ()
 getMonographId ()
 getReviewerFormActions ()
 getReviewerFormActions ()
& getReviewRound ()
& getReviewRound ()
 getSearchByNameAction (&$request)
 getSearchByNameAction (&$request)
 getUserRoles ()
 getUserRoles ()
 initData ($args, &$request)
 initData ($args, &$request)
 readInputData ()
 readInputData ()
 ReviewerForm (&$monograph, &$reviewRound)
 ReviewerForm (&$monograph, &$reviewRound)
 setMonograph (&$monograph)
 setMonograph (&$monograph)
 setReviewerFormAction ($action)
 setReviewerFormAction ($action)
 setReviewRound (&$reviewRound)
 setReviewRound (&$reviewRound)
 setUserRoles ($userRoles)
 setUserRoles ($userRoles)

Public Attributes

 $_monograph
 $_reviewerFormActions
 $_reviewRound
 $_userRoles

Detailed Description

Base Form for adding a reviewer to a submission. N.B. Requires a subclass to implement the "reviewerId" to be added.

Definition at line 18 of file ReviewerForm.inc.php.

Member Function Documentation

ReviewerForm._isValidReviewer ( &$  press,
&$  monograph,
&$  reviewRound,
$  reviewerId 
)

Check if a given user id is enrolled in reviewer user group.

Parameters:
$press Press
$reviewerId int
Returns:
boolean

Definition at line 357 of file ReviewerForm.inc.php.

Referenced by execute(), and initData().

ReviewerForm._isValidReviewer ( &$  press,
&$  monograph,
&$  reviewRound,
$  reviewerId 
)

Check if a given user id is enrolled in reviewer user group.

Parameters:
$press Press
$reviewerId int
Returns:
boolean

Definition at line 357 of file ReviewerForm.inc.php.

ReviewerForm.execute ( $  args,
&$  request 
)

Save review assignment

Parameters:
$args array
$request PKPRequest

Reimplemented in CreateReviewerForm, EnrollExistingReviewerForm, CreateReviewerForm, and EnrollExistingReviewerForm.

Definition at line 264 of file ReviewerForm.inc.php.

References _isValidReviewer(), getMonographId(), and getReviewRound().

ReviewerForm.execute ( $  args,
&$  request 
)

Save review assignment

Parameters:
$args array
$request PKPRequest

Reimplemented in CreateReviewerForm, EnrollExistingReviewerForm, CreateReviewerForm, and EnrollExistingReviewerForm.

Definition at line 264 of file ReviewerForm.inc.php.

References _isValidReviewer(), getMonographId(), and getReviewRound().

ReviewerForm.fetch ( &$  request  ) 

Fetch

Parameters:
$request PKPRequest
See also:
Form.fetch()

Reimplemented in AdvancedSearchReviewerForm, CreateReviewerForm, EnrollExistingReviewerForm, SearchByNameReviewerForm, AdvancedSearchReviewerForm, CreateReviewerForm, EnrollExistingReviewerForm, and SearchByNameReviewerForm.

Definition at line 208 of file ReviewerForm.inc.php.

References getReviewerFormActions(), and getReviewRound().

Referenced by fetch().

ReviewerForm.fetch ( &$  request  ) 

Fetch

Parameters:
$request PKPRequest
See also:
Form.fetch()

Reimplemented in AdvancedSearchReviewerForm, CreateReviewerForm, EnrollExistingReviewerForm, SearchByNameReviewerForm, AdvancedSearchReviewerForm, CreateReviewerForm, EnrollExistingReviewerForm, and SearchByNameReviewerForm.

Definition at line 208 of file ReviewerForm.inc.php.

References fetch(), getReviewerFormActions(), and getReviewRound().

& ReviewerForm.getMonograph (  ) 

Get the Monograph

Returns:
Monograph

Definition at line 64 of file ReviewerForm.inc.php.

& ReviewerForm.getMonograph (  ) 

Get the Monograph

Returns:
Monograph

Definition at line 64 of file ReviewerForm.inc.php.

Referenced by getMonographId().

ReviewerForm.getMonographId (  ) 

Get the Monograph Id

Returns:
int monographId

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

References getMonograph().

ReviewerForm.getMonographId (  ) 

Get the Monograph Id

Returns:
int monographId

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

References getMonograph().

Referenced by execute(), getSearchByNameAction(), and initData().

ReviewerForm.getReviewerFormActions (  ) 

Get all of the reviewer form actions

Returns:
array

Definition at line 120 of file ReviewerForm.inc.php.

Referenced by fetch().

ReviewerForm.getReviewerFormActions (  ) 

Get all of the reviewer form actions

Returns:
array

Definition at line 120 of file ReviewerForm.inc.php.

& ReviewerForm.getReviewRound (  ) 

Get the ReviewRound

Returns:
ReviewRound

Definition at line 72 of file ReviewerForm.inc.php.

Referenced by execute(), SearchByNameReviewerForm.fetch(), fetch(), getSearchByNameAction(), and initData().

& ReviewerForm.getReviewRound (  ) 

Get the ReviewRound

Returns:
ReviewRound

Definition at line 72 of file ReviewerForm.inc.php.

ReviewerForm.getSearchByNameAction ( &$  request  ) 

Get the link action that fetchs the search by name form content.

Parameters:
$request Request
Returns:
LinkAction

Definition at line 331 of file ReviewerForm.inc.php.

References getMonographId(), and getReviewRound().

ReviewerForm.getSearchByNameAction ( &$  request  ) 

Get the link action that fetchs the search by name form content.

Parameters:
$request Request
Returns:
LinkAction

Definition at line 331 of file ReviewerForm.inc.php.

References getMonographId(), and getReviewRound().

Referenced by EnrollExistingReviewerForm.fetch(), CreateReviewerForm.fetch(), and AdvancedSearchReviewerForm.fetch().

ReviewerForm.getUserRoles (  ) 

Get current user roles.

Returns:
$userRoles Array

Definition at line 112 of file ReviewerForm.inc.php.

Referenced by SearchByNameReviewerForm.fetch().

ReviewerForm.getUserRoles (  ) 

Get current user roles.

Returns:
$userRoles Array

Definition at line 112 of file ReviewerForm.inc.php.

ReviewerForm.initData ( $  args,
&$  request 
)

Initialize form data from the associated author.

Parameters:
$args array
$request PKPRequest

Definition at line 131 of file ReviewerForm.inc.php.

References _isValidReviewer(), getMonographId(), and getReviewRound().

ReviewerForm.initData ( $  args,
&$  request 
)

Initialize form data from the associated author.

Parameters:
$args array
$request PKPRequest

Definition at line 131 of file ReviewerForm.inc.php.

References _isValidReviewer(), getMonographId(), and getReviewRound().

ReviewerForm.readInputData (  ) 

Assign form data to user-submitted data.

See also:
Form.readInputData()

Reimplemented in AdvancedSearchReviewerForm, CreateReviewerForm, EnrollExistingReviewerForm, SearchByNameReviewerForm, AdvancedSearchReviewerForm, CreateReviewerForm, EnrollExistingReviewerForm, and SearchByNameReviewerForm.

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

ReviewerForm.readInputData (  ) 

Assign form data to user-submitted data.

See also:
Form.readInputData()

Reimplemented in AdvancedSearchReviewerForm, CreateReviewerForm, EnrollExistingReviewerForm, SearchByNameReviewerForm, AdvancedSearchReviewerForm, CreateReviewerForm, EnrollExistingReviewerForm, and SearchByNameReviewerForm.

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

ReviewerForm.ReviewerForm ( &$  monograph,
&$  reviewRound 
)

Constructor.

Parameters:
$monograph Monograph
$reviewRound ReviewRound

Definition at line 36 of file ReviewerForm.inc.php.

References setMonograph(), and setReviewRound().

ReviewerForm.ReviewerForm ( &$  monograph,
&$  reviewRound 
)

Constructor.

Parameters:
$monograph Monograph
$reviewRound ReviewRound

Definition at line 36 of file ReviewerForm.inc.php.

References setMonograph(), and setReviewRound().

Referenced by AdvancedSearchReviewerForm.AdvancedSearchReviewerForm(), CreateReviewerForm.CreateReviewerForm(), EnrollExistingReviewerForm.EnrollExistingReviewerForm(), and SearchByNameReviewerForm.SearchByNameReviewerForm().

ReviewerForm.setMonograph ( &$  monograph  ) 

Set the Monograph

Parameters:
$monograph Monograph

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

ReviewerForm.setMonograph ( &$  monograph  ) 

Set the Monograph

Parameters:
$monograph Monograph

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

Referenced by ReviewerForm().

ReviewerForm.setReviewerFormAction ( $  action  ) 

Set a reviewer form action

Parameters:
$action LinkAction

Definition at line 96 of file ReviewerForm.inc.php.

ReviewerForm.setReviewerFormAction ( $  action  ) 

Set a reviewer form action

Parameters:
$action LinkAction

Definition at line 96 of file ReviewerForm.inc.php.

Referenced by SearchByNameReviewerForm.fetch(), EnrollExistingReviewerForm.fetch(), CreateReviewerForm.fetch(), and AdvancedSearchReviewerForm.fetch().

ReviewerForm.setReviewRound ( &$  reviewRound  ) 

Set the ReviewRound

Parameters:
$reviewRound ReviewRound

Definition at line 88 of file ReviewerForm.inc.php.

ReviewerForm.setReviewRound ( &$  reviewRound  ) 

Set the ReviewRound

Parameters:
$reviewRound ReviewRound

Definition at line 88 of file ReviewerForm.inc.php.

Referenced by ReviewerForm().

ReviewerForm.setUserRoles ( $  userRoles  ) 

Set current user roles.

Parameters:
$userRoles Array

Definition at line 104 of file ReviewerForm.inc.php.

ReviewerForm.setUserRoles ( $  userRoles  ) 

Set current user roles.

Parameters:
$userRoles Array

Definition at line 104 of file ReviewerForm.inc.php.

Member Data Documentation

ReviewerForm.$_monograph

The monograph associated with the review assignment

Definition at line 20 of file ReviewerForm.inc.php.

ReviewerForm.$_reviewerFormActions

An array of actions for the other reviewer forms

Definition at line 26 of file ReviewerForm.inc.php.

ReviewerForm.$_reviewRound

The review round associated with the review assignment

Definition at line 23 of file ReviewerForm.inc.php.

ReviewerForm.$_userRoles

An array with all current user roles

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

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