$Config - is system object, that responses for system configuration, instance can be obtained in such way:
$Config = \cs\Config::instance();This object allow to get configuration of any module/block, and also general system parameters, configured databases/storages and others.
###[Up](#) Methods$Config object has next public methods:
- core()
- base_url()
- core_url()
- apply()
- cancel()
- save()
- module()
- cancel_available()
Get core options item, if item (or least one in case of many) not present - returns null
Method returns string with base URL of current mirror. For example:
Usually, is used to generate full, non-relative URL to some page of site.
Similar to base_url(), but returns URL of main mirror, not current.
Is used for applying of system configuration without its saving. This is helpful sometimes, because in case, if changes broke your system - you can clean cache even manually, and restore site workability.
Is used in pair with apply() to cancel applied changes.
Is used for saving changes in configuration.
One of the most useful methods. Allows to store configuration of specified module. Method returns object instance of class \cs\Config\Module_Properties.
Whether configuration was applied (not saved) and can be canceled
###[Up](#) Properties$Config object has next public properties:
- core
- db
- storage
- components
- mirrors
Property with most general configuration properties. Example for newly installed system (JSON only for presentation, property returns regular php array):
{
"name" : "CleverStyle test",
"url" : [
"http://cs.test"
],
"admin_email" : "[email protected]",
"closed_title" : "Site closed",
"closed_text" : "<p>Site closed for maintenance<\/p>",
"site_mode" : 1,
"title_delimiter" : " | ",
"title_reverse" : 0,
"cache_compress_js_css" : 0,
"theme" : "CleverStyle",
"language" : "English",
"allow_change_language" : "0",
"multilingual" : 1,
"db_balance" : "0",
"db_mirror_mode" : "0",
"active_languages" : [
"English",
"Russian",
"Ukrainian"
],
"cookie_domain" : [
"cs.test"
],
"inserts_limit" : 1000,
"key_expire" : 120,
"session_expire" : 2592000,
"update_ratio" : 75,
"cookie_prefix" : "",
"timezone" : "Europe/Kiev",
"password_min_length" : 4,
"password_min_strength" : 0,
"smtp" : "1",
"smtp_host" : "",
"smtp_port" : "465",
"smtp_secure" : "ssl",
"smtp_auth" : "1",
"smtp_user" : "",
"smtp_password" : "",
"mail_from_name" : "Administrator of CleverStyle test",
"allow_user_registration" : 1,
"require_registration_confirmation" : 1,
"auto_sign_in_after_registration" : 0,
"registration_confirmation_time" : 1,
"mail_signature" : "",
"mail_from" : "[email protected]",
"rules" : "<p>Site rules<\/p>",
"show_tooltips" : 1,
"remember_user_ip" : 0,
"simple_admin_mode" : 0,
"default_module" : "System",
"put_js_after_body" : 1,
"vulcanization" : 1,
"gravatar_support" : 0
}Most of properties should be understandable from names, some properties are used by system only.
Property, that stores configuration of databases, except the main database, parameters of which are written in configuration file. Structure of this property is following (JSON only for presentation, property returns regular php array):
{
"0" : {
"mirrors" : [
{
"mirror" : "0",
"host" : "localhost",
"driver" : "MySQLi",
"prefix" : "prefix_",
"name" : "CleverStyle",
"user" : "CleverStyle",
"password" : "1111",
"mirrors" : []
}
]
},
"2" : {
"mirrors" : [],
"host" : "localhost",
"driver" : "MySQLi",
"prefix" : "prefix_",
"name" : "CS3",
"user" : "CS3",
"password" : "CS3",
"mirror" : "-1"
},
"3" : {
"mirrors" : [
{
"mirror" : "3",
"host" : "localhost",
"driver" : "MySQLi",
"prefix" : "prefix_",
"name" : "CS2-mirror",
"user" : "CS2-mirror",
"password" : "CS2-mirror",
"mirrors" : []
},
{
"mirror" : "3",
"host" : "localhost",
"driver" : "MySQLi",
"prefix" : "prefix_",
"name" : "CS2-mirror2",
"user" : "CS2-mirror2",
"password" : "CS2-mirror2",
"mirrors" : []
}
],
"host" : "localhost",
"driver" : "MySQLi",
"prefix" : "prefix_",
"name" : "CS2",
"user" : "CS2",
"password" : "CS2"
}
}Property, that stores configuration of storages, except the main storage, parameters of which are written in configuration file. Structure of this property is following (JSON only for presentation, property returns regular php array):
{
"0" : "0",
"1" : {
"host" : "cscms.org",
"driver" : "HTTP",
"user" : "CleverStyle",
"password" : "CleverStyle",
"url" : "http:\/\/cscms.org"
}
}Internal structure of components parameters (JSON only for presentation, property returns regular php array):
{
"modules" : {
"Blogs" : {
"active" : 1,
"db" : {
"posts" : "0",
"comments" : "0"
},
"storage" : [
],
"data" : {
"posts_per_page" : "2",
"max_sections" : "3",
"enable_comments" : "1"
}
},
"Cron" : {
"active" : 0,
"db" : [
],
"storage" : [
]
},
"Static_pages" : {
"active" : 1,
"db" : {
"pages" : "0",
"texts" : "0"
}
},
"System" : {
"active" : 1,
"db" : {
"keys" : "0",
"users" : "0",
"texts" : "0"
}
},
"Test" : {
"active" : 1,
"db" : [
],
"storage" : [
]
}
},
"blocks" : [
{
"position" : "top",
"type" : "html",
"index" : "7625906",
"title" : "Testing title",
"active" : 0,
"start" : 1337627340,
"expire" : 0,
"update" : 3600,
"content" : "<p>Testing content<\/p>"
},
{
"position" : "left",
"type" : "html",
"index" : "7624258",
"title" : "Testing left",
"active" : "1",
"start" : 1337624220,
"expire" : 0,
"update" : 3600,
"content" : "<p>Testing content left<\/p>"
}
]
}Array of all domains, which allowed to access the site.
Contains keys:
- count - Total count
- http - Insecure (http) domains
- https - Secure (https) domains
$Config object supports next events:
- System/Config/init/before
- System/Config/init/after
- System/Config/changed
This event is called right after loading of system configuration, but before system configuration loading and initialization
This event is called right after system configuration initialization
Fired when system configuration changes
###[Up](#) Constants `\cs\Config` class have few constants: * SYSTEM_MODULE * SYSTEM_THEMESystem module name (used by system itself)
System theme name (used by system itself, used in administration interface regardless of system settings)
###[Up](#) \cs\Config\Module_Properties classThis class has next public methods:
- get()
- set()
- db()
- storage()
- enabled()
- disabled()
- installed()
- uninstalled()
Method returns value of stored configuration parameter. If array of parameters is given - associative array of values will be returned. If parameter not found - boolean false will be returned (in case of array - for corresponding parameter).
Also there is simplified way to get single parameter - to get it as property of object:
<?php
$Config = \cs\Config::instance();
$module_conf = $Config->module('News');
$posts_per_page = $module_conf->get('posts_per_page');
// Next line makes the same as previous, but looks more natural
$posts_per_page = $module_conf->posts_per_page;Available only for administrators, for other user will have no effect!
Opposite to ::get() method, is used to store parameters. If $item is string - $value should contain value of specified parameter. Also, $item may be associative array, as it is returned by ::get() method, in this case $value should be omitted. You are free to store strings, numbers and arrays:
<?php
$Config = \cs\Config::instance();
$module_conf = $Config->module('News');
$module_conf->set('posts_per_page', 10);
// Next line makes the same as previous, but looks more natural
$module_conf->posts_per_page = 10;
// Set several parameters at once
$module_conf->set([
'pests_per_page' => 10,
'allow_comments' => 1,
'array_parameter' => [1, 2, 3]
]);Is used to get database index by associated identifier, as it is described in meta.json section of Module architecture.
<?php
$Config = \cs\Config::instance();
$db = \cs\DB::instance();
$users_db_id = $Config->module('System')->db('users');
$result = $db->db($users_db_id)->q(
"SELECT `login`
FROM `[prefix]users`"
);Is used to get storage index by associated identifier, as it is described in meta.json section of Module architecture.
<?php
$Config = \cs\Config::instance();
$Storage = \cs\Storage::instance();
$users_storage_id = $Config->module('System')->storage('images');
$result = $Storage->storage($users_storage_id)->file_put_contents('test', 123);Returns boolean true if module is enabled, and false otherwise
Returns boolean true if module is disabled, and false otherwise
Returns boolean true if module is installed, and false otherwise
Returns boolean true if module is uninstalled, and false otherwise
This class has next public methods:
- get_formatting()
- get_defaults()
- get_multilingual()
- apply_formatting()
Get formats for all supported options. Format includes option type, default value, supported values or ranges, whether option is password or is multilingual.
Get default values for all supported options
Get list of multilingual options
Take options and check each value according to needed format, correct value or use default if needed