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.

Reimplemented in AccountCommentNotificationRules, ContactCommentNotificationRules, ConversationCommentNotificationRules, ConversationInvitesNotificationRules, EmailMessageArchivingEmailAddressNotMatchingNotificationRules, EmailMessageOwnerNotExistNotificationRules, ExportProcessCompletedNotificationRules, GameRewardRedeemedNotificationRules, RepairGamificationNotificationRules, ClearAssetsFolderNotificationRules, EnableMinifyNotificationRules, JobCompletedWithErrorsNotificationRules, NewZurmoVersionAvailableNotificationRules, RemoveApiTestEntryScriptFileNotificationRules, StuckJobsNotificationRules, StuckMonitorJobNotificationRules, MissionCommentNotificationRules, MissionStatusChangeNotificationRules, MissionUnreadCommentNotificationRules, NewMissionNotificationRules, SimpleDuplicateNotificationRules, SimpleNotificationRules, Simple2TestNotificationRules, SimpleYTestNotificationRules, SimpleZTestNotificationRules, OpportunityCommentNotificationRules, ArchivedProjectNotificationRules, NewProjectNotificationRules, ProjectTaskAddedNotificationRules, AcceptedTaskNotificationRules, DeliveredTaskNotificationRules, NewTaskNotificationRules, RejectedTaskNotificationRules, TaskCommentNotificationRules, TaskOwnerChangeNotificationRules, MalformedWorkflowMissingMarketingListNotificationRules, WorkflowMaximumDepthNotificationRules, WorkflowTriggerUserPrimaryEmailAddressRequiredNotificationRules, and WorkflowValidityCheckNotificationRules.

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.

Reimplemented in SimpleDuplicateNotificationRules.

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 $critical TODO: 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

Reimplemented in AccountCommentNotificationRules, ContactCommentNotificationRules, ConversationCommentNotificationRules, ConversationInvitesNotificationRules, EmailMessageArchivingEmailAddressNotMatchingNotificationRules, EmailMessageOwnerNotExistNotificationRules, ExportProcessCompletedNotificationRules, GameRewardRedeemedNotificationRules, RepairGamificationNotificationRules, ClearAssetsFolderNotificationRules, EnableMinifyNotificationRules, JobCompletedWithErrorsNotificationRules, NewZurmoVersionAvailableNotificationRules, RemoveApiTestEntryScriptFileNotificationRules, StuckJobsNotificationRules, StuckMonitorJobNotificationRules, MissionCommentNotificationRules, MissionStatusChangeNotificationRules, MissionUnreadCommentNotificationRules, NewMissionNotificationRules, SimpleDuplicateNotificationRules, SimpleNotificationRules, Simple2TestNotificationRules, SimpleYTestNotificationRules, SimpleZTestNotificationRules, OpportunityCommentNotificationRules, ArchivedProjectNotificationRules, NewProjectNotificationRules, ProjectNotificationRules, ProjectTaskAddedNotificationRules, AcceptedTaskNotificationRules, DeliveredTaskNotificationRules, NewTaskNotificationRules, RejectedTaskNotificationRules, TaskCommentNotificationRules, TaskNotificationRules, TaskOwnerChangeNotificationRules, MalformedWorkflowMissingMarketingListNotificationRules, WorkflowMaximumDepthNotificationRules, WorkflowTriggerUserPrimaryEmailAddressRequiredNotificationRules, and WorkflowValidityCheckNotificationRules.

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.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Thu Sep 19 07:11:05 2019