PHP Класс PKPStageParticipantNotifyForm, pkp-lib

Наследование: extends Form
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$_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

Открытые методы

Метод Описание
__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.

Защищенные методы

Метод Описание
_getMailTemplate ( $submission, $templateKey, $includeSignature = true ) : array Return app-specific mail template.
_getStageTemplates ( ) : array return app-specific stage templates.

Приватные методы

Метод Описание
_addAssignmentTaskNotification ( $request, $type, $userId, $submissionId ) Add upload task notifications.

Описание методов

__construct() публичный Метод

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

_getMailTemplate() абстрактный защищенный Метод

Return app-specific mail template.
abstract protected _getMailTemplate ( $submission, $templateKey, $includeSignature = true ) : array
$submission Submission
$templateKey string
$includeSignature boolean
Результат array

_getStageTemplates() абстрактный защищенный Метод

return app-specific stage templates.
abstract protected _getStageTemplates ( ) : array
Результат array

deleteEntry() публичный Метод

public deleteEntry ( $request, $rowId )

execute() публичный Метод

public execute ( $request )

fetch() публичный Метод

public fetch ( $request )

getEmailVariableNames() публичный Метод

Get the available email template variable names for the given template name.
public getEmailVariableNames ( $emailKey ) : array
$emailKey string Email template key
Результат array

getStageId() публичный Метод

Get the stage ID
public getStageId ( ) : integer
Результат integer

includeNotifyUsersListbuilder() публичный Метод

whether or not to include the Notify Users listbuilder true, by default.
public includeNotifyUsersListbuilder ( ) : boolean
Результат boolean

insertEntry() публичный Метод

public insertEntry ( $request, $newRowId )

readInputData() публичный Метод

public readInputData ( $request )

sendMessage() публичный Метод

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

Описание свойств

$_itemId публичное свойство

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

$_itemType публичное свойство

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

$_stageId публичное свойство

The stage Id *
public $_stageId

$_submissionId публичное свойство

the Submission id
public $_submissionId