Public Member Functions
&	createConfig ()

&	createConfigOption ()

	deleteConfig (&$config)

	deleteConfigOption (&$criteria)

&	getConfig ($id, $withoptions=false)

	getConfigCount ($criteria=null)

	getConfigList ($conf_modid, $conf_catid=0)

&	getConfigOption ($id)

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

	getConfigOptionsCount ($criteria=null)

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

&	getConfigsByCat ($category, $module=0)

	insertConfig (&$config)

	XoopsConfigHandler (&$db)

Public Attributes
	$_cachedConfigs = array()

	$_cHandler

	$_oHandler

Detailed Description

XOOPS configuration handling class. This class acts as an interface for handling general configurations of XOOPS and its modules.

Author: Kazumi Ono webma.nosp@m.ster.nosp@m.@mywe.nosp@m.b.ne.nosp@m..jp

Todo:

Tests that need to be made:

error handling public

Definition at line 34 of file config.php.

Member Function Documentation

& XoopsConfigHandler::createConfig ( )

Create a config

See Also: XoopsConfigItem

Returns: object reference to the new XoopsConfigItem

Definition at line 79 of file config.php.

& XoopsConfigHandler::createConfigOption ( )

Make a new XoopsConfigOption

Returns: object XoopsConfigOption

Definition at line 214 of file config.php.

XoopsConfigHandler::deleteConfig ( & $config )

Delete a config from the database

Parameters

object &$config reference to a XoopsConfigItem

Definition at line 133 of file config.php.

References $config, $i, and $options.

XoopsConfigHandler::deleteConfigOption ( & $criteria )

#@+

Deprecated:

Definition at line 289 of file config.php.

& XoopsConfigHandler::getConfig	(	$id,
		$withoptions = `false`
	)

Get a config

Parameters

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

Returns: object reference to the XoopsConfig

Definition at line 92 of file config.php.

References $config.

XoopsConfigHandler::getConfigCount ( $criteria = null )

Count some configs

Parameters

object $criteria CriteriaElement

Definition at line 174 of file config.php.

References $criteria.

XoopsConfigHandler::getConfigList	(	$conf_modid,
		$conf_catid = `0`
	)

Get a list of configs

Parameters

int	$conf_modid	ID of the modules
int	$conf_catid	ID of the category

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

Definition at line 266 of file config.php.

References $configs, $criteria, $i, and $ret.

& XoopsConfigHandler::getConfigOption ( $id )

Get a XoopsConfigOption

Parameters

int $id ID of the config option

Returns: object XoopsConfigOption

Definition at line 227 of file config.php.

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

Get one or more XoopsConfigOptions

Parameters

object	$criteria	CriteriaElement
bool	$id_as_key	Use IDs as keys in the array?

Returns: array Array of XoopsConfigOptions

Definition at line 241 of file config.php.

References $criteria.

XoopsConfigHandler::getConfigOptionsCount ( $criteria = null )

Count some XoopsConfigOptions

Parameters

object $criteria CriteriaElement

Returns: int Count of XoopsConfigOptions matching $criteria

Definition at line 253 of file config.php.

References $criteria.

XoopsConfigHandler::getConfigs	(	$criteria = `null`,
		$id_as_key = `false`,
		$with_options = `false`
	)

get one or more Configs

Parameters

object	$criteria	CriteriaElement
bool	$id_as_key	Use the configs' ID as keys?
bool	$with_options	get the options now?

Returns: array Array of XoopsConfigItem objects

Definition at line 164 of file config.php.

References $criteria.

& XoopsConfigHandler::getConfigsByCat	(	$category,
		$module = `0`
	)

Get configs from a certain category

Parameters

int	$category	ID of a category
int	$module	ID of a module

Returns: array array of XoopsConfigs

Definition at line 187 of file config.php.

References $configs, $criteria, $i, $module, and $ret.

XoopsConfigHandler::insertConfig ( & $config )

insert a new config in the database

Parameters

object &$config reference to the XoopsConfigItem

Definition at line 106 of file config.php.

References $config, $i, $msg, and $options.

XoopsConfigHandler::XoopsConfigHandler ( & $db )

Constructor

Parameters

object &$db reference to database object

Definition at line 67 of file config.php.

References $db.

Member Data Documentation

XoopsConfigHandler::$_cachedConfigs = array()

Definition at line 60 of file config.php.

XoopsConfigHandler::$_cHandler

Definition at line 43 of file config.php.

XoopsConfigHandler::$_oHandler

Definition at line 51 of file config.php.

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

L:/0xoops/xoops-2.5.6/htdocs/kernel/config.php

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation