1
0
mirror of https://github.com/phpbb/phpbb.git synced 2025-04-21 16:22:22 +02:00

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.
This commit is contained in:
Nils Adermann 2013-02-24 17:30:51 +01:00
commit d5d412e827

View File

@ -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)
{