PHP Класс OEModule\OphCoMessaging\components\MessageCreator

Create a Message event
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$episode Episode
$messageData array
$messageTemplate string
$recipient User
$sender User
$type OEModule\OphCoMessaging\models\OphCoMessaging_Message_MessageType

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

Метод Описание
__construct ( Episode $episode, User $sender, User $recipient, OphCoMessaging_Message_MessageType $type ) MessageCreator constructor.
emailAlert ( array $recipients, $subject, $content ) : mixed Sends an email alert when a message is created
save ( $message = '', string $source = '' ) : Element_OphCoMessaging_Message
setMessageData ( array $data )
setMessageTemplate ( $template )

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

Метод Описание
getEventType ( ) : CActiveRecord
renderTemplate ( ) : string

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

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

MessageCreator constructor.
public __construct ( Episode $episode, User $sender, User $recipient, OphCoMessaging_Message_MessageType $type )
$episode Episode
$sender User
$recipient User
$type OEModule\OphCoMessaging\models\OphCoMessaging_Message_MessageType

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

Sends an email alert when a message is created
public emailAlert ( array $recipients, $subject, $content ) : mixed
$recipients array
$subject
$content
Результат mixed

getEventType() защищенный Метод

protected getEventType ( ) : CActiveRecord
Результат CActiveRecord

renderTemplate() защищенный Метод

protected renderTemplate ( ) : string
Результат string

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

public save ( $message = '', string $source = '' ) : Element_OphCoMessaging_Message
$message
$source string
Результат OEModule\OphCoMessaging\models\Element_OphCoMessaging_Message

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

public setMessageData ( array $data )
$data array

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

public setMessageTemplate ( $template )
$template

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

$episode защищенное свойство

protected Episode $episode
Результат Episode

$messageData защищенное свойство

protected array $messageData
Результат array

$messageTemplate защищенное свойство

protected string $messageTemplate
Результат string

$recipient защищенное свойство

protected User $recipient
Результат User

$sender защищенное свойство

protected User $sender
Результат User

$type защищенное свойство

protected OphCoMessaging_Message_MessageType,OEModule\OphCoMessaging\models $type
Результат OEModule\OphCoMessaging\models\OphCoMessaging_Message_MessageType