Inheritance diagram for XoopsNotificationHandler:

Public Member Functions
&	create ($isNew=true)

	delete (&$notification)

	deleteAll ($criteria=null)

	doLoginMaintenance ($user_id)

&	get ($id)

	getByItemId ($module_id, $item_id, $order=null, $status=null)

	getByUser ($user_id)

	getCount ($criteria=null)

&	getNotification ($module_id, $category, $item_id, $event, $user_id)

	getObjects ($criteria=null, $id_as_key=false)

	getSubscribedEvents ($category, $item_id, $module_id, $user_id)

	insert (&$notification)

	isSubscribed ($category, $item_id, $event, $module_id, $user_id)

	subscribe ($category, $item_id, $events, $mode=null, $module_id=null, $user_id=null)

	triggerEvent ($category, $item_id, $event, $extra_tags=array(), $user_list=array(), $module_id=null, $omit_user_id=null)

	triggerEvents ($category, $item_id, $events, $extra_tags=array(), $user_list=array(), $module_id=null, $omit_user_id=null)

	unsubscribe ($category, $item_id, $events, $module_id=null, $user_id=null)

	unsubscribeByItem ($module_id, $category, $item_id)

	unsubscribeByModule ($module_id)

	unsubscribeByUser ($user_id)

	updateByField (&$notification, $field_name, $field_value)

Public Member Functions inherited from XoopsObjectHandler
&	create ()

	delete (&$object)

&	get ($int_id)

	insert (&$object)

	XoopsObjectHandler (&$db)

Additional Inherited Members
Public Attributes inherited from XoopsObjectHandler
	$db

Detailed Description

Definition at line 210 of file notification.php.

Member Function Documentation

& XoopsNotificationHandler::create ( $isNew = true )

Create a XoopsNotification

Parameters

bool $isNew Flag the object as "new"?

Returns: object

Definition at line 219 of file notification.php.

XoopsNotificationHandler::delete ( & $notification )

Delete a XoopsNotification from the database

Parameters

object &$notification

Returns: bool

: Change to if (!(class_exists($this->className) && $obj instanceof $this->className)) when going fully PHP5

Definition at line 300 of file notification.php.

References $result, and $sql.

XoopsNotificationHandler::deleteAll ( $criteria = null )

Delete multiple notifications

Parameters

object $criteria CriteriaElement

Returns: bool

Definition at line 381 of file notification.php.

References $criteria, $result, and $sql.

Referenced by unsubscribe(), unsubscribeByItem(), unsubscribeByModule(), and unsubscribeByUser().

Here is the caller graph for this function:

XoopsNotificationHandler::doLoginMaintenance ( $user_id )

Perform notification maintenance activites at login time. In particular, any notifications for the newly logged-in user with mode XOOPS_NOTIFICATION_MODE_WAITFORLOGIN are switched to mode XOOPS_NOTIFICATION_MODE_SENDONCETHENWAIT.

Parameters

int $user_id ID of the user being logged in

Definition at line 796 of file notification.php.

References $criteria, $user_id, getObjects(), insert(), XOOPS_NOTIFICATION_MODE_SENDONCETHENWAIT, and XOOPS_NOTIFICATION_MODE_WAITFORLOGIN.

Here is the call graph for this function:

& XoopsNotificationHandler::get ( $id )

Retrieve a XoopsNotification

Parameters

int $id ID

Returns: object XoopsNotification, FALSE on fail

Definition at line 235 of file notification.php.

References $result, and $sql.

XoopsNotificationHandler::getByItemId	(	$module_id,
		$item_id,
		$order = `null`,
		$status = `null`
	)

Retrieve items by their ID

Parameters

int	$module_id	Module ID
int	$item_id	Item ID
string	$order	Sort order

Returns: array Array of XoopsNotification objects

Definition at line 539 of file notification.php.

References $criteria, $module_id, $status, and getObjects().

Here is the call graph for this function:

XoopsNotificationHandler::getByUser ( $user_id )

Get a list of notifications by user ID

Parameters

int $user_id ID of the user

Returns: array Array of XoopsNotification objects

Definition at line 501 of file notification.php.

References $criteria, $user_id, and getObjects().

Here is the call graph for this function:

XoopsNotificationHandler::getCount ( $criteria = null )

Count Notifications

Parameters

object $criteria CriteriaElement

Returns: int Count

Definition at line 361 of file notification.php.

References $criteria, $result, and $sql.

Referenced by isSubscribed().

Here is the caller graph for this function:

& XoopsNotificationHandler::getNotification	(	$module_id,
		$category,
		$item_id,
		$event,
		$user_id
	)

Definition at line 395 of file notification.php.

References $criteria, $module_id, $user_id, and getObjects().

Referenced by subscribe().

Here is the call graph for this function:

Here is the caller graph for this function:

