| [ Index ] |
PHP Cross Reference of Xoops v2.3.1 |
|
[Global whois Lookup] [Ranchi, Jharkhand, India website] [Hindi Magazine] [Desi Community website in tristate area] [B 4 Bollywood] [Internet nation of India] |
|
[Source view] [Print]
(no description)
| Author: | Michael van Dam |
| Copyright: | copyright (c) 2000-2003 XOOPS.org |
| File Size: | 821 lines (31 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 2 files include/notification_functions.php include/notification_constants.php |
XoopsNotification:: (2 methods):
XoopsNotification()
notifyUser()
XoopsNotificationHandler:: (21 methods):
create()
get()
insert()
delete()
getObjects()
getCount()
deleteAll()
getNotification()
isSubscribed()
subscribe()
getByUser()
getSubscribedEvents()
getByItemId()
triggerEvents()
triggerEvent()
unsubscribeByUser()
unsubscribe()
unsubscribeByModule()
unsubscribeByItem()
doLoginMaintenance()
updateByField()
Class: XoopsNotification - X-Ref
A Notification| XoopsNotification() X-Ref |
| Constructor |
| notifyUser($template_dir, $template, $subject, $tags) X-Ref |
| Send a notification message to the user param: string $template_dir Template directory param: string $template Template name param: string $subject Subject line for notification message param: array $tags Array of substitutions for template variables return: bool true if success, false if error |
Class: XoopsNotificationHandler - X-Ref
XOOPS notification handler class.| create($isNew = true) X-Ref |
| Create a {@link XoopsNotification} param: bool $isNew Flag the object as "new"? return: object |
| get($id) X-Ref |
| Retrieve a {@link XoopsNotification} param: int $id ID return: object {@link XoopsNotification}, FALSE on fail |
| insert(&$notification) X-Ref |
| Write a notification(subscription) to database param: object &$notification return: bool |
| delete(&$notification) X-Ref |
| Delete a {@link XoopsNotification} from the database param: object &$notification return: bool |
| getObjects($criteria = null, $id_as_key = false) X-Ref |
| Get some {@link XoopsNotification}s param: object $criteria param: bool $id_as_key Use IDs as keys into the array? return: array Array of {@link XoopsNotification} objects |
| getCount($criteria = null) X-Ref |
| Count Notifications param: object $criteria {@link CriteriaElement} return: int Count |
| deleteAll($criteria = null) X-Ref |
| Delete multiple notifications param: object $criteria {@link CriteriaElement} return: bool |
| getNotification($module_id, $category, $item_id, $event, $user_id) X-Ref |
| No description |
| isSubscribed($category, $item_id, $event, $module_id, $user_id) X-Ref |
| Determine if a user is subscribed to a particular event in a particular module. param: string $category Category of notification event param: int $item_id Item ID of notification event param: string $event Event param: int $module_id ID of module (default current module) param: int $user_id ID of user (default current user) |
| subscribe($category, $item_id, $events, $mode=null, $module_id=null, $user_id=null) X-Ref |
| Subscribe for notification for an event(s) param: string $category category of notification param: int $item_id ID of the item param: mixed $events event string or array of events param: int $mode force a particular notification mode param: int $module_id ID of the module (default to current module) param: int $user_id ID of the user (default to current user) |
| getByUser($user_id) X-Ref |
| Get a list of notifications by user ID param: int $user_id ID of the user return: array Array of {@link XoopsNotification} objects |
| getSubscribedEvents($category, $item_id, $module_id, $user_id) X-Ref |
| Get a list of notification events for the current item/mod/user |
| getByItemId($module_id, $item_id, $order = null, $status = null) X-Ref |
| Retrieve items by their ID param: int $module_id Module ID param: int $item_id Item ID param: string $order Sort order return: array Array of {@link XoopsNotification} objects |
| triggerEvents($category, $item_id, $events, $extra_tags=array() X-Ref |
| No description |
| triggerEvent($category, $item_id, $event, $extra_tags=array() X-Ref |
| No description |
| unsubscribeByUser($user_id) X-Ref |
| Delete all notifications for one user param: int $user_id ID of the user return: bool |
| unsubscribe($category, $item_id, $events, $module_id=null, $user_id=null) X-Ref |
| Unsubscribe notifications for an event(s). param: string $category category of the events param: int $item_id ID of the item param: mixed $events event string or array of events param: int $module_id ID of the module (default current module) param: int $user_id UID of the user (default current user) return: bool |
| unsubscribeByModule($module_id) X-Ref |
| Delete all notifications for a particular module param: int $module_id ID of the module return: bool |
| unsubscribeByItem($module_id, $category, $item_id) X-Ref |
| Delete all subscriptions for a particular item. param: int $module_id ID of the module to which item belongs param: string $category Notification category of the item param: int $item_id ID of the item return: bool |
| doLoginMaintenance($user_id) X-Ref |
| 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. param: int $user_id ID of the user being logged in |
| updateByField(&$notification, $field_name, $field_value) X-Ref |
| Update param: object &$notification {@link XoopsNotification} object param: string $field_name Name of the field param: mixed $field_value Value to write return: bool |
|
[ Xoops] [PhpNuke] [PostNuke] [Joomla] [Drupal] [E107] [NucleusCms] |
|||
|
[Php-Fusion] [PhpBB] [WordPress] [Typo3] |
|||
| Generated: Mon Oct 27 11:51:45 2008 | |||