diff options
author | Andreas Fischer <bantu@phpbb.com> | 2013-03-05 04:02:05 +0100 |
---|---|---|
committer | Andreas Fischer <bantu@phpbb.com> | 2013-03-05 22:59:57 +0100 |
commit | 0071ad3bfd88780af24ebf9cb4d02eac76369994 (patch) | |
tree | b03dcf9a53edda17eba4e7f694a1c9bf3c23d771 /phpBB | |
parent | af02681960257a1df344275b2a1eb2893bc470df (diff) | |
download | forums-0071ad3bfd88780af24ebf9cb4d02eac76369994.tar forums-0071ad3bfd88780af24ebf9cb4d02eac76369994.tar.gz forums-0071ad3bfd88780af24ebf9cb4d02eac76369994.tar.bz2 forums-0071ad3bfd88780af24ebf9cb4d02eac76369994.tar.xz forums-0071ad3bfd88780af24ebf9cb4d02eac76369994.zip |
[ticket/10202] Improve method documentation.
PHPBB3-10202
Diffstat (limited to 'phpBB')
-rw-r--r-- | phpBB/includes/config/db_text.php | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/phpBB/includes/config/db_text.php b/phpBB/includes/config/db_text.php index 7563a228f5..6449a2e02b 100644 --- a/phpBB/includes/config/db_text.php +++ b/phpBB/includes/config/db_text.php @@ -75,7 +75,7 @@ class phpbb_config_db_text } /** - * Removes a configuration option + * Removes the configuration option with the name $key. * * @param string $key The configuration option's name * @@ -87,7 +87,9 @@ class phpbb_config_db_text } /** - * Sets a configuration option's value + * Mass set configuration options: Receives an associative array, + * treats array keys as configuration option names and associated + * array values as their configuration option values. * * @param array $map Map from configuration names to values * @@ -118,7 +120,10 @@ class phpbb_config_db_text } /** - * Gets a set of configuration options as a key => value map. + * Mass get configuration options: Receives a set of configuration + * option names and returns the result as a key => value map where + * array keys are configuration option names and array values are + * associated config option values. * * @param array $keys Set of configuration option names * @@ -142,7 +147,7 @@ class phpbb_config_db_text } /** - * Removes multiple configuration options + * Mass delete configuration options. * * @param array $keys Set of configuration option names * |