XOOPS configuration handling class. This class acts as an interface for handling general configurations of XOOPS and its modules.
| Methods | ||||||||
|---|---|---|---|---|---|---|---|---|
public
|
__construct(XoopsDatabase $db)
Constructor
Constructor Parameters
|
# | ||||||
public
|
createConfig(): XoopsConfigItem
Create a config
Create a config Returnsreference to the new {@link XoopsConfigItem} |
# | ||||||
public
|
getConfig(int $id, bool $withoptions = false): object
Get a config
Get a config Parameters
Returnsreference to the {@link XoopsConfig} |
# | ||||||
public
|
insertConfig(XoopsConfigItem $config): bool
insert a new config in the database
insert a new config in the database Parameters
|
# | ||||||
public
|
deleteConfig(XoopsConfigItem $config): bool
Delete a config from the database
Delete a config from the database Parameters
|
# | ||||||
public
|
getConfigs(CriteriaElement $criteria = null, bool $id_as_key = false, bool $with_options = false): array
get one or more Configs
get one or more Configs Parameters
ReturnsArray of {@link XoopsConfigItem} objects |
# | ||||||
public
|
getConfigCount(CriteriaElement $criteria = null): int
Count some configs
Count some configs Parameters
|
# | ||||||
public
&
|
getConfigsByCat(int $category, int $module = 0): array
Get configs from a certain category
Get configs from a certain category Parameters
Returnsarray of {@link XoopsConfig}s |
# | ||||||
public
|
createConfigOption(): XoopsConfigOption
Make a new {@link XoopsConfigOption}
Make a new {@link XoopsConfigOption} Returns{@link XoopsConfigOption} |
# | ||||||
public
|
getConfigOption(int $id): XoopsConfigOption
Get a {@link XoopsConfigOption}
Get a {@link XoopsConfigOption} Parameters
Returns{@link XoopsConfigOption} |
# | ||||||
public
|
getConfigOptions(CriteriaElement $criteria = null, bool $id_as_key = false): array
Get one or more {@link XoopsConfigOption}s
Get one or more {@link XoopsConfigOption}s Parameters
ReturnsArray of {@link XoopsConfigOption}s |
# | ||||||
public
|
getConfigOptionsCount(CriteriaElement $criteria = null): int
Count some {@link XoopsConfigOption}s
Count some {@link XoopsConfigOption}s Parameters
ReturnsCount of {@link XoopsConfigOption}s matching $criteria |
# | ||||||
public
|
getConfigList(int $conf_modid, int $conf_catid = 0): array
Get a list of configs
Get a list of configs Parameters
ReturnsAssociative array of name=>value pairs. |
# | ||||||
public
|
deleteConfigOption(&$criteria)
|
# | ||||||
| Properties | |||
|---|---|---|---|
public
|
object
|
$_cHandler
|
# |
public
|
object
|
$_oHandler
|
# |
public
|
array
|
$_cachedConfigs = []
|
# |