Public Member Functions | Protected Member Functions | Protected Attributes

NotifyBehavior Class Reference

Behavior class to send email notification to users. More...

List of all members.

Public Member Functions

 setup (&$model, $settings=array())
 afterSave ($model, $created)
 prepareUserSettingsMail ($userModel, $created)
 prepareAnnotationMail ($model, array &$users)
 prepareObjectChangeMail ($model, array &$users)
 prepareCustomMail (&$model, array &$users, $msgType, array &$params)
 create custom mail jobs using notify messages

Protected Member Functions

 createMailJob (array &$users, $msgType, array &$params)
 loadMessages ()
 getNotifyText ($msgType, $field, array &$params, $lang)
 Return well formatted notification text replacing markplace with related text.
 getContentUrl ($modData)
 return notificated content url

Protected Attributes

 $modelNameToUserField = array("Comment" => "comments", "EditorNote" => "notes")
 $notifyMsg = null

Detailed Description

Behavior class to send email notification to users.

Currenly handles this scenarios:

object has been modified

Version:
$Revision$ $LastChangedBy$ $LastChangedDate$

$Id$

Definition at line 37 of file notify.php.


Member Function Documentation

NotifyBehavior::getNotifyText ( msgType,
field,
array &$  params,
lang 
) [protected]

Return well formatted notification text replacing markplace with related text.

Parameters:
string $msgType the name (key) of notification message array (self::notifyMsg)
string $field the field of notification message array (self::notifyMsg)
array $params array of fields to replace in notification text. The key is the markplace and the value is the text that replace the markplace "title" => "my title", replace markplace [$title] with "my title"
string $lang language of notification
Returns:
string well formatted text ready to notify

Definition at line 245 of file notify.php.

NotifyBehavior::prepareCustomMail ( &$  model,
array &$  users,
msgType,
array &$  params 
)

create custom mail jobs using notify messages

Parameters:
Model $model
array $users
String $msgType
array $params

Definition at line 177 of file notify.php.


The documentation for this class was generated from the following file:
Generated on Fri Dec 11 2015 15:29:47 by Doxygen 1.7.1  BEditaBEdita 3.7 Corylus