Inheritance diagram for UserconfigsConfigHandler:

Public Member Functions
	__construct ()

	createConfig ()

	createConfigOption ()

	createDefaultUserConfigs ($uid, XoopsModule $module)

	deleteConfig (UserconfigsItem $config)

	deleteConfigsByModule ($module=0)

	getConfig ($id, $withoptions=false)

	getConfigCount (CriteriaElement $criteria=null)

	getConfigList ($conf_modid, $conf_uid=0)

	getConfigOption ($id)

	getConfigOptions (CriteriaElement $criteria=null, $id_as_key=false)

	getConfigOptionsCount (CriteriaElement $criteria=null)

	getConfigs (CriteriaElement $criteria=null, $id_as_key=false)

	getConfigsByModule ($module=0)

	getConfigsByUser ($uid, $moduleId)

	insertConfig (UserconfigsItem $config)

Public Member Functions inherited from Xoops\Core\Kernel\XoopsObjectHandler
	create ()

	delete (XoopsObject $object, $force=true)

	get ($int_id)

	insert (XoopsObject $object, $force=true)

Private Attributes
	$_cachedConfigs = array()

	$_iHandler

	$_oHandler

Additional Inherited Members
Public Attributes inherited from Xoops\Core\Kernel\XoopsObjectHandler
	$db2

Protected Member Functions inherited from Xoops\Core\Kernel\XoopsObjectHandler
	__construct (Connection $db=null)

Detailed Description

Userconfigs

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 26 of file config.php.

Constructor & Destructor Documentation

UserconfigsConfigHandler::__construct ( )

Constructor

Definition at line 56 of file config.php.

References $helper, and Userconfigs\getInstance().

Here is the call graph for this function:

Member Function Documentation

UserconfigsConfigHandler::createConfig ( )

Create a config

See also: UserconfigsItem

Returns: UserconfigsItem UserconfigsItem

Definition at line 69 of file config.php.

Referenced by createDefaultUserConfigs().

Here is the caller graph for this function:

UserconfigsConfigHandler::createConfigOption ( )

Make a new UserconfigsOption

Returns: UserconfigsOption UserconfigsOption

Definition at line 261 of file config.php.

Referenced by createDefaultUserConfigs().

Here is the caller graph for this function:

UserconfigsConfigHandler::createDefaultUserConfigs	(		$uid,
		XoopsModule	$module
	)

Definition at line 335 of file config.php.

References $config, $configs, $uid, createConfig(), createConfigOption(), Xoops\Core\Kernel\XoopsObject\getVar(), and insertConfig().

Here is the call graph for this function:

UserconfigsConfigHandler::deleteConfig ( UserconfigsItem $config )

Delete a config from the database

Parameters

UserconfigsItem $config UserconfigsItem

Returns: bool

Definition at line 129 of file config.php.

References $count, $i, $options, getConfigOptions(), UserconfigsItem\getConfOptions(), and Xoops\Core\Kernel\XoopsObject\getVar().

Referenced by deleteConfigsByModule().

Here is the call graph for this function:

Here is the caller graph for this function:

UserconfigsConfigHandler::deleteConfigsByModule ( $module = 0 )

Deletes configs from a certain module

Parameters

int $module

Returns: bool

Definition at line 215 of file config.php.

References $configs, $criteria, $i, $module, deleteConfig(), and getConfigs().

Here is the call graph for this function:

UserconfigsConfigHandler::getConfig	(	$id,
		$withoptions = `false`
	)

Get a config

Parameters

int	$id	ID of the config
bool	$withoptions	load the config's options now?

Returns: UserconfigsItem UserconfigsItem

Definition at line 83 of file config.php.

References $config, $id, and getConfigOptions().

Here is the call graph for this function:

UserconfigsConfigHandler::getConfigCount ( CriteriaElement $criteria = null )

Count some configs

Parameters

CriteriaElement | null $criteria CriteriaElement

Returns: int

Definition at line 182 of file config.php.

References $criteria.

UserconfigsConfigHandler::getConfigList	(	$conf_modid,
		$conf_uid = `0`
	)

Get a list of configs

Parameters

int	$conf_modid	ID of the modules
int	$conf_uid	ID of the user

Returns: array Associative array of name=>value pairs.

Definition at line 313 of file config.php.

References $configs, $criteria, and $i.

UserconfigsConfigHandler::getConfigOption ( $id )

Get a UserconfigsOption

Parameters

int $id ID of the config option

Returns: UserconfigsOption UserconfigsOption

Definition at line 274 of file config.php.

References $id.

UserconfigsConfigHandler::getConfigOptions	(	CriteriaElement	$criteria = `null`,
			$id_as_key = `false`
	)

Get one or more UserconfigsOptions

Parameters

CriteriaElement \| null	$criteria	CriteriaElement
bool	$id_as_key	Use IDs as keys in the array?

Returns: array Array of UserconfigsOptions

Definition at line 288 of file config.php.

References $criteria.

Referenced by deleteConfig(), and getConfig().

Here is the caller graph for this function:

UserconfigsConfigHandler::getConfigOptionsCount ( CriteriaElement $criteria = null )

Count some UserconfigsOptions

Parameters

CriteriaElement | null $criteria CriteriaElement

Returns: int Count of UserconfigsOptions matching $criteria

Definition at line 300 of file config.php.

References $criteria.

UserconfigsConfigHandler::getConfigs	(	CriteriaElement	$criteria = `null`,
			$id_as_key = `false`
	)

get one or more Configs

Parameters

CriteriaElement \| null	$criteria	CriteriaElement
bool	$id_as_key	Use the configs' ID as keys?

Returns: array Array of UserconfigsItem objects

Definition at line 159 of file config.php.

References $criteria, and $criteria2.

Referenced by deleteConfigsByModule(), getConfigsByModule(), and getConfigsByUser().

Here is the caller graph for this function:

UserconfigsConfigHandler::getConfigsByModule ( $module = 0 )

Get configs from a certain module

Parameters

int $module ID of a module

Returns: array array of UserconfigsConfigs

Definition at line 194 of file config.php.

References $_cachedConfigs, $configs, $criteria, $i, $module, and getConfigs().

Here is the call graph for this function:

UserconfigsConfigHandler::getConfigsByUser	(	$uid,
		$moduleId
	)

Get configs from a certain user

Parameters

int	$uid	ID of a user
int	$moduleId	ID of a module

Returns: array array of UserconfigsConfigs

Definition at line 236 of file config.php.

References $_cachedConfigs, $configs, $criteria, $i, $uid, and getConfigs().

Here is the call graph for this function:

UserconfigsConfigHandler::insertConfig ( UserconfigsItem $config )

insert a new config in the database

Parameters

UserconfigsItem $config UserconfigsItem

Returns: bool

Definition at line 100 of file config.php.

References $count, $i, $msg, $options, UserconfigsItem\getConfOptions(), Xoops\Core\Kernel\XoopsObject\getVar(), and Xoops\Core\Kernel\XoopsObject\setErrors().

Referenced by createDefaultUserConfigs().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

UserconfigsConfigHandler::$_cachedConfigs = array()

private

Definition at line 51 of file config.php.

Referenced by getConfigsByModule(), and getConfigsByUser().

UserconfigsConfigHandler::$_iHandler

private

Definition at line 34 of file config.php.

UserconfigsConfigHandler::$_oHandler

private

Definition at line 42 of file config.php.

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

C:/usr64/htdocs/modules/userconfigs/class/config.php

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation