Inheritance diagram for PKPStageParticipantNotifyForm:

Public Member Functions
	__construct ($itemId, $itemType, $stageId, $template=null)

	_logEventAndCreateNotification ($request, $submission)

	execute (... $functionParams)

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

	getEmailVariableNames ($emailKey)

	getStageId ()

	isMessageRequired ()

	readInputData ()

	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)

	validate ($callHooks=true)

Data Fields
	$_itemId

	$_itemType

	$_stageId

	$_submissionId

Data Fields inherited from Form
	$_checks

	$_data

	$_errors

	$_template

	$cssValidation

	$defaultLocale

	$errorFields

	$errorsArray

	$formSectionErrors

	$requiredLocale

	$supportedLocales

Protected Member Functions
	_getMailTemplate ($submission, $templateKey, $includeSignature=true)

	_getStageTemplates ()

Detailed Description

Form to notify a user regarding a file.

Definition at line 19 of file PKPStageParticipantNotifyForm.inc.php.

Constructor & Destructor Documentation

◆ __construct()

PKPStageParticipantNotifyForm::__construct	(	$itemId,
		$itemType,
		$stageId,
		$template = `null`
	)

Constructor.

Reimplemented from Form.

Reimplemented in StageParticipantNotifyForm.

Definition at line 44 of file PKPStageParticipantNotifyForm.inc.php.

References Form\addCheck(), DAORegistry\getDAO(), and isMessageRequired().

Member Function Documentation

◆ _getMailTemplate()

PKPStageParticipantNotifyForm::_getMailTemplate	(	$submission,
		$templateKey,
		$includeSignature = `true`
	)

abstractprotected

Return app-specific mail template.

Parameters

$submission	Submission
$templateKey	string
$includeSignature	boolean

Returns: SubmissionMailTemplate

Reimplemented in StageParticipantNotifyForm.

Referenced by fetch(), and sendMessage().

◆ _getStageTemplates()

PKPStageParticipantNotifyForm::_getStageTemplates ( )

abstractprotected

return app-specific stage templates.

Returns: array

Reimplemented in StageParticipantNotifyForm.

Referenced by fetch().

◆ _logEventAndCreateNotification()

PKPStageParticipantNotifyForm::_logEventAndCreateNotification	(	$request,
		$submission
	)

Convenience function for logging the message sent event and creating the notification.

Parameters

$request	PKPRequest
$submission	Submission

Definition at line 338 of file PKPStageParticipantNotifyForm.inc.php.

References SubmissionLog\logEvent().

Referenced by execute().

◆ execute()

PKPStageParticipantNotifyForm::execute ( $functionParams )

Execute the form's action. (Note that it is assumed that the form has already been validated.)

Parameters

mixed $functionArgs,... Arguments from the caller to be passed to the hook consumer

Returns: mixed Result from the consumer to be passed to the caller. Send a true-ish result if you want the caller to do something with the return value.

Reimplemented from Form.

Reimplemented in AddParticipantForm.

Definition at line 142 of file PKPStageParticipantNotifyForm.inc.php.

References _logEventAndCreateNotification(), PKPApplication\get(), DAORegistry\getDAO(), Form\getData(), and sendMessage().