Open Journal Systems  3.3.0
AddParticipantForm Class Reference
Inheritance diagram for AddParticipantForm:
StageParticipantNotifyForm PKPStageParticipantNotifyForm Form

Public Member Functions

 __construct ($submission, $stageId, $assignmentId=null)
 
 execute (... $functionParams)
 
 fetch ($request, $template=null, $display=false)
 
 getSubmission ()
 
 initialize ()
 
 isMessageRequired ()
 
 readInputData ()
 
 validate ($callHooks=true)
 
- Public Member Functions inherited from StageParticipantNotifyForm
 __construct ($itemId, $itemType, $stageId, $template=null)
 
- Public Member Functions inherited from PKPStageParticipantNotifyForm
 _logEventAndCreateNotification ($request, $submission)
 
 getEmailVariableNames ($emailKey)
 
 getStageId ()
 
 sendMessage ($userId, $submission, $request)
 
- Public Member Functions inherited from Form
 _decomposeArray ($name, $value, $stack)
 
 addCheck ($formValidator)
 
 addError ($field, $message)
 
 addErrorField ($field)
 
 addSupportedFormLocale ($supportedLocale)
 
 display ($request=null, $template=null)
 
 getData ($key)
 
 getDefaultFormLocale ()
 
 getErrorsArray ()
 
 getLocaleFieldNames ()
 
 getRequiredLocale ()
 
 getTemplate ()
 
 initData ()
 
 isValid ()
 
 readUserVars ($vars)
 
 setData ($key, $value=null)
 
 setDefaultFormLocale ($defaultLocale)
 
 setTemplate ($template)
 

Data Fields

 $_assignmentId
 
 $_contextId
 
 $_managerGroupIds
 
 $_possibleRecommendOnlyUserGroupIds
 
 $_submission
 
- Data Fields inherited from PKPStageParticipantNotifyForm
 $_itemId
 
 $_itemType
 
 $_stageId
 
 $_submissionId
 
- Data Fields inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $defaultLocale
 
 $errorFields
 
 $errorsArray
 
 $formSectionErrors
 
 $requiredLocale
 
 $supportedLocales
 

Protected Member Functions

 _isChangePermitMetadataAllowed ($userGroupId)
 
 _isChangeRecommendOnlyAllowed ($userGroupId)
 
- Protected Member Functions inherited from StageParticipantNotifyForm
 _getMailTemplate ($submission, $templateKey, $includeSignature=true)
 
 _getStageTemplates ()
 

Detailed Description

Form for adding a stage participant.

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

Constructor & Destructor Documentation

◆ __construct()

AddParticipantForm::__construct (   $submission,
  $stageId,
  $assignmentId = null 
)

Constructor.

Parameters
$submissionSubmission
$stageIdint STAGE_ID_...
$assignmentIdint Optional - Used for edit the assignment

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

References Form\addCheck(), and initialize().

Member Function Documentation

◆ _isChangePermitMetadataAllowed()

AddParticipantForm::_isChangePermitMetadataAllowed (   $userGroupId)
protected

Determine whether the specified user group is potentially restricted from editing metadata.

Parameters
$userGroupIdint
Returns
boolean

Definition at line 99 of file AddParticipantForm.inc.php.

Referenced by execute().

◆ _isChangeRecommendOnlyAllowed()

AddParticipantForm::_isChangeRecommendOnlyAllowed (   $userGroupId)
protected

Determine whether the specified group is potentially required to make recommendations rather than decisions.

Parameters
$userGroupIdint
Returns
boolean

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

Referenced by execute().

◆ execute()

AddParticipantForm::execute (   $functionParams)

◆ fetch()

AddParticipantForm::fetch (   $request,
  $template = null,
  $display = false 
)

Returns a string of the rendered form

Parameters
$requestPKPRequest
$templatestring the template to be rendered, mandatory if no template has been specified on class instantiation.
$displayboolean
Returns
string the rendered form

Reimplemented from PKPStageParticipantNotifyForm.

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

References DAORegistry\getDAO(), PKPTemplateManager\getManager(), PKPStageParticipantNotifyForm\getStageId(), and getSubmission().

◆ getSubmission()

AddParticipantForm::getSubmission ( )

Get the Submission

Returns
Submission

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

References $_submission.

Referenced by execute(), fetch(), and validate().

◆ initialize()

AddParticipantForm::initialize ( )

Initialize private attributes that need to be used through all functions.

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

References DAORegistry\getDAO().

Referenced by __construct().

◆ isMessageRequired()

AddParticipantForm::isMessageRequired ( )

whether or not to require a message field

Returns
boolean

Reimplemented from PKPStageParticipantNotifyForm.

Definition at line 267 of file AddParticipantForm.inc.php.

◆ readInputData()

AddParticipantForm::readInputData ( )

Assign form data to user-submitted data. Can be overridden from subclasses.

Reimplemented from PKPStageParticipantNotifyForm.

Definition at line 200 of file AddParticipantForm.inc.php.

References Form\readUserVars().

◆ validate()

AddParticipantForm::validate (   $callHooks = true)

Validate form data.

Parameters
$callHooksboolean True (default) iff hooks are to be called.

Reimplemented from Form.

Definition at line 214 of file AddParticipantForm.inc.php.

References DAORegistry\getDAO(), Form\getData(), and getSubmission().

Field Documentation

◆ $_assignmentId

$_assignmentId AddParticipantForm::$_assignmentId

int Used for edit the assignment *

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

◆ $_contextId

$_contextId AddParticipantForm::$_contextId

int the current Context Id *

Definition at line 47 of file AddParticipantForm.inc.php.

◆ $_managerGroupIds

$_managerGroupIds AddParticipantForm::$_managerGroupIds

array Contains all manager group_ids *

Definition at line 35 of file AddParticipantForm.inc.php.

◆ $_possibleRecommendOnlyUserGroupIds

$_possibleRecommendOnlyUserGroupIds AddParticipantForm::$_possibleRecommendOnlyUserGroupIds

array Contains all group_ids that can have the recommendOnly field available for change *

Definition at line 41 of file AddParticipantForm.inc.php.

◆ $_submission

Submission AddParticipantForm::$_submission

The submission associated with the submission contributor being edited *

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

Referenced by getSubmission().


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