Class icms_config_Handler

Configuration handling class. This class acts as an interface for handling general configurations and its modules.

Package: Config
Category: ICMS
Copyright:

License: GNU General Public License (GPL)
Author: Kazumi Ono webmaster@myweb.ne.jp
Located at config/Handler.php

Methods summary
`public static`	# `service( $db,… )` Initialize the config handler. Initialize the config handler. Parameters `$db`,…
`public`	# `__construct( object & $db )` Constructor Constructor Parameters `$db` $db reference to database object
`public object &`	# `createConfig( )` Create a config Create a config Returns object reference to the new `icms_config_Item_Object` See `icms_config_Item_Object`
`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 `icms_config_Item_Object`
`public true\|false`	# `insertConfig( object & $config )` insert a new config in the database insert a new config in the database Parameters `$config` $config reference to the `icms_config_Item_Object` Returns true\|false if inserting config succeeded or not
`public true\|false`	# `deleteConfig( object & $config )` Delete a config from the database Delete a config from the database Parameters `$config` $config reference to a `icms_config_Item_Object` Returns true\|false if deleting config item succeeded or not
`public array`	# `getConfigs( object $criteria = null, boolean $id_as_key = false, boolean $with_options = false )` get one or more Configs get one or more Configs Parameters `$criteria` `icms_db_criteria_Element` `$id_as_key` Use the configs' ID as keys? `$with_options` get the options now? Returns array Array of `icms_config_Item_Object` objects
`public integer`	# `getConfigCount( object $criteria = null )` Count some configs Count some configs Parameters `$criteria` `icms_db_criteria_Element` Returns integer count result
`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 `icms_config_Item_Object`s
`public object &`	# `createConfigOption( )` Make a new `icms_config_option_Object` Make a new `icms_config_option_Object` Returns object `icms_config_option_Object`
`public object &`	# `getConfigOption( integer $id )` Get a `icms_config_option_Object` Get a `icms_config_option_Object` Parameters `$id` ID of the config option Returns object `icms_config_option_Object`
`public array`	# `getConfigOptions( object $criteria = null, boolean $id_as_key = false )` Get one or more `icms_config_option_Object`s Get one or more `icms_config_option_Object`s Parameters `$criteria` `icms_db_criteria_Element` `$id_as_key` Use IDs as keys in the array? Returns array Array of `icms_config_option_Object`s
`public integer`	# `getConfigOptionsCount( object $criteria = null )` Count some `icms_config_option_Object`s Count some `icms_config_option_Object`s Parameters `$criteria` `icms_db_criteria_Element` Returns integer Count of `icms_config_option_Object`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.

Properties summary
`protected static`	`$instance`	#

Packages

Classes

Class icms_config_Handler

Parameters

Parameters

Returns

See

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns