Docs For Class NotificationLib

method add_mail_event [line 71]

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 94]

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 37]

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 119]

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 145]

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 82]

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 ]

Class: NotificationLib

Class Overview

Author(s):

Methods

Inherited Constants

Class: BitBase

Inherited Variables

Class: BitBase

Inherited Methods

Class: BitBase

Class Details

Tags:

Class Methods

method add_mail_event [line 71]

Tags:

Parameters:

method get_mail_events [line 94]

Tags:

Parameters:

method list_mail_events [line 37]

Tags:

Parameters:

method post_content_event [line 119]

Tags:

Parameters:

method post_new_user_event [line 145]

Parameters:

method remove_mail_event [line 82]

Parameters: