MDL-45339 Libraries: Add a note to docblock of get_config, set_config, and unset_config to note they are used in lib/db/upgrade.php

This commit is contained in:
John Okely
2014-07-17 17:48:15 +08:00
parent 85cd13b837
commit 803d739f4a
+6
View File
@@ -1329,6 +1329,8 @@ function html_is_blank($string) {
*
* A NULL value will delete the entry.
*
* NOTE: this function is called from lib/db/upgrade.php
*
* @param string $name the key to set
* @param string $value the value to set (without magic quotes)
* @param string $plugin (optional) the plugin scope, default null
@@ -1399,6 +1401,8 @@ function set_config($name, $value, $plugin=null) {
* If called with 2 parameters it will return a string single
* value or false if the value is not found.
*
* NOTE: this function is called from lib/db/upgrade.php
*
* @static string|false $siteidentifier The site identifier is not cached. We use this static cache so
* that we need only fetch it once per request.
* @param string $plugin full component name
@@ -1485,6 +1489,8 @@ function get_config($plugin, $name = null) {
/**
* Removes a key from global configuration.
*
* NOTE: this function is called from lib/db/upgrade.php
*
* @param string $name the key to set
* @param string $plugin (optional) the plugin scope
* @return boolean whether the operation succeeded.