Class Notifications

The Notifications class allows you to create email notifications for various events. It lets your scripts generate a number of notifications, and delay sending of the emails until the end of execution, so that multiple notifications can collated together

Object

Notifications

Package: cms
Located at sapphire/email/Notifications.php

Methods summary

`public static`	# `event( eventType $eventType, item $item, notifyMemberID $notifyMemberID )` Raise an event that requires notification. Raise an event that requires notification. Parameters `$eventType` eventType A string used to identify different event types. You can refer back to the events raised by this eventType. `$item` item An object related to the notification, such as a database record. `$notifyMemberID` notifyMemberID A person to notify via email about the event. Events won't be notified by email until you call `Notifications::notifyByEmail()`
`public static`	# `notifyByEmail( eventType $eventType, emailTemplateClass $emailTemplateClass )` Notify the appropriate parties about all instances of this event, by email. Notify the appropriate parties about all instances of this event, by email. Parameters `$eventType` eventType A string, this should match the eventType passed to `Notifications::event()` `$emailTemplateClass` emailTemplateClass The class-name of the email template to use.
`public static`	# `getItems( eventType $eventType )` Get all the items that were passed with this event type. Get all the items that were passed with this event type. Parameters `$eventType` eventType A string, this should match the eventType passed to `Notifications::event()`

Methods inherited from Object

__call(), __construct(), __toString(), __wakeup(), addMethodsFrom(), addStaticVars(), addWrapperMethod(), add_extension(), add_static_var(), allMethodNames(), cacheToFile(), cacheToFileWithArgs(), clearCache(), combined_static(), create(), createMethod(), create_from_string(), defineMethods(), exists(), extInstance(), extend(), getCustomClass(), getExtensionInstance(), getExtensionInstances(), get_extensions(), get_static(), hasExtension(), hasMethod(), has_extension(), invokeWithExtensions(), is_a(), loadCache(), parentClass(), parse_class_spec(), remove_extension(), sanitiseCachename(), saveCache(), set_stat(), set_static(), set_uninherited(), stat(), strong_create(), uninherited(), uninherited_static(), useCustomClass()

Magic methods summary

Properties summary

`protected static array`	`$events`	#

Properties inherited from Object

$class, $extension_instances, $extensions

Packages

Classes

Interfaces

Class Notifications

Methods summary

Parameters

Parameters

Parameters

Methods inherited from Object

Magic methods summary

Properties summary

Properties inherited from Object