API - XOOPS 2.5.11 Beta 2
By monxoops.fr
XoopsNotification Class Reference
Inheritance diagram for XoopsNotification:
Collaboration diagram for XoopsNotification:

Public Member Functions

 __construct ()
 
 id ($format='N')
 
 not_id ($format='')
 
 not_modid ($format='')
 
 not_category ($format='')
 
 not_itemid ($format='')
 
 not_event ($format='')
 
 not_uid ($format='')
 
 not_mode ($format='')
 
 notifyUser ($template_dir, $template, $subject, $tags)
 
- Public Member Functions inherited from XoopsObject
 __construct ()
 
 XoopsObject ()
 
 setNew ()
 
 unsetNew ()
 
 isNew ()
 
 setDirty ()
 
 unsetDirty ()
 
 isDirty ()
 
 initVar ($key, $data_type, $value=null, $required=false, $maxlength=null, $options='', $enumerations='')
 
 assignVar ($key, $value)
 
 assignVars ($var_arr)
 
 setVar ($key, $value, $not_gpc=false)
 
 setVars ($var_arr, $not_gpc=false)
 
 destroyVars ($var)
 
 destoryVars ($var)
 
 setFormVars ($var_arr=null, $pref='xo_', $not_gpc=false)
 
getVars ()
 
 getValues ($keys=null, $format='s', $maxDepth=1)
 
 getVar ($key, $format=null)
 
 cleanVars ()
 
 registerFilter ($filtername)
 
 _loadFilters ()
 
 loadFilters ($method)
 
 xoopsClone ()
 
 __clone ()
 
 setErrors ($err_str)
 
 getErrors ()
 
 getHtmlErrors ()
 
 toArray ()
 

Additional Inherited Members

- Data Fields inherited from XoopsObject
 $vars = array()
 
 $cleanVars = array()
 
 $_isNew = false
 
 $_isDirty = false
 
 $_errors = array()
 
 $_filters = array()
 

Constructor & Destructor Documentation

◆ __construct()

__construct ( )

Constructor

Reimplemented from XoopsObject.

Here is the call graph for this function:

Member Function Documentation

◆ id()

id (   $format = 'N')

Returns Class Base Variable not_id

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ not_category()

not_category (   $format = '')

Returns Class Base Variable mid

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ not_event()

not_event (   $format = '')

Returns Class Base Variable not_event

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ not_id()

not_id (   $format = '')

Returns Class Base Variable not_id

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ not_itemid()

not_itemid (   $format = '')

Returns Class Base Variable not_itemid

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ not_mode()

not_mode (   $format = '')

Returns Class Base Variable not_mode

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ not_modid()

not_modid (   $format = '')

Returns Class Base Variable not_modid

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ not_uid()

not_uid (   $format = '')

Returns Class Base Variable not_uid

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ notifyUser()

notifyUser (   $template_dir,
  $template,
  $subject,
  $tags 
)

Send a notification message to the user

Parameters
string$template_dirTemplate directory
string$templateTemplate name
string$subjectSubject line for notification message
array$tagsArray of substitutions for template variables
Returns
bool true if success, false if error
Here is the call graph for this function:

The documentation for this class was generated from the following file: