Inheritance diagram for XoopsNotificationHandler:

Public Member Functions
	__construct (&$db)

	XoopsNotificationHandler (&$db)

&	create ($isNew=true)

&	get ($id)

	insert (&$notification)

	delete (&$notification)

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

	getCount ($criteria=null)

	deleteAll ($criteria=null)

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

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

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

&	getByUser ($user_id)

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

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

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

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

	unsubscribeByUser ($user_id)

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

	unsubscribeByModule ($module_id)

	unsubscribeByItem ($module_id, $category, $item_id)

	doLoginMaintenance ($user_id)

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

Public Member Functions inherited from XoopsObjectHandler
&	create ()

Data Fields
	$mTrigger = null

	$mTriggerPreAction = null

Data Fields inherited from XoopsObjectHandler
	$db

Protected Member Functions
	_escapeValue ($value, $type=XOBJ_DTYPE_STRING)

Detailed Description

Definition at line 167 of file notification.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( & $db )

called from child classes only

Parameters

object $db reference to the XoopsDatabase object @access protected

Reimplemented from XoopsObjectHandler.

Definition at line 179 of file notification.php.

Member Function Documentation

◆ _escapeValue()

_escapeValue	(		$value,
			$type = XOBJ_DTYPE_STRING )

protected

Definition at line 194 of file notification.php.

◆ create()

& create ( $isNew = true )

Create a XoopsNotification

Parameters

bool $isNew Flag the object as "new"?

Returns: object

Definition at line 222 of file notification.php.

◆ delete()

delete ( & $notification )

Delete a XoopsNotification from the database

Parameters

object &$notification

Returns: bool

Reimplemented from XoopsObjectHandler.

Definition at line 308 of file notification.php.

◆ deleteAll()

deleteAll ( $criteria = null )

Delete multiple notifications

Parameters

object $criteria CriteriaElement

Returns: bool

Definition at line 385 of file notification.php.

◆ doLoginMaintenance()

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 890 of file notification.php.

◆ get()

& get ( $id )

Retrieve a XoopsNotification

Parameters

int $id ID

Returns: object XoopsNotification, FALSE on fail

Reimplemented from XoopsObjectHandler.

Definition at line 239 of file notification.php.

◆ getByItemId()

& 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
null	$status

Returns: array Array of XoopsNotification objects

Definition at line 584 of file notification.php.

◆ getByUser()

& 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 538 of file notification.php.

◆ getCount()

getCount ( $criteria = null )

Count Notifications

Parameters

object $criteria CriteriaElement

Returns: int Count

Definition at line 365 of file notification.php.

◆ getNotification()

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

Change a value in multiple notifications

Parameters

$module_id
$category
$item_id
$event
$user_id

Returns: bool

Definition at line 426 of file notification.php.

◆ getObjects()

& 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 328 of file notification.php.

◆ getSubscribedEvents()

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

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

Parameters

$category
$item_id
$module_id
$user_id

Returns: array

Definition at line 555 of file notification.php.

◆ insert()

insert ( & $notification )

Write a notification(subscription) to database

Parameters

object &$notification

Returns: bool

Reimplemented from XoopsObjectHandler.

Definition at line 264 of file notification.php.

◆ isSubscribed()

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

Returns: int

Definition at line 455 of file notification.php.

◆ subscribe()

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)

Returns: bool

Definition at line 484 of file notification.php.

◆ triggerEvent()

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

Definition at line 628 of file notification.php.

◆ triggerEvents()

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

Send notifications to users

Parameters

string	$category	notification category
int	$item_id	ID of the item
	$events
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 618 of file notification.php.

◆ unsubscribe()

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)

Returns: bool

Definition at line 813 of file notification.php.

◆ unsubscribeByItem()

unsubscribeByItem	(	$module_id,
		$category,
		$item_id )

Delete all subscriptions for a particular item.

Parameters

int	$module_id	ID of the module to which item belongs
string	$category	Notification category of the item
int	$item_id	ID of the item

Returns: bool

Definition at line 872 of file notification.php.

◆ unsubscribeByModule()

unsubscribeByModule ( $module_id )

Delete all notifications for a particular module

Parameters

int $module_id ID of the module

Returns: bool

Definition at line 856 of file notification.php.

◆ unsubscribeByUser()

unsubscribeByUser ( $user_id )

Delete all notifications for one user

Parameters

int $user_id ID of the user

Returns: bool

Definition at line 792 of file notification.php.

◆ updateByField()

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

Update

Parameters

object	&$notification	`XoopsNotification` object
string	$field_name	Name of the field
mixed	$field_value	Value to write

Returns: bool

Definition at line 913 of file notification.php.

◆ XoopsNotificationHandler()

XoopsNotificationHandler ( & $db )

Definition at line 189 of file notification.php.

Field Documentation

◆ $mTrigger

$mTrigger = null

Definition at line 172 of file notification.php.

◆ $mTriggerPreAction

$mTriggerPreAction = null

Definition at line 177 of file notification.php.

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

html/kernel/notification.php

Public Member Functions

Data Fields

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _escapeValue()

◆ create()

◆ delete()

◆ deleteAll()

◆ doLoginMaintenance()

◆ get()

◆ getByItemId()

◆ getByUser()

◆ getCount()

◆ getNotification()

◆ getObjects()

◆ getSubscribedEvents()

◆ insert()

◆ isSubscribed()

◆ subscribe()

◆ triggerEvent()

◆ triggerEvents()

◆ unsubscribe()

◆ unsubscribeByItem()

◆ unsubscribeByModule()

◆ unsubscribeByUser()

◆ updateByField()

◆ XoopsNotificationHandler()

Field Documentation

◆ $mTrigger

◆ $mTriggerPreAction