Comments: on this page. Click to read or post your own.

Class Notifications

Description
Description | Vars (details) | Methods (details)

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

Located in /sapphire/email/Notifications.php (line 8) 

Object
   |
   --Notifications
Variable Summary
Description | Vars (details) | Methods (details)
static mixed $events
Method Summary
Description | Vars (details) | Methods (details)
static void event (eventType $eventType, item $item, notifyMemberID $notifyMemberID)
static void getItems (eventType $eventType)
static void notifyByEmail (eventType $eventType, emailTemplateClass $emailTemplateClass)
Variables
Description | Vars (details) | Methods (details)
static mixed $events = array() (line 9)
  • access: protected

Inherited Variables

Inherited from Object

Object::$builtInMethods
 Object::$class
 Object::$classConstructed
 Object::$extensions
 Object::$extension_instances
 Object::$extraMethods
 Object::$extraStatics
 Object::$statics
 Object::$static_cached
Methods
Description | Vars (details) Methods (details)
static method event (line 19)

Raise an event that requires notification.

static void event (eventType $eventType, item $item, notifyMemberID $notifyMemberID)
  • 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 notifyByEmail()
static method getItems (line 52)

Get all the items that were passed with this event type.

static void getItems (eventType $eventType)
  • eventType $eventType: A string, this should match the eventType passed to event()
static method notifyByEmail (line 29)

Notify the appropriate parties about all instances of this event, by email.

static void notifyByEmail (eventType $eventType, emailTemplateClass $emailTemplateClass)
  • eventType $eventType: A string, this should match the eventType passed to event()
  • emailTemplateClass $emailTemplateClass: The class-name of the email template to use.

Inherited Methods

Inherited From Object

Object::__construct()
Object::addMethodsFrom()
Object::addStaticVars()
Object::addWrapperMethod()
Object::add_extension()
Object::allMethodNames()
Object::buildMethodList()
Object::cacheToFile()
Object::cacheToFileWithArgs()
Object::create()
Object::createMethod()
Object::defineMethods()
Object::exists()
Object::extend()
Object::extInstance()
Object::getCustomClass()
Object::hasExtension()
Object::hasMethod()
Object::invokeWithExtensions()
Object::is_a()
Object::loadCache()
Object::parentClass()
Object::sanitiseCachename()
Object::saveCache()
Object::set_stat()
Object::set_uninherited()
Object::stat()
Object::strong_create()
Object::uninherited()
Object::useCustomClass()
Object::__call()
Object::__toString()
blog comments powered by Disqus

Documentation generated on Sun, 19 Oct 2008 06:43:33 +1300 by phpDocumentor 1.3.2