PHP Class PKPStageParticipantNotifyForm, pkp-lib

Inheritance: extends Form
ファイルを表示 Open project: pkp/pkp-lib Class Usage Examples

Public Properties

Property Type Description
$_itemId The file/submission ID this form is for
$_itemType The type of item the form is for (used to determine which email template to use)
$_stageId The stage Id *
$_submissionId the Submission id

Public Methods

Method Description
__construct ( $itemId, $itemType, $stageId, $template = null ) Constructor.
deleteEntry ( $request, $rowId )
execute ( $request )
fetch ( $request )
getEmailVariableNames ( $emailKey ) : array Get the available email template variable names for the given template name.
getStageId ( ) : integer Get the stage ID
includeNotifyUsersListbuilder ( ) : boolean whether or not to include the Notify Users listbuilder true, by default.
insertEntry ( $request, $newRowId )
readInputData ( $request )
sendMessage ( $userId, $submission, $request ) Send a message to a user.

Protected Methods

Method Description
_getMailTemplate ( $submission, $templateKey, $includeSignature = true ) : array Return app-specific mail template.
_getStageTemplates ( ) : array return app-specific stage templates.

Private Methods

Method Description
_addAssignmentTaskNotification ( $request, $type, $userId, $submissionId ) Add upload task notifications.

Method Details

__construct() public method

Constructor.
public __construct ( $itemId, $itemType, $stageId, $template = null )

_getMailTemplate() abstract protected method

Return app-specific mail template.
abstract protected _getMailTemplate ( $submission, $templateKey, $includeSignature = true ) : array
$submission Submission
$templateKey string
$includeSignature boolean
return array

_getStageTemplates() abstract protected method

return app-specific stage templates.
abstract protected _getStageTemplates ( ) : array
return array

deleteEntry() public method

public deleteEntry ( $request, $rowId )

execute() public method

public execute ( $request )

fetch() public method

public fetch ( $request )

getEmailVariableNames() public method

Get the available email template variable names for the given template name.
public getEmailVariableNames ( $emailKey ) : array
$emailKey string Email template key
return array

getStageId() public method

Get the stage ID
public getStageId ( ) : integer
return integer

includeNotifyUsersListbuilder() public method

whether or not to include the Notify Users listbuilder true, by default.

insertEntry() public method

public insertEntry ( $request, $newRowId )

readInputData() public method

public readInputData ( $request )

sendMessage() public method

Send a message to a user.
public sendMessage ( $userId, $submission, $request )
$userId int the user id to send email to.
$submission Submission
$request PKPRequest

Property Details

$_itemId public_oe property

The file/submission ID this form is for
public $_itemId

$_itemType public_oe property

The type of item the form is for (used to determine which email template to use)
public $_itemType

$_stageId public_oe property

The stage Id *
public $_stageId

$_submissionId public_oe property

the Submission id
public $_submissionId