Class XoopsNotificationHandler

XOOPS notification handler class.

This class is responsible for providing data access mechanisms to the data source of XOOPS notification class objects.

XoopsNotificationHandler

Package: kernel\notification
Copyright: (c) 2000-2016 XOOPS Project (www.xoops.org)
License: GPL 2 (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Michael van Dam mvandam@caltech.edu
Located at ernel/notification.php

Methods summary
`public XoopsNotification`	# `create( boolean $isNew = true )` Create a `XoopsNotification` Create a `XoopsNotification` Parameters `$isNew` Flag the object as "new"? Returns `XoopsNotification` Overrides `XoopsObjectHandler::create()`
`public XoopsNotification`	# `get( integer $id )` Retrieve a `XoopsNotification` Retrieve a `XoopsNotification` Parameters `$id` ID Returns `XoopsNotification` `XoopsNotification`, FALSE on fail Overrides `XoopsObjectHandler::get()`
`public boolean`	# `insert( XoopsObject $notification )` Write a notification(subscription) to database Write a notification(subscription) to database Parameters `$notification` a XoopsNotification object Returns boolean true on success, otherwise false Overrides `XoopsObjectHandler::insert()`
`public boolean`	# `delete( XoopsObject $notification )` Delete a `XoopsNotification` from the database Delete a `XoopsNotification` from the database Parameters `$notification` a XoopsNotification object Returns boolean true on success, otherwise false Overrides `XoopsObjectHandler::delete()`
`public array`	# `getObjects( CriteriaElement $criteria = null, boolean $id_as_key = false )` Get some `XoopsNotification`s Get some `XoopsNotification`s Parameters `$criteria` `$id_as_key` Use IDs as keys into the array? Returns array Array of `XoopsNotification` objects
`public integer`	# `getCount( CriteriaElement $criteria = null )` Count Notifications Count Notifications Parameters `$criteria` `CriteriaElement` Returns integer Count
`public boolean`	# `deleteAll( CriteriaElement $criteria = null )` Delete multiple notifications Delete multiple notifications Parameters `$criteria` `CriteriaElement` Returns boolean
`public boolean &`	# `getNotification( $module_id, $category, $item_id, $event, $user_id )` Parameters `$module_id` `$category` `$item_id` `$event` `$user_id` Returns boolean
`public integer`	# `isSubscribed( string $category, integer $item_id, string $event, integer $module_id, integer $user_id )` Determine if a user is subscribed to a particular event in a particular module. Determine if a user is subscribed to a particular event in a particular module. Parameters `$category` Category of notification event `$item_id` Item ID of notification event `$event` Event `$module_id` ID of module (default current module) `$user_id` ID of user (default current user) return int 0 if not subscribe; non-zero if subscribed Returns integer
`public boolean`	# `subscribe( string $category, integer $item_id, mixed $events, integer $mode = null, integer $module_id = null, integer $user_id = null )` Subscribe for notification for an event(s) Subscribe for notification for an event(s) Parameters `$category` category of notification `$item_id` ID of the item `$events` event string or array of events `$mode` force a particular notification mode (e.g. once_only) (default to current user preference) `$module_id` ID of the module (default to current module) `$user_id` ID of the user (default to current user) * Returns boolean
`public array`	# `getByUser( integer $user_id )` Get a list of notifications by user ID Get a list of notifications by user ID Parameters `$user_id` ID of the user Returns array Array of `XoopsNotification` objects
`public array`	# `getSubscribedEvents( $category, $item_id, $module_id, $user_id )` Get a list of notification events for the current item/mod/user Get a list of notification events for the current item/mod/user Parameters `$category` `$item_id` `$module_id` `$user_id` Returns array
`public array`	# `getByItemId( integer $module_id, integer $item_id, string $order = null, null $status = null )` Retrieve items by their ID Retrieve items by their ID Parameters `$module_id` Module ID `$item_id` Item ID `$order` Sort order `$status` Returns array Array of `XoopsNotification` objects
`public`	# `triggerEvents( $category, $item_id, $events, $extra_tags = array(), $user_list = array(), $module_id = null, $omit_user_id = null )`
`public mixed`	# `triggerEvent( integer $category, integer $item_id, integer $event, array $extra_tags = array(), array $user_list = array(), integer $module_id = null, integer $omit_user_id = null )` Enter description here... Enter description here... Parameters `$category` `$item_id` `$event` `$extra_tags` `$user_list` `$module_id` `$omit_user_id` Returns mixed
`public boolean`	# `unsubscribeByUser( integer $user_id )` Delete all notifications for one user Delete all notifications for one user Parameters `$user_id` ID of the user Returns boolean
`public boolean`	# `unsubscribe( string $category, integer $item_id, mixed $events, integer $module_id = null, integer $user_id = null )` Unsubscribe notifications for an event(s). Unsubscribe notifications for an event(s). Parameters `$category` category of the events `$item_id` ID of the item `$events` event string or array of events `$module_id` ID of the module (default current module) `$user_id` UID of the user (default current user) Returns boolean
`public boolean`	# `unsubscribeByModule( integer $module_id )` Delete all notifications for a particular module Delete all notifications for a particular module Parameters `$module_id` ID of the module Returns boolean
`public boolean`	# `unsubscribeByItem( integer $module_id, string $category, integer $item_id )` Delete all subscriptions for a particular item. Delete all subscriptions for a particular item. Parameters `$module_id` ID of the module to which item belongs `$category` Notification category of the item `$item_id` ID of the item Returns boolean
`public`	# `doLoginMaintenance( integer $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. 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 `$user_id` ID of the user being logged in
`public boolean`	# `updateByField( XoopsNotification $notification, string $field_name, mixed $field_value )` Update Update Parameters `$notification` `XoopsNotification` object `$field_name` Name of the field `$field_value` Value to write Returns boolean

Methods inherited from XoopsObjectHandler
`XoopsObjectHandler(), __construct()`

Properties inherited from XoopsObjectHandler
`$db`

Namespaces

Classes

Interfaces

Exceptions

Functions

Class XoopsNotificationHandler

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns