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 | |
Class to help the notifications module understand the logic for specific notifications it processes and creates.
Definition at line 41 of file NotificationRules.php.
| getDisplayName | ( | ) |
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 | ( | ) |
Reimplemented in SimpleDuplicateNotificationRules.
Definition at line 109 of file NotificationRules.php.
| setAllowDuplicates | ( | $ | allowDuplicates | ) |
| boolean | $allowDuplicates |
Definition at line 117 of file NotificationRules.php.
| allowSendingEmail | ( | ) |
Definition at line 127 of file NotificationRules.php.
| canBeConfiguredByUser | ( | ) |
Definition at line 136 of file NotificationRules.php.
| isCritical | ( | ) |
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
| 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
| NotImplementedException |
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 | ( | ) |
Definition at line 176 of file NotificationRules.php.
| addUser | ( | User $ | user | ) |
Add a user to receive a notification.
| User | $user |
Definition at line 190 of file NotificationRules.php.
| loadUsers | ( | ) | [protected] |
Loads users to notify. Override in child class if needed.
Reimplemented in EmailMessageOwnerNotExistNotificationRules, RepairGamificationNotificationRules, ClearAssetsFolderNotificationRules, JobsManagerAccessNotificationRules, MalformedWorkflowMissingMarketingListNotificationRules, WorkflowMaximumDepthNotificationRules, and WorkflowValidityCheckNotificationRules.
Definition at line 202 of file NotificationRules.php.
| isSuperAdministratorNotification | ( | ) |
If the notification can be enabled by super administrators only
Reimplemented in EmailMessageOwnerNotExistNotificationRules, RepairGamificationNotificationRules, ClearAssetsFolderNotificationRules, JobCompletedWithErrorsNotificationRules, NewZurmoVersionAvailableNotificationRules, StuckJobsNotificationRules, StuckMonitorJobNotificationRules, WorkflowMaximumDepthNotificationRules, and WorkflowValidityCheckNotificationRules.
Definition at line 210 of file NotificationRules.php.
| getModuleClassNames | ( | ) |
Get module class names associated with the import rules.
| NotImplementedException |
Reimplemented in AccountCommentNotificationRules, ContactCommentNotificationRules, ConversationCommentNotificationRules, ConversationInvitesNotificationRules, EmailMessageArchivingEmailAddressNotMatchingNotificationRules, EmailMessageOwnerNotExistNotificationRules, ExportProcessCompletedNotificationRules, GameRewardRedeemedNotificationRules, JobsManagerAccessNotificationRules, MissionCommentNotificationRules, MissionStatusChangeNotificationRules, MissionUnreadCommentNotificationRules, NewMissionNotificationRules, OpportunityCommentNotificationRules, ProjectNotificationRules, TaskNotificationRules, WorkflowMaximumDepthNotificationRules, WorkflowTriggerUserPrimaryEmailAddressRequiredNotificationRules, and WorkflowValidityCheckNotificationRules.
Definition at line 220 of file NotificationRules.php.
| getTooltipId | ( | ) |
The Id for the tooltip used to show help about the notification
| NotImplementedException |
Reimplemented in AccountCommentNotificationRules, ContactCommentNotificationRules, ConversationCommentNotificationRules, ConversationInvitesNotificationRules, EmailMessageArchivingEmailAddressNotMatchingNotificationRules, EmailMessageOwnerNotExistNotificationRules, ExportProcessCompletedNotificationRules, GameRewardRedeemedNotificationRules, ClearAssetsFolderNotificationRules, JobCompletedWithErrorsNotificationRules, NewZurmoVersionAvailableNotificationRules, StuckJobsNotificationRules, StuckMonitorJobNotificationRules, MissionCommentNotificationRules, MissionStatusChangeNotificationRules, NewMissionNotificationRules, OpportunityCommentNotificationRules, ArchivedProjectNotificationRules, NewProjectNotificationRules, ProjectTaskAddedNotificationRules, AcceptedTaskNotificationRules, DeliveredTaskNotificationRules, NewTaskNotificationRules, RejectedTaskNotificationRules, TaskCommentNotificationRules, TaskOwnerChangeNotificationRules, WorkflowMaximumDepthNotificationRules, and WorkflowValidityCheckNotificationRules.
Definition at line 229 of file NotificationRules.php.
| getTooltipTitle | ( | ) |
The title for the tooltip describing help for the notification
| NotImplementedException |
Reimplemented in AccountCommentNotificationRules, ContactCommentNotificationRules, ConversationCommentNotificationRules, ConversationInvitesNotificationRules, EmailMessageArchivingEmailAddressNotMatchingNotificationRules, EmailMessageOwnerNotExistNotificationRules, ExportProcessCompletedNotificationRules, GameRewardRedeemedNotificationRules, ClearAssetsFolderNotificationRules, JobCompletedWithErrorsNotificationRules, NewZurmoVersionAvailableNotificationRules, StuckJobsNotificationRules, StuckMonitorJobNotificationRules, MissionCommentNotificationRules, MissionStatusChangeNotificationRules, NewMissionNotificationRules, OpportunityCommentNotificationRules, ArchivedProjectNotificationRules, NewProjectNotificationRules, ProjectTaskAddedNotificationRules, AcceptedTaskNotificationRules, DeliveredTaskNotificationRules, NewTaskNotificationRules, RejectedTaskNotificationRules, TaskCommentNotificationRules, TaskOwnerChangeNotificationRules, WorkflowMaximumDepthNotificationRules, and WorkflowValidityCheckNotificationRules.
Definition at line 238 of file NotificationRules.php.
| getSubjectForEmailNotification | ( | ) |
The subject to be used in the email notification
| NotImplementedException |
Reimplemented in CommentNotificationRules, ConversationCommentNotificationRules, ConversationInvitesNotificationRules, MissionCommentNotificationRules, NewMissionNotificationRules, ArchivedProjectNotificationRules, NewProjectNotificationRules, ProjectTaskAddedNotificationRules, AcceptedTaskNotificationRules, DeliveredTaskNotificationRules, NewTaskNotificationRules, RejectedTaskNotificationRules, TaskCommentNotificationRules, and TaskOwnerChangeNotificationRules.
Definition at line 247 of file NotificationRules.php.
