All Data Structures Functions Variables Pages
Public Member Functions | Protected Member Functions | Protected Attributes
NotificationRules Class Reference
Inheritance diagram for NotificationRules:
CommentNotificationRules ConversationInvitesNotificationRules EmailMessageArchivingEmailAddressNotMatchingNotificationRules EmailMessageOwnerNotExistNotificationRules ExportProcessCompletedNotificationRules GameRewardRedeemedNotificationRules JobsManagerAccessNotificationRules MalformedWorkflowMissingMarketingListNotificationRules MissionStatusChangeNotificationRules MissionUnreadCommentNotificationRules NewMissionNotificationRules ProjectNotificationRules RepairGamificationNotificationRules Simple2TestNotificationRules SimpleNotificationRules SimpleYTestNotificationRules SimpleZTestNotificationRules TaskNotificationRules WorkflowMaximumDepthNotificationRules WorkflowTriggerUserPrimaryEmailAddressRequiredNotificationRules WorkflowValidityCheckNotificationRules

Public Member Functions

 getModel ()
 
 setModel ($model)
 
 getDisplayName ()
 
 allowDuplicates ()
 
 setAllowDuplicates ($allowDuplicates)
 
 allowSendingEmail ()
 
 canBeConfiguredByUser ()
 
 isCritical ()
 
 setCritical ($critical)
 
 getType ()
 
 getUsers ()
 
 addUser (User $user)
 
 isSuperAdministratorNotification ()
 
 getModuleClassNames ()
 
 getTooltipId ()
 
 getTooltipTitle ()
 
 getSubjectForEmailNotification ()
 
 getDefaultValue ($type)
 

Protected Member Functions

 loadUsers ()
 

Protected Attributes

 $defaultValueForInboxSetting = true
 
 $defaultValueForEmailSetting = true
 
 $usersLoaded = false
 
 $users = array()
 
 $critical = false
 
 $allowDuplicates = false
 
 $allowSendingEmail = true
 
 $canBeConfiguredByUser = true
 
 $model
 

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

getDisplayName ( )
Returns
Translated label that describes this rule type.

Definition at line 100 of file NotificationRules.php.

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

Definition at line 109 of file NotificationRules.php.

setAllowDuplicates (   $allowDuplicates)
Parameters
boolean$allowDuplicates

Definition at line 117 of file NotificationRules.php.

allowSendingEmail ( )
Returns
true/false whether to allow sending an email along with the inbox notification. created.

Definition at line 127 of file NotificationRules.php.

canBeConfiguredByUser ( )
Returns
true/false whether the user can configure if the notification can be sent by the system created.

Definition at line 136 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. TODO: To be removed, it's not used anymore

Definition at line 146 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$criticalTODO: To be removed, it's not used anymore

Definition at line 157 of file NotificationRules.php.

getType ( )

The type of the NotificationRules

Exceptions
NotImplementedException
Returns
string

Definition at line 168 of file NotificationRules.php.

getUsers ( )
Returns
array of users to receive a notification.

Definition at line 176 of file NotificationRules.php.

addUser ( User  $user)

Add a user to receive a notification.

Parameters
User$user

Definition at line 190 of file NotificationRules.php.

loadUsers ( )
protected

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

Definition at line 202 of file NotificationRules.php.

isSuperAdministratorNotification ( )

If the notification can be enabled by super administrators only

Returns
bool

Definition at line 210 of file NotificationRules.php.

getModuleClassNames ( )

Get module class names associated with the import rules.

Exceptions
NotImplementedException
Returns
array

Definition at line 220 of file NotificationRules.php.

getTooltipId ( )

The Id for the tooltip used to show help about the notification

Exceptions
NotImplementedException

Definition at line 229 of file NotificationRules.php.

getTooltipTitle ( )

The title for the tooltip describing help for the notification

Exceptions
NotImplementedException

Definition at line 238 of file NotificationRules.php.

getSubjectForEmailNotification ( )

The subject to be used in the email notification

Exceptions
NotImplementedException

Definition at line 247 of file NotificationRules.php.


The documentation for this class was generated from the following file:
Generated on Mon Mar 30 2020 07:11:13