summaryrefslogtreecommitdiff
path: root/inc/confutils.php
diff options
context:
space:
mode:
authorChristopher Smith <chris@jalakai.co.uk>2015-05-28 12:18:36 +0100
committerChristopher Smith <chris@jalakai.co.uk>2015-05-28 12:18:36 +0100
commit4286c64e98499b93056c09498c10709f8909befd (patch)
tree49d3d77ab75d2126997a21462e6ea67e95701af0 /inc/confutils.php
parent330582bbf07eadbac5f3cca7b9b3537f8948e197 (diff)
downloadrpg-4286c64e98499b93056c09498c10709f8909befd.tar.gz
rpg-4286c64e98499b93056c09498c10709f8909befd.tar.bz2
update confToHash() inline documentation for new parameter
Diffstat (limited to 'inc/confutils.php')
-rw-r--r--inc/confutils.php5
1 files changed, 5 insertions, 0 deletions
diff --git a/inc/confutils.php b/inc/confutils.php
index 4035d6dd4..8b61a8d5b 100644
--- a/inc/confutils.php
+++ b/inc/confutils.php
@@ -206,6 +206,11 @@ function confToHash($file,$lower=false) {
* @param string $type the configuration settings to be read, must correspond to a key/array in $config_cascade
* @param callback $fn the function used to process the configuration file into an array
* @param array $params optional additional params to pass to the callback
+ * @param callback $combine the function used to combine arrays of values read from different configuration files;
+ * the function takes two parameters,
+ * $combined - the already read & merged configuration values
+ * $new - array of config values from the config cascade file being currently processed
+ * and returns an array of the merged configuration values.
* @return array configuration values
*/
function retrieveConfig($type,$fn,$params=null,$combine='array_merge') {