Class XoopsConfigHandler

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

Xoops\Core\Kernel\XoopsObjectHandler

Xoops\Core\Kernel\Handlers\XoopsConfigHandler

Direct known subclasses

XoopsConfigHandler

Namespace: Xoops\Core\Kernel\Handlers
Package: Xoops\Core\Kernel
Category: Xoops\Core\Kernel\Handlers\XoopsConfigHandler
Copyright: 2000-2015 XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono webmaster@myweb.ne.jp
Link: http://xoops.org
Located at oops_lib/Xoops/Core/Kernel/Handlers/XoopsConfigHandler.php

Methods summary
`public`	# `__construct( )` Constructor Constructor Overrides `Xoops\Core\Kernel\XoopsObjectHandler::__construct()`
`public Xoops\Core\Kernel\Handlers\XoopsConfigItem`	# `createConfig( )` Create a config Create a config Returns `Xoops\Core\Kernel\Handlers\XoopsConfigItem`
`public Xoops\Core\Kernel\Handlers\XoopsConfigItem`	# `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 `Xoops\Core\Kernel\Handlers\XoopsConfigItem`
`public boolean`	# `insertConfig( Xoops\Core\Kernel\Handlers\XoopsConfigItem $config )` insert a new config in the database insert a new config in the database Parameters `$config` configuration item Returns boolean
`public boolean`	# `deleteConfig( Xoops\Core\Kernel\Handlers\XoopsConfigItem $config )` Delete a config from the database Delete a config from the database Parameters `$config` configuration item Returns boolean
`public Xoops\Core\Kernel\Handlers\XoopsConfigItem[]`	# `getConfigs( Xoops\Core\Kernel\CriteriaElement $criteria = null, boolean $id_as_key = false )` get one or more Configs get one or more Configs Parameters `$criteria` criteria to match `$id_as_key` Use the configs' ID as keys? Returns `Xoops\Core\Kernel\Handlers\XoopsConfigItem[]`
`public integer`	# `getConfigCount( Xoops\Core\Kernel\CriteriaElement $criteria = null )` Count some configs Count some configs Parameters `$criteria` criteria to match Returns integer
`public array`	# `getConfigsByModule( integer $module = 0 )` Get configs from a certain module Get configs from a certain module Parameters `$module` ID of a module Returns array of configuration values
`public array`	# `getConfigsByCat( integer $category, integer $module = 0 )` Get configs from a certain category Get configs from a certain category Deprecated Use getConfigsByModule instead Parameters `$category` ID of a category `$module` ID of a module Returns array of configuration values
`public Xoops\Core\Kernel\Handlers\XoopsConfigOption`	# `createConfigOption( )` Make a new XoopsConfigOption Make a new XoopsConfigOption Returns `Xoops\Core\Kernel\Handlers\XoopsConfigOption`
`public Xoops\Core\Kernel\Handlers\XoopsConfigOption`	# `getConfigOption( integer $id )` Get a XoopsConfigOption Get a XoopsConfigOption Parameters `$id` ID of the config option Returns `Xoops\Core\Kernel\Handlers\XoopsConfigOption`
`public Xoops\Core\Kernel\Handlers\XoopsConfigOption[]`	# `getConfigOptions( Xoops\Core\Kernel\CriteriaElement $criteria = null, boolean $id_as_key = false )` Get one or more XoopsConfigOption objects Get one or more XoopsConfigOption objects Parameters `$criteria` criteria to match `$id_as_key` Use IDs as keys in the array? Returns `Xoops\Core\Kernel\Handlers\XoopsConfigOption[]`
`public integer`	# `getConfigOptionsCount( Xoops\Core\Kernel\CriteriaElement $criteria = null )` Count options Count options Parameters `$criteria` criteria to match Returns integer Count of options 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.

Methods inherited from Xoops\Core\Kernel\XoopsObjectHandler
`create(), delete(), get(), insert()`

Properties inherited from Xoops\Core\Kernel\XoopsObjectHandler
`$db2`

Namespaces

Classes

Class XoopsConfigHandler

Direct known subclasses

Overrides

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Deprecated

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns