XoopsNotification Class Reference

Inheritance diagram for XoopsNotification:

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

Additional Inherited Members
Public Attributes inherited from XoopsObject
	$_errors = array()
	$_filters = array()
	$_isDirty = false
	$_isNew = false
	$cleanVars = array()
	$vars = array()

Detailed Description

Definition at line 35 of file notification.php.

Member Function Documentation

XoopsNotification::id

(

$format = 'N'

)

Returns Class Base Variable not_id

Definition at line 63 of file notification.php.

XoopsNotification::not_category

(

$format = ''

)

Returns Class Base Variable mid

Definition at line 87 of file notification.php.

XoopsNotification::not_event

(

$format = ''

)

Returns Class Base Variable not_event

Definition at line 103 of file notification.php.

XoopsNotification::not_id

(

$format = ''

)

Returns Class Base Variable not_id

Definition at line 71 of file notification.php.

XoopsNotification::not_itemid

(

$format = ''

)

Returns Class Base Variable not_itemid

Definition at line 95 of file notification.php.

XoopsNotification::not_mode

(

$format = ''

)

Returns Class Base Variable not_mode

Definition at line 119 of file notification.php.

XoopsNotification::not_modid

(

$format = ''

)

Returns Class Base Variable not_modid

Definition at line 79 of file notification.php.

XoopsNotification::not_uid

(

$format = ''

)

Returns Class Base Variable not_uid

Definition at line 111 of file notification.php.

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

Send a notification message to the user

Parameters

string	$template_dir	Template directory
string	$template	Template name
string	$subject	Subject line for notification message
array	$tags	Array of substitutions for template variables

Returns

bool true if success, false if error

Definition at line 134 of file notification.php.

References $config_handler, $GLOBALS, $member_handler, $method, $notification_handler, $user, XOOPS_CONF_MAILER, xoops_gethandler(), xoops_getMailer(), XOOPS_NOTIFICATION_METHOD_EMAIL, XOOPS_NOTIFICATION_METHOD_PM, XOOPS_NOTIFICATION_MODE_SENDONCETHENDELETE, XOOPS_NOTIFICATION_MODE_SENDONCETHENWAIT, and XOOPS_NOTIFICATION_MODE_WAITFORLOGIN.

Here is the call graph for this function:

XoopsNotification::XoopsNotification

(

)

Constructor

Definition at line 40 of file notification.php.

References XOBJ_DTYPE_INT, and XOBJ_DTYPE_TXTBOX.

---

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

• L:/0xoops/xoops-2.5.6/htdocs/kernel/notification.php