Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
ReviewerForm Class Reference
Inheritance diagram for ReviewerForm:
Form AdvancedSearchReviewerForm CreateReviewerForm EnrollExistingReviewerForm SearchByNameReviewerForm

Public Member Functions

 _getMailTemplateKey ($context)
 
 _isValidReviewer ($context, $submission, $reviewRound, $reviewerId)
 
 execute ($args, $request)
 
 fetch ($request)
 
 getReviewerFormActions ()
 
 getReviewRound ()
 
 getSearchByNameAction ($request)
 
 getSubmission ()
 
 getSubmissionId ()
 
 getUserRoles ()
 
 initData ($args, $request)
 
 readInputData ()
 
 ReviewerForm ($submission, $reviewRound)
 
 setReviewerFormAction ($action)
 
 setReviewRound ($reviewRound)
 
 setSubmission ($submission)
 
 setUserRoles ($userRoles)
 
- Public Member Functions inherited from Form
 _decomposeArray ($name, $value, $stack)
 
 addCheck ($formValidator)
 
 addError ($field, $message)
 
 addErrorField ($field)
 
 display ($request=null, $template=null)
 
 execute ($object=null)
 
 fetch ($request, $template=null, $display=false)
 
 Form ($template=null, $callHooks=true, $requiredLocale=null, $supportedLocales=null)
 
 getData ($key)
 
 getDefaultFormLocale ()
 
 getErrorsArray ()
 
 getFormLocale ()
 
 getLocaleFieldNames ()
 
 getRequiredLocale ()
 
 getTemplate ()
 
 initData ()
 
 isLocaleResubmit ()
 
 isValid ()
 
 readInputData ()
 
 readUserDateVars ($vars)
 
 readUserVars ($vars)
 
 setData ($key, $value)
 
 setTemplate ($template)
 
 smartyFormLanguageChooser ($params, &$smarty)
 
 validate ($callHooks=true)
 

Public Attributes

 $_reviewerFormActions
 
 $_reviewRound
 
 $_submission
 
 $_userRoles
 
- Public Attributes inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $errorFields
 
 $errorsArray
 
 $formSectionErrors
 
 $requiredLocale
 
 $supportedLocales
 

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 19 of file ReviewerForm.inc.php.

Member Function Documentation

ReviewerForm::_getMailTemplateKey (   $context)

Get the email template key depending on if reviewer one click access is enabled or not.

Parameters
mixed$contextContext
Returns
int Email template key

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

Referenced by fetch(), and initData().

ReviewerForm::_isValidReviewer (   $context,
  $submission,
  $reviewRound,
  $reviewerId 
)

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

Parameters
$contextContext
$submissionSubmission
$reviewRoundReviewRound
$reviewerIdint
Returns
boolean

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

References DAORegistry\getDAO().

Referenced by execute(), and initData().

ReviewerForm::execute (   $args,
  $request 
)

Save review assignment

Parameters
$argsarray
$requestPKPRequest

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

References _isValidReviewer(), Core\getCurrentDate(), DAORegistry\getDAO(), Form\getData(), getReviewRound(), getSubmission(), and getSubmissionId().

ReviewerForm::fetch (   $request)
ReviewerForm::getReviewerFormActions ( )

Get all of the reviewer form actions

Returns
array

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

References $_reviewerFormActions.

Referenced by fetch().

ReviewerForm::getReviewRound ( )
ReviewerForm::getSearchByNameAction (   $request)

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

Parameters
$requestRequest
Returns
LinkAction

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

References getReviewRound(), and getSubmissionId().

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

ReviewerForm::getSubmission ( )

Get the submission

Returns
Submission

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

References $_submission.

Referenced by execute(), fetch(), getSubmissionId(), and initData().

ReviewerForm::getSubmissionId ( )

Get the submission Id

Returns
int submissionId

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

References getSubmission().

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

ReviewerForm::getUserRoles ( )

Get current user roles.

Returns
$userRoles Array

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

References $_userRoles.

Referenced by SearchByNameReviewerForm\fetch().

ReviewerForm::initData (   $args,
  $request 
)

Initialize form data from the associated author.

Parameters
$argsarray
$requestPKPRequest

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

References _getMailTemplateKey(), _isValidReviewer(), DAORegistry\getDAO(), getReviewRound(), getSubmission(), getSubmissionId(), Config\getVar(), AppLocale\requireComponents(), and Form\setData().

ReviewerForm::readInputData ( )

Assign form data to user-submitted data.

See Also
Form::readInputData()

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

References Form\getData(), Form\readUserVars(), and Form\setData().

ReviewerForm::ReviewerForm (   $submission,
  $reviewRound 
)

Constructor.

Parameters
$submissionSubmission
$reviewRoundReviewRound

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

References Form\addCheck(), setReviewRound(), and setSubmission().

ReviewerForm::setReviewerFormAction (   $action)
ReviewerForm::setReviewRound (   $reviewRound)

Set the ReviewRound

Parameters
$reviewRoundReviewRound

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

Referenced by ReviewerForm().

ReviewerForm::setSubmission (   $submission)

Set the submission

Parameters
$submissionSubmission

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

Referenced by ReviewerForm().

ReviewerForm::setUserRoles (   $userRoles)

Set current user roles.

Parameters
$userRolesArray

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

Member Data Documentation

ReviewerForm::$_reviewerFormActions

An array of actions for the other reviewer forms

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

Referenced by getReviewerFormActions().

ReviewerForm::$_reviewRound

The review round associated with the review assignment

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

Referenced by getReviewRound().

ReviewerForm::$_submission

The submission associated with the review assignment

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

Referenced by getSubmission().

ReviewerForm::$_userRoles

An array with all current user roles

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

Referenced by getUserRoles().


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