XoopsNotificationHandler::getObjects	(	$criteria = `null`,
		$id_as_key = `false`
	)

Get some XoopsNotifications

Parameters

object	$criteria
bool	$id_as_key	Use IDs as keys into the array?

Returns: array Array of XoopsNotification objects

Definition at line 324 of file notification.php.

References $criteria, $limit, $result, $ret, $sql, and $start.

Referenced by doLoginMaintenance(), getByItemId(), getByUser(), getNotification(), getSubscribedEvents(), and triggerEvent().

Here is the caller graph for this function:

XoopsNotificationHandler::getSubscribedEvents	(	$category,
		$item_id,
		$module_id,
		$user_id
	)

Get a list of notification events for the current item/mod/user

Definition at line 512 of file notification.php.

References $criteria, $i, $module_id, $ret, $user_id, and getObjects().

Here is the call graph for this function:

XoopsNotificationHandler::insert ( & $notification )

Write a notification(subscription) to database

Parameters

object &$notification

Returns: bool

: Change to if (!(class_exists($this->className) && $obj instanceof $this->className)) when going fully PHP5

Definition at line 260 of file notification.php.

References $result, and $sql.

Referenced by doLoginMaintenance(), subscribe(), and updateByField().

Here is the caller graph for this function:

XoopsNotificationHandler::isSubscribed	(	$category,
		$item_id,
		$event,
		$module_id,
		$user_id
	)

Determine if a user is subscribed to a particular event in a particular module.

Parameters

string	$category	Category of notification event
int	$item_id	Item ID of notification event
string	$event	Event
int	$module_id	ID of module (default current module)
int	$user_id	ID of user (default current user) return int 0 if not subscribe; non-zero if subscribed

Definition at line 422 of file notification.php.

References $criteria, $module_id, $user_id, and getCount().

Here is the call graph for this function:

XoopsNotificationHandler::subscribe	(	$category,
		$item_id,
		$events,
		$mode = `null`,
		$module_id = `null`,
		$user_id = `null`
	)

Subscribe for notification for an event(s)

Parameters

string	$category	category of notification
int	$item_id	ID of the item
mixed	$events	event string or array of events
int	$mode	force a particular notification mode (e.g. once_only) (default to current user preference)
int	$module_id	ID of the module (default to current module)
int	$user_id	ID of the user (default to current user)

Definition at line 448 of file notification.php.

References $module_id, $user, $user_id, $xoopsModule, $xoopsUser, XoopsObjectHandler\create(), getNotification(), insert(), and updateByField().

Here is the call graph for this function:

XoopsNotificationHandler::triggerEvent	(	$category,
		$item_id,
		$event,
		$extra_tags = `array()`,
		$user_list = `array()`,
		$module_id = `null`,
		$omit_user_id = `null`
	)

Enter description here...

Parameters

int	$category
int	$item_id
int	$event
array	$extra_tags
array	$user_list
int	$module_id
int	$omit_user_id

Returns: unknown

Definition at line 592 of file notification.php.

References $config_handler, $criteria, $GLOBALS, $module, $module_handler, $module_id, $user, $xoopsModule, $xoopsUser, _NOT_ITEMNAMENOTAVAILABLE, _NOT_ITEMTYPENOTAVAILABLE, _NOT_ITEMURLNOTAVAILABLE, getObjects(), notificationCategoryInfo(), notificationEventInfo(), notificationGenerateConfig(), xoops_gethandler(), XOOPS_NOTIFICATION_MODE_SENDALWAYS, XOOPS_NOTIFICATION_MODE_SENDONCETHENDELETE, and XOOPS_NOTIFICATION_MODE_SENDONCETHENWAIT.

Referenced by triggerEvents().

Here is the call graph for this function:

Here is the caller graph for this function:

XoopsNotificationHandler::triggerEvents	(	$category,
		$item_id,
		$events,
		$extra_tags = `array()`,
		$user_list = `array()`,
		$module_id = `null`,
		$omit_user_id = `null`
	)

Send notifications to users

Parameters

string	$category	notification category
int	$item_id	ID of the item
string	$event	notification event
array	$extra_tags	array of substitutions for template to be merged with the one from function..
array	$user_list	only notify the selected users
int	$module_id	ID of the module
int	$omit_user_id	ID of the user to omit from notifications. (default to current user). set to 0 for all users to receive notification.

Definition at line 570 of file notification.php.

References $module_id, and triggerEvent().

Here is the call graph for this function:

XoopsNotificationHandler::unsubscribe	(	$category,
		$item_id,
		$events,
		$module_id = `null`,
		$user_id = `null`
	)

Unsubscribe notifications for an event(s).

Parameters

string	$category	category of the events
int	$item_id	ID of the item
mixed	$events	event string or array of events
int	$module_id	ID of the module (default current module)
int	$user_id	UID of the user (default current user)