Class XoopsConfigHandler

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

Package: kernel
Copyright: (c) 2000-2016 XOOPS Project (www.xoops.org)
License: GPL 2 (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono webmaster@myweb.ne.jp
Located at ernel/config.php

Methods summary
`public`	# `__construct( XoopsDatabase $db )` Constructor Constructor Parameters `$db` reference to database object
`public XoopsConfigItem`	# `createConfig( )` Create a config Create a config Returns `XoopsConfigItem` reference to the new `XoopsConfigItem` See `XoopsConfigItem`
`public object`	# `getConfig( integer $id, boolean $withoptions = false )` Get a config Get a config Parameters `$id` ID of the config `$withoptions` load the config's options now? Returns object reference to the XoopsConfig
`public boolean`	# `insertConfig( XoopsConfigItem $config )` insert a new config in the database insert a new config in the database Parameters `$config` reference to the `XoopsConfigItem` Returns boolean
`public boolean`	# `deleteConfig( XoopsConfigItem $config )` Delete a config from the database Delete a config from the database Parameters `$config` reference to a `XoopsConfigItem` Returns boolean
`public array`	# `getConfigs( CriteriaElement $criteria = null, boolean $id_as_key = false, boolean $with_options = false )` get one or more Configs get one or more Configs Parameters `$criteria` `CriteriaElement` `$id_as_key` Use the configs' ID as keys? `$with_options` get the options now? Returns array Array of `XoopsConfigItem` objects
`public integer`	# `getConfigCount( CriteriaElement $criteria = null )` Count some configs Count some configs Parameters `$criteria` `CriteriaElement` Returns integer
`public array &`	# `getConfigsByCat( integer $category, integer $module = 0 )` Get configs from a certain category Get configs from a certain category Parameters `$category` ID of a category `$module` ID of a module Returns array array of XoopsConfigs
`public XoopsConfigOption`	# `createConfigOption( )` Make a new `XoopsConfigOption` Make a new `XoopsConfigOption` Returns `XoopsConfigOption` `XoopsConfigOption`
`public XoopsConfigOption`	# `getConfigOption( integer $id )` Get a `XoopsConfigOption` Get a `XoopsConfigOption` Parameters `$id` ID of the config option Returns `XoopsConfigOption` `XoopsConfigOption`
`public array`	# `getConfigOptions( CriteriaElement $criteria = null, boolean $id_as_key = false )` Get one or more `XoopsConfigOption`s Get one or more `XoopsConfigOption`s Parameters `$criteria` `CriteriaElement` `$id_as_key` Use IDs as keys in the array? Returns array Array of `XoopsConfigOption`s
`public integer`	# `getConfigOptionsCount( CriteriaElement $criteria = null )` Count some `XoopsConfigOption`s Count some `XoopsConfigOption`s Parameters `$criteria` `CriteriaElement` Returns integer Count of `XoopsConfigOption`s matching $criteria
`public array`	# `getConfigList( integer $conf_modid, integer $conf_catid = 0 )` Get a list of configs Get a list of configs Parameters `$conf_modid` ID of the modules `$conf_catid` ID of the category Returns array Associative array of name=>value pairs.
`public boolean`	# `deleteConfigOption( & $criteria )` Deprecated Parameters `$criteria` Returns boolean

Properties summary
`public object`	`$_cHandler` holds reference to config item handler(DAO) class holds reference to config item handler(DAO) class	#
`public object`	`$_oHandler` holds reference to config option handler(DAO) class holds reference to config option handler(DAO) class	#
`public array`	`$_cachedConfigs` holds an array of cached references to config value arrays, indexed on module id and category id holds an array of cached references to config value arrays, indexed on module id and category id	# `array()`

Namespaces

Classes

Interfaces

Exceptions

Functions

Class XoopsConfigHandler

Parameters

Returns

See

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Deprecated

Parameters

Returns