XOOPS API 2.5.11 Beta1  UI v0.5
Réalisé par monxoops.fr
Référence de la classe XoopsNotificationHandler
+ Graphe d'héritage de XoopsNotificationHandler:
+ Graphe de collaboration de XoopsNotificationHandler:

Fonctions membres publiques

 create ($isNew=true)
 
 get ($id)
 
 insert (XoopsObject $notification)
 
 delete (XoopsObject $notification)
 
 getObjects (CriteriaElement $criteria=null, $id_as_key=false)
 
 getCount (CriteriaElement $criteria=null)
 
 deleteAll (CriteriaElement $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=array(), $user_list=array(), $module_id=null, $omit_user_id=null)
 
 triggerEvent ($category, $item_id, $event, $extra_tags=array(), $user_list=array(), $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 (XoopsNotification $notification, $field_name, $field_value)
 
- Fonctions membres publiques hérités de XoopsObjectHandler
 __construct (XoopsDatabase $db)
 
 XoopsObjectHandler ($db)
 
 create ()
 

Membres hérités additionnels

- Champs de données hérités de XoopsObjectHandler
 $db
 

Documentation des fonctions membres

◆ create()

create (   $isNew = true)

Create a XoopsNotification

Paramètres
bool$isNewFlag the object as "new"?
Renvoie
XoopsNotification

◆ delete()

delete ( XoopsObject  $notification)

Delete a XoopsNotification from the database

Paramètres
XoopsObject | XoopsNotification$notificationa XoopsNotification object
Renvoie
bool true on success, otherwise false

Réimplémentée à partir de XoopsObjectHandler.

◆ deleteAll()

deleteAll ( CriteriaElement  $criteria = null)

Delete multiple notifications

Paramètres
CriteriaElement | CriteriaCompo$criteriaCriteriaElement
Renvoie
bool
+ Voici le graphe des appelants de cette fonction :

◆ 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.

Paramètres
int$user_idID of the user being logged in
+ Voici le graphe d'appel pour cette fonction :

◆ get()

get (   $id)

Retrieve a XoopsNotification

Paramètres
int$idID
Renvoie
XoopsNotification XoopsNotification, FALSE on fail

Réimplémentée à partir de XoopsObjectHandler.

◆ getByItemId()

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

Retrieve items by their ID

Paramètres
int$module_idModule ID
int$item_idItem ID
string$orderSort order
null$status
Renvoie
array Array of XoopsNotification objects
+ Voici le graphe d'appel pour cette fonction :

◆ getByUser()

getByUser (   $user_id)

Get a list of notifications by user ID

Paramètres
int$user_idID of the user
Renvoie
array Array of XoopsNotification objects
+ Voici le graphe d'appel pour cette fonction :

◆ getCount()

getCount ( CriteriaElement  $criteria = null)

Count Notifications

Paramètres
CriteriaElement | CriteriaCompo$criteriaCriteriaElement
Renvoie
int Count
+ Voici le graphe des appelants de cette fonction :

◆ getNotification()

& getNotification (   $module_id,
  $category,
  $item_id,
  $event,
  $user_id 
)
Paramètres
$module_id
$category
$item_id
$event
$user_id
Renvoie
bool
+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

◆ getObjects()

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

Get some XoopsNotifications

Paramètres
CriteriaElement | CriteriaCompo$criteria
bool$id_as_keyUse IDs as keys into the array?
Renvoie
array Array of XoopsNotification objects
+ Voici le graphe des appelants de cette fonction :

◆ getSubscribedEvents()

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

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

Paramètres
$category
$item_id
$module_id
$user_id
Renvoie
array
+ Voici le graphe d'appel pour cette fonction :

◆ insert()

insert ( XoopsObject  $notification)

Write a notification(subscription) to database

Paramètres
XoopsObject | XoopsNotification$notificationa XoopsNotification object
Renvoie
bool true on success, otherwise false

Réimplémentée à partir de XoopsObjectHandler.

+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

◆ isSubscribed()

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

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

Paramètres
string$categoryCategory of notification event
int$item_idItem ID of notification event
string$eventEvent
int$module_idID of module (default current module)
int$user_idID of user (default current user) return int 0 if not subscribe; non-zero if subscribed
Renvoie
int
+ Voici le graphe d'appel pour cette fonction :

◆ subscribe()

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

Subscribe for notification for an event(s)

Paramètres
string$categorycategory of notification
int$item_idID of the item
mixed$eventsevent string or array of events
int$modeforce a particular notification mode (e.g. once_only) (default to current user preference)
int$module_idID of the module (default to current module)
int$user_idID of the user (default to current user)
Renvoie
bool
+ Voici le graphe d'appel pour cette fonction :

◆ triggerEvent()

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

Enter description here...

Paramètres
int$category
int$item_id
int$event
array$extra_tags
array$user_list
int$module_id
int$omit_user_id
Renvoie
mixed
+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

◆ triggerEvents()

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

Send notifications to users

Paramètres
string$categorynotification category
int$item_idID of the item
array$eventstrigger events
array$extra_tagsarray of substitutions for template to be merged with the one from function..
array$user_listonly notify the selected users
int$module_idID of the module
int$omit_user_idID of the user to omit from notifications. (default to current user). set to 0 for all users to receive notification.
+ Voici le graphe d'appel pour cette fonction :

◆ unsubscribe()

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

Unsubscribe notifications for an event(s).

Paramètres
string$categorycategory of the events
int$item_idID of the item
mixed$eventsevent string or array of events
int$module_idID of the module (default current module)
int$user_idUID of the user (default current user)
Renvoie
bool
+ Voici le graphe d'appel pour cette fonction :

◆ unsubscribeByItem()

unsubscribeByItem (   $module_id,
  $category,
  $item_id 
)

Delete all subscriptions for a particular item.

Paramètres
int$module_idID of the module to which item belongs
string$categoryNotification category of the item
int$item_idID of the item
Renvoie
bool
+ Voici le graphe d'appel pour cette fonction :

◆ unsubscribeByModule()

unsubscribeByModule (   $module_id)

Delete all notifications for a particular module

Paramètres
int$module_idID of the module
Renvoie
bool
+ Voici le graphe d'appel pour cette fonction :

◆ unsubscribeByUser()

unsubscribeByUser (   $user_id)

Delete all notifications for one user

Paramètres
int$user_idID of the user
Renvoie
bool
+ Voici le graphe d'appel pour cette fonction :

◆ updateByField()

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

Update

Paramètres
XoopsNotification$notificationXoopsNotification object
string$field_nameName of the field
mixed$field_valueValue to write
Renvoie
bool
+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

La documentation de cette classe a été générée à partir du fichier suivant :