Docs For Class NotificationLib

Class: NotificationLib

Inherited Variables

Class: BitBase

BitBase::$dType
BitBase::$mCacheTime
BitBase::$mDb
BitBase::$mErrors
BitBase::$mInfo
BitBase::$mLogs
BitBase::$mName
BitBase::$mSuccess

Inherited Methods

Class: BitBase

BitBase::BitBase(): During initialisation, we assign a name which is used by the class.
BitBase::debug(): Switch debug level in database
BitBase::display(): This method should be THE method used to display a template. php files should not access $gBitSmarty directly.
BitBase::getDb(): Return pointer to current Database
BitBase::getField(): Returns entry from the mInfo hash if field exists
BitBase::isDatabaseValid(): Determines if there is a valide database connection
BitBase::prepGetList(): Prepares parameters with default values for any getList function
BitBase::setDatabase(): Sets database mechanism for the instance
BitBase::verifyId(): Determines if any given variable exists and is a number

Class Details

[line 27]
A library use to store email addresses registered for specific notification events.

Currently used in articles, trackers, users register and wiki.

Tags:

todo:

does not need to inherit BitBase class. Should hold a BitDb connection as a global variable.

Class Methods

constructor NotificationLib [line 32]

NotificationLib NotificationLib(
)

Notifies via email triggered events.

[ Top ]

method add_mail_event [line 78]

array add_mail_event(
event
$event, object the
$object, email
$email)

Adds an email address for a specified event notification

Tags:

return:

of the notification record

Parameters:

event	$event	the specified event
object the	$object	specified object
email	$email	the email to remove

[ Top ]

method get_mail_events [line 101]

array get_mail_events(
event
$event, object the
$object)

Retrieves the email addresses for a specific event

Tags:

return:

of email addresses

Parameters:

event	$event	the specified event
object the	$object	specified object

[ Top ]

method list_mail_events [line 44]

array list_mail_events(
offset
$offset, max_records
$max_records, sort_mode
$sort_mode, find
$find)

Lists registered notification events

Tags:

return:

of registered notification events

Parameters:

offset	$offset	the location to begin listing from
max_records	$max_records	the maximum number of records returned
sort_mode	$sort_mode	the method of sorting used in the listing
find	$find	text used to filter listing

[ Top ]

method post_content_event [line 126]

void post_content_event(
object number
$contentid, object content_type
$type, object the
$package, object the
$name, object the
$user, object any
$comment, object the
$data)

Post changes to registered email addresses related to a change event

Tags:

todo:

Improve the generic handling of the messages Param information probably needs to be passed as an array, or accessed from Content directly

Parameters:

object number	$contentid	of the content item being updated
object content_type	$type	of the item
object the	$package	package that is being updated
object the	$name	name of the object
object the	$user	name of user making the change
object any	$comment	comment added to the change
object the	$data	content of the change

[ Top ]

method post_new_user_event [line 152]

void post_new_user_event(
object name
$user)

Notifies registered list of eMail recipients of new user registrations

Parameters:

object name

$user

of the new user

[ Top ]

method remove_mail_event [line 89]

void remove_mail_event(
event
$event, object the
$object, email
$email)

Removes an email address for a specified event notification

Parameters:

event	$event	the specified event
object the	$object	specified object
email	$email	the email to remove

[ Top ]

Documentation generated on Thu, 15 Feb 2007 20:46:19 +0000 by phpDocumentor 1.3.0

Class: NotificationLib

Class Overview

Author(s):

Methods

Inherited Variables

Class: BitBase

Inherited Methods

Class: BitBase

Class Details

Tags:

Class Methods

constructor NotificationLib [line 32]

method add_mail_event [line 78]

Tags:

Parameters:

method get_mail_events [line 101]

Tags:

Parameters:

method list_mail_events [line 44]

Tags:

Parameters:

method post_content_event [line 126]

Tags:

Parameters:

method post_new_user_event [line 152]

Parameters:

method remove_mail_event [line 89]

Parameters: