Inheritance diagram for Notifications:

Public Member Functions
	deleteModuleRelations (XoopsModule $module)

	enabled ($style, $module_dirname=null)

	eventEnabled (&$category, &$event, $dirname)

	generateConfig (&$category, &$event, $type)

	getCategory ($category_name= '', $dirname=null)

	getCommentsCategory ($dirname=null)

	getEvent ($category_name, $event_name, $module_dirname=null)

	getEvents ($category_name, $enabled_only, $dirname=null)

	getHandlerNotification ()

	getItem ($category, $item_id, $dirname=null)

	getPluginableConfigs (XoopsModule $module)

	getSubscribableCategories ($module_dirname=null)

	getTags ($category, $item_id, $event, $dirname=null)

	init ()

	insertModuleRelations (XoopsModule $module)

Public Member Functions inherited from Xoops\Module\Helper\HelperAbstract
	disableCache ()

	getConfig ($name)

	getConfigs ()

	getForm ($obj, $name)

	getHandler ($name)

	getModule ()

	init ()

	isCurrentModule ()

	isUserAdmin ()

	loadLanguage ($language)

	loadLocale ()

	path ($path= '')

	redirect ($url, $time=3, $message= '', $addredirect=true, $allowExternalLink=false)

	url ($url= '')

	xoops ()

Static Public Member Functions
static	getInstance ()

Static Public Member Functions inherited from Xoops\Module\Helper\HelperAbstract
static	getInstance ()

Additional Inherited Members
Protected Member Functions inherited from Xoops\Module\Helper\HelperAbstract
	_addLog ($log)

	setDebug ($debug)

	setDirname ($dirname)

Protected Attributes inherited from Xoops\Module\Helper\HelperAbstract
	$_debug = false

	$_dirname = ''

	$_module = null

Detailed Description

Copyright: The XOOPS Project http://sourceforge.net/projects/xoops/ GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)

Author: trabis lusop.nosp@m.oema.nosp@m.s@gma.nosp@m.il.c.nosp@m.om

Version: $Id$

Definition at line 19 of file helper.php.

Member Function Documentation

Notifications::deleteModuleRelations ( XoopsModule $module )

Parameters

XoopsModule $module

Definition at line 515 of file helper.php.

References $config, $config_handler, $configs, $criteria, $xoops, getHandlerNotification(), Xoops\getInstance(), and Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

Notifications::enabled	(	$style,
		$module_dirname = `null`
	)

Parameters

string	$style
null \| string	$module_dirname

Returns: bool

Definition at line 66 of file helper.php.

References $status, $xoops, and Xoops\getInstance().

Here is the call graph for this function:

Notifications::eventEnabled	(	&	$category,
		&	$event,
			$dirname
	)

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

Todo:: Check that this works correctly for comment and other events which depend on additional config options...

Parameters

array	&$category	Category info array
array	&$event	Event info array
string	$dirname	Module

Returns: bool

Definition at line 359 of file helper.php.

References $dirname, $xoops, generateConfig(), and Xoops\getInstance().

Referenced by getEvents().

Here is the call graph for this function:

Here is the caller graph for this function:

Notifications::generateConfig	(	&	$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.

Parameters

array	&$category	Array of category info
array	&$event	Array of event info
string	$type	The particular name to generate

Returns: bool|string

Definition at line 461 of file helper.php.

References $type.

Referenced by eventEnabled().

Here is the caller graph for this function:

Notifications::getCategory	(	$category_name = `''`,
		$dirname = `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.

Parameters