-
Notifications
You must be signed in to change notification settings - Fork 35
icms_config_Handler
Raimondas Rimkevičius edited this page Mar 9, 2020
·
1 revision
Notice: Wiki was automatic generated from project sources as project API documentation. Do not edit manually!
Configuration handling class.
This class acts as an interface for handling general configurations and its modules.
- Class name: icms_config_Handler
- Namespace:
const CATEGORY_MAIN = 1
const CATEGORY_USER = 2
const CATEGORY_METAFOOTER = 3
const CATEGORY_CENSOR = 4
const CATEGORY_SEARCH = 5
const CATEGORY_MAILER = 6
const CATEGORY_AUTH = 7
const CATEGORY_MULILANGUAGE = 8
const CATEGORY_CONTENT = 9
const CATEGORY_PERSONA = 10
const CATEGORY_CAPTCHA = 11
const CATEGORY_PLUGINS = 12
const CATEGORY_AUTOTASKS = 13
const CATEGORY_PURIFIER = 14
protected mixed $instance
- Visibility: protected
- This property is static.
private object $_cHandler
holds reference to config item handler(DAO) class
- Visibility: private
private object $_oHandler
holds reference to config option handler(DAO) class
- Visibility: private
private array $_cachedConfigs = array()
holds an array of cached references to config value arrays, indexed on module id and category id
- Visibility: private
mixed icms_config_Handler::__construct(mixed db)
Constructor
- Visibility: public
- db mixed
\icms_config_Item_Object icms_config_Handler::createConfig()
Create a config
- Visibility: public
\icms_config_Item_Object icms_config_Handler::getConfig(int id, bool withoptions)
Get a config
- Visibility: public
- id int - <p>ID of the config</p>
- withoptions bool - <p>load the config's options now?</p>
bool icms_config_Handler::insertConfig(mixed config)
insert a new config in the database
- Visibility: public
- config mixed
bool icms_config_Handler::deleteConfig(mixed config)
Delete a config from the database
- Visibility: public
- config mixed
\icms_config_Item_Object[] icms_config_Handler::getConfigs(\icms_db_criteria_Element criteria, bool id_as_key, bool with_options)
get one or more Configs
- Visibility: public
- criteria icms_db_criteria_Element - <p>Criteria</p>
- id_as_key bool - <p>Use the configs' ID as keys?</p>
- with_options bool - <p>get the options now?</p>
int icms_config_Handler::getConfigCount(\icms_db_criteria_Element criteria)
Count some configs
- Visibility: public
- criteria icms_db_criteria_Element - <p>Criteria</p>
\icms_config_Item_Object[] icms_config_Handler::getConfigsByCat(int category, int module)
Get configs from a certain category
- Visibility: public
- category int - <p>ID of a category</p>
- module int - <p>ID of a module</p>
\icms_config_option_Object icms_config_Handler::createConfigOption()
Make a new
- Visibility: public
\icms_config_option_Object icms_config_Handler::getConfigOption(int id)
Get a option by id
- Visibility: public
- id int - <p>ID of the config option</p>
\icms_config_option_Object[] icms_config_Handler::getConfigOptions(\icms_db_criteria_Element criteria, bool id_as_key)
Get one or more object(s)
- Visibility: public
- criteria icms_db_criteria_Element - <p>Criteria</p>
- id_as_key bool - <p>Use IDs as keys in the array?</p>
int icms_config_Handler::getConfigOptionsCount(\icms_db_criteria_Element|null criteria)
Count
- Visibility: public
- criteria icms_db_criteria_Element|null - <p>Criteria or null if none criteria should be used</p>
array icms_config_Handler::getConfigList(int conf_modid, int conf_catid)
Get a list of configs
- Visibility: public
- conf_modid int - <p>ID of the modules</p>
- conf_catid int - <p>ID of the category</p>