diff options
| author | Andreas Fischer <bantu@phpbb.com> | 2013-02-24 12:54:05 +0100 |
|---|---|---|
| committer | Andreas Fischer <bantu@phpbb.com> | 2013-02-24 13:07:37 +0100 |
| commit | e8b3e8498d9842296a905fdaad8c0c32e31bceb4 (patch) | |
| tree | 6a0ef760c017322207cc06d01c6b05232271e2c3 | |
| parent | 42b211a4a19dc4e5c496d5f945f6df6109e2cc12 (diff) | |
| download | forums-e8b3e8498d9842296a905fdaad8c0c32e31bceb4.tar forums-e8b3e8498d9842296a905fdaad8c0c32e31bceb4.tar.gz forums-e8b3e8498d9842296a905fdaad8c0c32e31bceb4.tar.bz2 forums-e8b3e8498d9842296a905fdaad8c0c32e31bceb4.tar.xz forums-e8b3e8498d9842296a905fdaad8c0c32e31bceb4.zip | |
[ticket/7262] Backport set_config() and set_config_count() docs from develop.
PHPBB3-7262
| -rw-r--r-- | phpBB/includes/functions.php | 18 |
1 files changed, 16 insertions, 2 deletions
diff --git a/phpBB/includes/functions.php b/phpBB/includes/functions.php index 571c863839..04b69f8c69 100644 --- a/phpBB/includes/functions.php +++ b/phpBB/includes/functions.php @@ -137,7 +137,14 @@ function request_var($var_name, $default, $multibyte = false, $cookie = false) } /** -* Set config value. Creates missing config entry. +* Sets a configuration option's value. +* +* @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 or if it +* changes too frequently to be efficiently cached. +* +* @return null */ function set_config($config_name, $config_value, $is_dynamic = false) { @@ -166,7 +173,14 @@ 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 or if it +* changes too frequently to be efficiently cached. +* +* @return null */ function set_config_count($config_name, $increment, $is_dynamic = false) { |