ProjectsNotificationUtil Class Reference

Inheritance diagram for ProjectsNotificationUtil:
NotificationsUtil

Static Public Member Functions

static submitProjectNotificationMessage (Project $project, $action, Task $task=null, User $relatedUser=null)
static resolvePeopleToSendNotification (Project $project, $action)
static getEmailMessageContent (Project $project, $action, Task $task=null, User $relatedUser=null)

Static Protected Member Functions

static processProjectNotification (NotificationMessage $message, ProjectNotificationRules $rule, $action)
static getNotificationMessageByAction (Project $project, $action, Task $task=null, User $relatedUser=null)
static sendProjectEmail (Notification $notification, ProjectNotificationRules $rule, $action)
static resolveNotificationRulesClassByAction ($action)

Detailed Description

Helper class for working with projects notification

Definition at line 40 of file ProjectsNotificationUtil.php.


Member Function Documentation

static submitProjectNotificationMessage ( Project project,
action,
Task task = null,
User relatedUser = null 
) [static]

Submit project notification message

Parameters:
Project $project
string $action
Task $task
null|User $relatedUser, the user associated with the project notification.

Definition at line 49 of file ProjectsNotificationUtil.php.

static processProjectNotification ( NotificationMessage message,
ProjectNotificationRules rule,
action 
) [static, protected]

Process project notification

Parameters:
NotificationMessage $message
ProjectNotificationRules $rule
string $action

Definition at line 73 of file ProjectsNotificationUtil.php.

static getNotificationMessageByAction ( Project project,
action,
Task task = null,
User relatedUser = null 
) [static, protected]

Gets notification message by action

Parameters:
Project $project
$action 
Task $task
User $relatedUser
Returns:
NotificationMessage

Definition at line 101 of file ProjectsNotificationUtil.php.

static resolvePeopleToSendNotification ( Project project,
action 
) [static]

Gets notification subscribers

Parameters:
Project $project
$action 
Returns:
array

Definition at line 122 of file ProjectsNotificationUtil.php.

static getEmailMessageContent ( Project project,
action,
Task task = null,
User relatedUser = null 
) [static]

Gets email message for the notification

Parameters:
Project $project
$action 
Task $task
User $relatedUser
Returns:
string

Definition at line 143 of file ProjectsNotificationUtil.php.

static sendProjectEmail ( Notification notification,
ProjectNotificationRules rule,
action 
) [static, protected]

Send task email

Parameters:
Notification $notification
ProjectNotificationRules $rule
string $action

Definition at line 171 of file ProjectsNotificationUtil.php.

static resolveNotificationRulesClassByAction ( action  )  [static, protected]

Resolve the notification rules class name by action name

Parameters:
string $action
Returns:
string

Definition at line 202 of file ProjectsNotificationUtil.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Sat Jul 20 07:11:18 2019