Class UserconfigsConfigHandler

Userconfigs

UserconfigsConfigHandler

Copyright: XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: trabis lusopoemas@gmail.com
Version: $Id$
Located at odules/userconfigs/class/config.php

Methods summary
`public`	# `__construct( )` Constructor Constructor Overrides `Xoops\Core\Kernel\XoopsObjectHandler::__construct()`
`public UserconfigsItem`	# `createConfig( )` Create a config Create a config Returns `UserconfigsItem` `UserconfigsItem` See `UserconfigsItem`
`public UserconfigsItem`	# `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 `UserconfigsItem` `UserconfigsItem`
`public boolean`	# `insertConfig( UserconfigsItem $config )` insert a new config in the database insert a new config in the database Parameters `$config` `UserconfigsItem` Returns boolean
`public boolean`	# `deleteConfig( UserconfigsItem $config )` Delete a config from the database Delete a config from the database Parameters `$config` `UserconfigsItem` Returns boolean
`public array`	# `getConfigs( Xoops\Core\Kernel\CriteriaElement $criteria = null, boolean $id_as_key = false )` get one or more Configs get one or more Configs Parameters `$criteria` `CriteriaElement` `$id_as_key` Use the configs' ID as keys? Returns array Array of `UserconfigsItem` objects
`public integer`	# `getConfigCount( Xoops\Core\Kernel\CriteriaElement $criteria = null )` Count some configs Count some configs Parameters `$criteria` `CriteriaElement` 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 array of UserconfigsConfigs
`public boolean`	# `deleteConfigsByModule( integer $module = 0 )` Deletes configs from a certain module Deletes configs from a certain module Parameters `$module` Returns boolean
`public array`	# `getConfigsByUser( integer $uid, integer $moduleId )` Get configs from a certain user Get configs from a certain user Parameters `$uid` ID of a user `$moduleId` ID of a module Returns array array of UserconfigsConfigs
`public UserconfigsOption`	# `createConfigOption( )` Make a new `UserconfigsOption` Make a new `UserconfigsOption` Returns `UserconfigsOption` `UserconfigsOption`
`public UserconfigsOption`	# `getConfigOption( integer $id )` Get a `UserconfigsOption` Get a `UserconfigsOption` Parameters `$id` ID of the config option Returns `UserconfigsOption` `UserconfigsOption`
`public array`	# `getConfigOptions( Xoops\Core\Kernel\CriteriaElement $criteria = null, boolean $id_as_key = false )` Get one or more `UserconfigsOption`s Get one or more `UserconfigsOption`s Parameters `$criteria` `CriteriaElement` `$id_as_key` Use IDs as keys in the array? Returns array Array of `UserconfigsOption`s
`public integer`	# `getConfigOptionsCount( Xoops\Core\Kernel\CriteriaElement $criteria = null )` Count some `UserconfigsOption`s Count some `UserconfigsOption`s Parameters `$criteria` `CriteriaElement` Returns integer Count of `UserconfigsOption`s matching $criteria
`public array`	# `getConfigList( integer $conf_modid, integer $conf_uid = 0 )` Get a list of configs Get a list of configs Parameters `$conf_modid` ID of the modules `$conf_uid` ID of the user Returns array Associative array of name=>value pairs.
`public`	# `createDefaultUserConfigs( $uid, Xoops\Core\Kernel\Handlers\XoopsModule $module )`

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

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

Namespaces

Classes

Interfaces

Functions

Class UserconfigsConfigHandler

Overrides

Returns

See

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns