Merge branch 'develop-olympus' into develop

* develop-olympus:
  [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.

Conflicts:
	phpBB/includes/functions.php
This commit is contained in:
Nils Adermann 2013-02-24 17:33:41 +01:00
commit 54f34dd26f

View file

@ -97,7 +97,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
* *
* @deprecated * @deprecated
*/ */
@ -119,7 +130,15 @@ function set_config($config_name, $config_value, $is_dynamic = false, phpbb_conf
} }
/** /**
* 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
* *
* @deprecated * @deprecated
*/ */