XoopsConfigHandler Class Reference

Public Member Functions
	__construct (XoopsDatabase $db)
	createConfig ()
	getConfig ($id, $withoptions=false)
	insertConfig (XoopsConfigItem $config)
	deleteConfig (XoopsConfigItem $config)
	getConfigs (CriteriaElement $criteria=null, $id_as_key=false, $with_options=false)
	getConfigCount (CriteriaElement $criteria=null)
&	getConfigsByCat ($category, $module=0)
	createConfigOption ()
	getConfigOption ($id)
	getConfigOptions (CriteriaElement $criteria=null, $id_as_key=false)
	getConfigOptionsCount (CriteriaElement $criteria=null)
	getConfigList ($conf_modid, $conf_catid=0)
	deleteConfigOption (&$criteria)

Data Fields
	$_cHandler
	$_oHandler
	$_cachedConfigs = array()

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 @access public

Constructor & Destructor Documentation

__construct()

__construct

(

XoopsDatabase

$db

)

Constructor

Parameters

XoopsDatabase

$db

reference to database object

Member Function Documentation

createConfig()

createConfig

(

)

Create a config

See also

XoopsConfigItem

Returns

XoopsConfigItem reference to the new XoopsConfigItem

createConfigOption()

createConfigOption

(

)

Make a new XoopsConfigOption

Returns

XoopsConfigOption XoopsConfigOption

deleteConfig()

deleteConfig

(

XoopsConfigItem

$config

)

Delete a config from the database

Parameters

XoopsConfigItem

$config

reference to a XoopsConfigItem

Returns

bool

Here is the call graph for this function:

deleteConfigOption()

deleteConfigOption

(

&

$criteria

)

#+

Deprecated:

Parameters

$criteria

Returns

bool

getConfig()

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

Here is the call graph for this function:

getConfigCount()

getConfigCount

(

CriteriaElement

$criteria = null

)

Count some configs

Parameters

CriteriaElement

$criteria

CriteriaElement

Returns

int

getConfigList()

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.

getConfigOption()

getConfigOption

(

$id

)

Get a XoopsConfigOption

Parameters

int

$id

ID of the config option

Returns

XoopsConfigOption XoopsConfigOption

getConfigOptions()

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

Get one or more XoopsConfigOptions

Parameters

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

Returns

array Array of XoopsConfigOptions

Here is the caller graph for this function:

getConfigOptionsCount()

getConfigOptionsCount

(

CriteriaElement

$criteria = null

)

Count some XoopsConfigOptions

Parameters

CriteriaElement

$criteria

CriteriaElement

Returns

int Count of XoopsConfigOptions matching $criteria

getConfigs()

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

get one or more Configs

Parameters

CriteriaElement	$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

Here is the caller graph for this function:

getConfigsByCat()

& 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

Here is the call graph for this function:

insertConfig()

insertConfig

(

XoopsConfigItem

$config

)

insert a new config in the database

Parameters

XoopsConfigItem

$config

reference to the XoopsConfigItem

Returns

bool

Field Documentation

$_cachedConfigs

$_cachedConfigs = array()

$_cHandler

$_cHandler

$_oHandler

$_oHandler

---

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

• C:/xoops2511b2/htdocs/kernel/config.php