Class NotificationsNotificationHandler

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

Xoops\Core\Kernel\XoopsObjectHandler

Xoops\Core\Kernel\XoopsPersistableObjectHandler

NotificationsNotificationHandler

Package: Notifications
Copyright: copyright (c) 2000-2003 XOOPS.org
Author: Michael van Dam mvandam@caltech.edu
Located at odules/notifications/class/notification.php

Methods summary
`public`	# `__construct( Xoops\Core\Database\Connection $db = null )` Constructor Constructor Parameters `$db` `Xoops\Core\Database\Connection` Overrides `Xoops\Core\Kernel\XoopsPersistableObjectHandler::__construct()`
`public array`	# `getObjectsArray( Xoops\Core\Kernel\CriteriaElement $criteria = null, boolean $id_as_key = false )` Get some `NotificationsNotification`s Get some `NotificationsNotification`s Parameters `$criteria` criteria object `$id_as_key` Use IDs as keys into the array? Returns array Array of `NotificationsNotification` objects
`public NotificationsNotification\|boolean`	# `getNotification( integer $module_id, string $category, integer $item_id, string $event, integer $user_id )` getNotification getNotification Parameters `$module_id` module `$category` category `$item_id` item `$event` event `$user_id` user Returns `NotificationsNotification`\|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) Returns integer 0 if not subscribe; non-zero if subscribed
`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 Todo: how about a function to subscribe a whole group of users??? e.g. if we want to add all moderators to be notified of subscription of new threads...
`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 `NotificationsNotification` objects
`public array`	# `getSubscribedEvents( string $category, integer $item_id, integer $module_id, integer $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` caategory `$item_id` id `$module_id` module `$user_id` user Returns array
`public array`	# `getByItemId( integer $module_id, integer $item_id, string $order = null, integer $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` status Returns array Array of `NotificationsNotification` objects
`public`	# `triggerEvents( string $category, integer $item_id, string $events, array $extra_tags = array(), array $user_list = array(), integer $module_id = null, integer $omit_user_id = null )` Send notifications to users Send notifications to users Parameters `$category` notification category `$item_id` ID of the item `$events` notification event `$extra_tags` array of substitutions for template to be merged with the one from function.. `$user_list` only notify the selected users `$module_id` ID of the module `$omit_user_id` ID of the user to omit from notifications. (default to current user). set to 0 for all users to receive notification. Todo(?) pass in an event LIST. This will help to avoid problem of sending people multiple emails for similar events. BUT, then we need an array of mail templates, etc... Unless mail templates can include logic in the future, then we can tailor the mail so it makes sense for any of the possible (or combination of) events.
`public boolean`	# `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 )` triggerEvent triggerEvent Parameters `$category` notification category `$item_id` ID of the item `$event` notification event `$extra_tags` array of substitutions for template `$user_list` users to notify `$module_id` module `$omit_user_id` users to not notify Returns boolean
`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 NOTIFICATIONS_MODE_WAITFORLOGIN are switched to mode NOTIFICATIONS_MODE_SENDONCETHENWAIT. Perform notification maintenance activites at login time. In particular, any notifications for the newly logged-in user with mode NOTIFICATIONS_MODE_WAITFORLOGIN are switched to mode NOTIFICATIONS_MODE_SENDONCETHENWAIT. Parameters `$user_id` ID of the user being logged in
`public boolean`	# `updateByField( NotificationsNotification $notification, string $field_name, mixed $field_value )` Update Update Parameters `$notification` `NotificationsNotification` object `$field_name` Name of the field `$field_value` Value to write Returns boolean

Methods inherited from Xoops\Core\Kernel\XoopsPersistableObjectHandler
`__call(), cleanOrphan(), create(), delete(), deleteAll(), deleteByLink(), get(), getAll(), getByLink(), getCount(), getCountByLink(), getCounts(), getCountsByLink(), getIds(), getList(), getObjects(), insert(), loadHandler(), setHandler(), synchronization(), updateAll(), updateByLink()`

Properties inherited from Xoops\Core\Kernel\XoopsPersistableObjectHandler
`$className, $field_link, $field_object, $handler, $identifierName, $keyName, $keyName_link, $table, $table_link`

Properties inherited from Xoops\Core\Kernel\XoopsObjectHandler
`$db2`

Namespaces

Classes

Interfaces

Functions

Class NotificationsNotificationHandler

Parameters

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Todo:

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Todo(?)

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns