XOOPS API 2.5.11 Beta1  UI v0.5
Réalisé par monxoops.fr
Référence du fichier notification_functions.php

Espaces de nommage

 kernel
 

Fonctions

 notificationEnabled ($style, $module_id=null)
 
notificationCategoryInfo ($category_name='', $module_id=null)
 
notificationCommentCategoryInfo ($module_id=null)
 
notificationEvents ($category_name, $enabled_only, $module_id=null)
 
 notificationEventEnabled (&$category, &$event, &$module)
 
notificationEventInfo ($category_name, $event_name, $module_id=null)
 
notificationSubscribableCategoryInfo ($module_id=null)
 
 notificationGenerateConfig (&$category, &$event, $type)
 

Documentation des fonctions

◆ notificationCategoryInfo()

& notificationCategoryInfo (   $category_name = '',
  $module_id = null 
)

Get an associative array of info for a particular notification category in the selected module. If no category is selected, return an array of info for all categories.

Paramètres
string$category_name
int$module_idID of the module (default current module)
+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

◆ notificationCommentCategoryInfo()

& notificationCommentCategoryInfo (   $module_id = null)

Get associative array of info for the category to which comment events belong.

A faire:
This could be more efficient... maybe specify in $modversion['comments'] the notification category. This would also serve as a way to enable notification of comments, and also remove the restriction that all notification categories must have unique item_name. (TODO)
Paramètres
int$module_idID of the module (default current module)
Renvoie
mixed Associative array of category info
+ Voici le graphe d'appel pour cette fonction :

◆ notificationEnabled()

notificationEnabled (   $style,
  $module_id = null 
)

Determine if notification is enabled for the selected module.

Paramètres
string$styleSubscription style: 'block' or 'inline'
int$module_idID of the module (default current module)
Renvoie
bool
+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

◆ notificationEventEnabled()

notificationEventEnabled ( $category,
$event,
$module 
)

Determine whether a particular notification event is enabled. Depends on module config options.

A faire:
Check that this works correctly for comment and other events which depend on additional config options...
Paramètres
array$categoryCategory info array
array$eventEvent info array
object$moduleModule
Renvoie
bool
+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

◆ notificationEventInfo()

& notificationEventInfo (   $category_name,
  $event_name,
  $module_id = null 
)

Get associative array of info for the selected event in the selected category (for the selected module).

Paramètres
string$category_nameNotification category
string$event_nameNotification event
int$module_idID of the module (default current module)
Renvoie
mixed
+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

◆ notificationEvents()

& notificationEvents (   $category_name,
  $enabled_only,
  $module_id = null 
)

Get an array of info for all events (each event has associative array) in the selected category of the selected module.

Paramètres
string$category_nameCategory name
bool$enabled_onlyIf true, return only enabled events
int$module_idID of the module (default current module)
Renvoie
mixed
+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

◆ notificationGenerateConfig()

notificationGenerateConfig ( $category,
$event,
  $type 
)

Generate module config info for a particular category, event pair. The selectable config options are given names depending on the category and event names, and the text depends on the category and event titles. These are pieced together in this function in case we wish to alter the syntax.

Paramètres
array$categoryArray of category info
array$eventArray of event info
string$typeThe particular name to generate return string
Renvoie
bool|string
+ Voici le graphe des appelants de cette fonction :

◆ notificationSubscribableCategoryInfo()

& notificationSubscribableCategoryInfo (   $module_id = null)

Get an array of associative info arrays for subscribable categories for the selected module.

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