NotificationRules Class Reference

Inheritance diagram for NotificationRules:

Public Member Functions
	allowDuplicates ()
	setAllowDuplicates ($allowDuplicates)
	isCritical ()
	setCritical ($critical)
	getUsers ()
	addUser (User $user)
Static Public Member Functions
static	getDisplayName ()
static	getType ()
Protected Member Functions
	loadUsers ()
Protected Attributes
	$usersLoaded = false
	$users = array()
	$critical = false
	$allowDuplicates = false

---

Detailed Description

Class to help the notifications module understand the logic for specific notifications it processes and creates.

Definition at line 41 of file NotificationRules.php.

---

Member Function Documentation

static getDisplayName

(

)

[static]

Returns:

Translated label that describes this rule type.

Reimplemented in EmailMessageArchivingEmailAddressNotMatchingNotificationRules, EmailMessageOwnerNotExistNotificationRules, ExportProcessCompletedNotificationRules, GameRewardRedeemedNotificationRules, ClearAssetsFolderNotificationRules, EnableMinifyNotificationRules, JobCompletedWithErrorsNotificationRules, NewZurmoVersionAvailableNotificationRules, RemoveApiTestEntryScriptFileNotificationRules, StuckJobsNotificationRules, StuckMonitorJobNotificationRules, MissionStatusChangeNotificationRules, MissionUnreadCommentNotificationRules, SimpleDuplicateNotificationRules, SimpleNotificationRules, Simple2TestNotificationRules, SimpleYTestNotificationRules, SimpleZTestNotificationRules, TaskNotificationRules, WorkflowMaximumDepthNotificationRules, WorkflowTriggerUserPrimaryEmailAddressRequiredNotificationRules, and WorkflowValidityCheckNotificationRules.

Definition at line 71 of file NotificationRules.php.

allowDuplicates

(

)

Returns:

true/false whether to allow multiple notifications by type for a single owner to be created.

Reimplemented in SimpleDuplicateNotificationRules.

Definition at line 80 of file NotificationRules.php.

setAllowDuplicates

(

$

allowDuplicates

)

Parameters:

boolean

$allowDuplicates

Definition at line 88 of file NotificationRules.php.

isCritical

(

)

Returns:

true/false whether the notification is considered critical, in which case an Email will be sent out in addition to the notification.

Definition at line 98 of file NotificationRules.php.

setCritical

(

$

critical

)

Set the notification as being critical or not. This will override the default setting for this particular NotificationRules

Parameters:

boolean

$critical

Definition at line 108 of file NotificationRules.php.

static getType

(

)

[static]

Returns:

The type of the NotificationRules

Reimplemented in EmailMessageArchivingEmailAddressNotMatchingNotificationRules, EmailMessageOwnerNotExistNotificationRules, ExportProcessCompletedNotificationRules, GameRewardRedeemedNotificationRules, ClearAssetsFolderNotificationRules, EnableMinifyNotificationRules, JobCompletedWithErrorsNotificationRules, NewZurmoVersionAvailableNotificationRules, RemoveApiTestEntryScriptFileNotificationRules, StuckJobsNotificationRules, StuckMonitorJobNotificationRules, MissionStatusChangeNotificationRules, MissionUnreadCommentNotificationRules, SimpleDuplicateNotificationRules, SimpleNotificationRules, Simple2TestNotificationRules, SimpleYTestNotificationRules, SimpleZTestNotificationRules, TaskNotificationRules, WorkflowMaximumDepthNotificationRules, WorkflowTriggerUserPrimaryEmailAddressRequiredNotificationRules, and WorkflowValidityCheckNotificationRules.

Definition at line 117 of file NotificationRules.php.

getUsers

(

)

Returns:

array of users to receive a notification.

Definition at line 125 of file NotificationRules.php.

addUser

(

User $

user

)

Add a user to receive a notification.

Parameters:

User

$user

Definition at line 139 of file NotificationRules.php.

loadUsers

(

)

[protected]

Loads users to notify. Override in child class if needed.

Reimplemented in EmailMessageOwnerNotExistNotificationRules, JobsManagerAccessNotificationRules, WorkflowMaximumDepthNotificationRules, and WorkflowValidityCheckNotificationRules.

Definition at line 151 of file NotificationRules.php.

---

The documentation for this class was generated from the following file:

• /home/apizurmo/zurmo/app/protected/modules/notifications/rules/NotificationRules.php