diff options
| author | Nils Adermann <naderman@naderman.de> | 2013-02-24 17:30:51 +0100 |
|---|---|---|
| committer | Nils Adermann <naderman@naderman.de> | 2013-02-24 17:30:51 +0100 |
| commit | d5d412e8271eeee2c416317a9179d5c2005c9383 (patch) | |
| tree | 126a5f1fa6d3c50ac4923a7c102cdfb1ca4911ae | |
| parent | 42b211a4a19dc4e5c496d5f945f6df6109e2cc12 (diff) | |
| parent | 6bf64d5620b1b9f165a65b50042c391a29ef151c (diff) | |
| download | forums-d5d412e8271eeee2c416317a9179d5c2005c9383.tar forums-d5d412e8271eeee2c416317a9179d5c2005c9383.tar.gz forums-d5d412e8271eeee2c416317a9179d5c2005c9383.tar.bz2 forums-d5d412e8271eeee2c416317a9179d5c2005c9383.tar.xz forums-d5d412e8271eeee2c416317a9179d5c2005c9383.zip | |
Merge remote-tracking branch 'github-bantu/ticket/7262' into develop-olympus
* github-bantu/ticket/7262:
[ticket/7262] Add note about set_config() not updating is_dynamic.
[ticket/7262] Add $is_dynamic example to set_config() and set_config_count().
[ticket/7262] Backport set_config() and set_config_count() docs from develop.
| -rw-r--r-- | phpBB/includes/functions.php | 23 |
1 files changed, 21 insertions, 2 deletions
diff --git a/phpBB/includes/functions.php b/phpBB/includes/functions.php index 571c863839..ccd2d3147c 100644 --- a/phpBB/includes/functions.php +++ b/phpBB/includes/functions.php @@ -137,7 +137,18 @@ function request_var($var_name, $default, $multibyte = false, $cookie = false) } /** -* Set config value. Creates missing config entry. +* Sets a configuration option's value. +* +* Please note that this function does not update the is_dynamic value for +* an already existing config option. +* +* @param string $config_name The configuration option's name +* @param string $config_value New configuration value +* @param bool $is_dynamic Whether this variable should be cached (false) or +* if it changes too frequently (true) to be +* efficiently cached. +* +* @return null */ function set_config($config_name, $config_value, $is_dynamic = false) { @@ -166,7 +177,15 @@ function set_config($config_name, $config_value, $is_dynamic = false) } /** -* Set dynamic config value with arithmetic operation. +* Increments an integer config value directly in the database. +* +* @param string $config_name The configuration option's name +* @param int $increment Amount to increment by +* @param bool $is_dynamic Whether this variable should be cached (false) or +* if it changes too frequently (true) to be +* efficiently cached. +* +* @return null */ function set_config_count($config_name, $increment, $is_dynamic = false) { |