XCL Web Application Platform 2.5.0
The XoopsCube Legacy Project
Loading...
Searching...
No Matches
XoopsNotification Class Reference
Inheritance diagram for XoopsNotification:
XoopsObject AbstractXoopsObject

Public Member Functions

 __construct ()
 
 XoopsNotification ()
 
 notifyUser ($template_dir, $template, $subject, $tags, $onshutdown=false)
 
- Public Member Functions inherited from XoopsObject
 setNew ()
 
 unsetNew ()
 
 isNew ()
 
 setDirty ()
 
 unsetDirty ()
 
 isDirty ()
 
 initVar ($key, $data_type, $value=null, $required=false, $maxlength=null, $options='')
 
 assignVar ($key, $value)
 
 assignVars ($var_arr)
 
 setVar ($key, $value, $not_gpc=false)
 
 setVars ($var_arr, $not_gpc=false)
 
 setFormVars ($var_arr=null, $pref='xo_', $not_gpc=false)
 
getVars ()
 
getVar ($key, $format='s')
 
 getShow ($key)
 
 set ($key, $value)
 
 get ($key)
 
 getProperty ($key)
 
 getProperties ()
 
 cleanVars ()
 
 registerFilter ($filtername)
 
 _loadFilters ()
 
xoopsClone ()
 
 setErrors ($err_str)
 
 getErrors ()
 
 getHtmlErrors ()
 
- Public Member Functions inherited from AbstractXoopsObject
 initVar ($key, $data_type, $default, $required, $size)
 

Additional Inherited Members

- Data Fields inherited from XoopsObject
 $vars = []
 
 $cleanVars = []
 
 $_isNew = false
 
 $_isDirty = false
 
 $_errors = []
 
 $_filters = []
 

Detailed Description

Definition at line 28 of file notification.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( )

constructor

normally, this is called from child classes only @access public

Reimplemented from XoopsObject.

Definition at line 31 of file notification.php.

Member Function Documentation

◆ notifyUser()

notifyUser ( $template_dir,
$template,
$subject,
$tags,
$onshutdown = false )

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
bool$onshutdownFor lazy execution on shutdown
Returns
bool true if success, false if error

Definition at line 65 of file notification.php.

◆ XoopsNotification()

Definition at line 42 of file notification.php.


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