NotificationLib Class Reference

Inheritance diagram for NotificationLib:

[legend]List of all members.

Public Member Functions
	add_mail_event ($event, $object, $email)
	get_mail_events ($event, $object)
	list_mail_events ($offset, $max_records, $sort_mode, $find)
	NotificationLib ()
	post_content_event ($contentid, $type, $package, $name, $user, $comment, $data)
	post_new_user_event ($user)
	remove_mail_event ($event, $object, $email)

---

Detailed Description

Definition at line 27 of file notification_lib.php.

---

Member Function Documentation

NotificationLib::add_mail_event	(	$	event,
		$	object,
		$	email
	)

Adds an email address for a specified event notification

Parameters:

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

Returns:

array of the notification record

Definition at line 78 of file notification_lib.php.

References $email, $query, $result, and mDb.

NotificationLib::get_mail_events	(	$	event,
		$	object
	)

Retrieves the email addresses for a specific event

Parameters:

	event	the specified event
	object	the specified object

Returns:

array of email addresses

Definition at line 101 of file notification_lib.php.

References $query, $res, $result, $ret, and mDb.

Referenced by post_content_event(), and post_new_user_event().

NotificationLib::list_mail_events	(	$	offset,
		$	max_records,
		$	sort_mode,
		$	find
	)

Lists registered notification events

Parameters:

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

Returns:

array of registered notification events

Definition at line 44 of file notification_lib.php.

References $find, $max_records, $mid, $offset, $query, $res, $result, $ret, $sort_mode, and mDb.

NotificationLib::NotificationLib

(

)

Notifies via email triggered events.

Definition at line 32 of file notification_lib.php.

References BitBase::BitBase().

Here is the call graph for this function:

NotificationLib::post_content_event	(	$	contentid,
		$	type,
		$	package,
		$	name,
		$	user,
		$	comment,
		$	data
	)

Post changes to registered email addresses related to a change event

Parameters:

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

Todo:

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

Definition at line 126 of file notification_lib.php.

References $_SERVER, $comment, $data, $email, $emails, $gBitSmarty, $gBitSystem, $mail_data, $type, $user, get_mail_events(), httpPrefix(), and tra().

Here is the call graph for this function:

NotificationLib::post_new_user_event

(

$

user

)

Notifies registered list of eMail recipients of new user registrations

Parameters:

object

name of the new user

Definition at line 152 of file notification_lib.php.

References $_SERVER, $email, $emails, $gBitSmarty, $gBitSystem, $mail_data, $user, get_mail_events(), and tra().

Here is the call graph for this function:

NotificationLib::remove_mail_event	(	$	event,
		$	object,
		$	email
	)

Removes an email address for a specified event notification

Parameters:

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

Definition at line 89 of file notification_lib.php.

References $email, $query, $result, and mDb.

---

The documentation for this class was generated from the following file:

• notification_lib.php

---