XoopsConfigHandler Class Reference

List of all members.

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

---

Detailed Description

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

Author:

Kazumi Ono <webmaster@myweb.ne.jp>

Todo:

Tests that need to be made:

• error handling public

---

Member Function Documentation

XoopsConfigHandler::XoopsConfigHandler

(

&$

db

)

Constructor

Parameters:

object

&$db reference to database object

& XoopsConfigHandler::createConfig

(

)

Create a config

See also:

XoopsConfigItem

Returns:

object reference to the new XoopsConfigItem

& 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

XoopsConfigHandler::insertConfig

(

&$

config

)

insert a new config in the database

Parameters:

object

&$config reference to the XoopsConfigItem

XoopsConfigHandler::deleteConfig

(

&$

config

)

Delete a config from the database

Parameters:

object

&$config reference to a XoopsConfigItem

& 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

XoopsConfigHandler::getConfigCount

(

$

criteria = null

)

Count some configs

Parameters:

object

$criteria CriteriaElement

& 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

& XoopsConfigHandler::getConfigsByDirname	(	$	dirname,
		$	category = 0
	)

Get configs by dirname.

Parameters:

	string	$dirname
	int	$category ID of a category. (Reserved)

& XoopsConfigHandler::createConfigOption

(

)

Make a new XoopsConfigOption

Returns:

object XoopsConfigOption

& XoopsConfigHandler::getConfigOption

(

$

id

)

Get a XoopsConfigOption

Parameters:

int

$id ID of the config option

Returns:

object XoopsConfigOption

& 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

XoopsConfigHandler::getConfigOptionsCount

(

$

criteria = null

)

Count some XoopsConfigOptions

Parameters:

object

$criteria CriteriaElement

Returns:

int Count of XoopsConfigOptions matching $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.

---

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

• C:/cube_beta/html/kernel/config.php

---