Revert r113650 and reapply r113619 and r113649 with one modification: User::createNew...

[lhc/web/wiklou.git] / includes / SiteConfiguration.php

diff --git a/includes/SiteConfiguration.php b/includes/SiteConfiguration.php
index db2910d..bd5e4d8 100644 (file)
--- a/includes/SiteConfiguration.php
+++ b/includes/SiteConfiguration.php
@@ -1,17 +1,4 @@
 <?php
-
-/**
- * The include paths change after this file is included from commandLine.inc,
- * meaning that require_once() fails to detect that it is including the same
- * file again. We use DIY C-style protection as a workaround.
- */
-
-// Hide this pattern from Doxygen, which spazzes out at it
-/// @cond
-if( !defined( 'SITE_CONFIGURATION' ) ){
-define( 'SITE_CONFIGURATION', 1 );
-/// @endcond
-
 /**
  * This is a class used to hold configuration settings, particularly for multi-wiki sites.
  */
@@ -36,12 +23,12 @@ class SiteConfiguration {
         * Array of domains that are local and can be handled by the same server
         */
        public $localVHosts = array();
-       
+
        /**
         * Optional callback to load full configuration data.
         */
        public $fullLoadCallback = null;
-       
+
        /** Whether or not all data has been loaded */
        public $fullLoadDone = false;
 
@@ -149,6 +136,11 @@ class SiteConfiguration {
        /**
         * Type-safe string replace; won't do replacements on non-strings
         * private?
+        *
+        * @param $from
+        * @param $to
+        * @param $in
+        * @return string
         */
        function doReplace( $from, $to, $in ) {
                if( is_string( $in ) ) {
@@ -204,21 +196,21 @@ class SiteConfiguration {
                return (bool)($this->get( $setting, $wiki, $suffix, array(), $wikiTags ) );
        }
 
-       /** Retrieves an array of local databases */
+       /**
+        * Retrieves an array of local databases
+        *
+        * @return array
+        */
        function &getLocalDatabases() {
                return $this->wikis;
        }
 
-       /** A no-op */
-       function initialise() {
-       }
-
        /**
         * Retrieves the value of a given setting, and places it in a variable passed by reference.
         * @param $setting String ID of the setting name to retrieve
         * @param $wiki String Wiki ID of the wiki in question.
         * @param $suffix String The suffix of the wiki in question.
-        * @param $var Reference The variable to insert the value into.
+        * @param $var array Reference The variable to insert the value into.
         * @param $params Array List of parameters. $.'key' is replaced by $value in all returned data.
         * @param $wikiTags Array The tags assigned to the wiki.
         */
@@ -242,6 +234,11 @@ class SiteConfiguration {
                $this->extractGlobalSetting( $setting, $wiki, $params );
        }
 
+       /**
+        * @param $setting string
+        * @param $wiki string
+        * @param $params array
+        */
        public function extractGlobalSetting( $setting, $wiki, $params ) {
                $value = $this->getSetting( $setting, $wiki, $params );
                if ( !is_null( $value ) ) {
@@ -288,13 +285,15 @@ class SiteConfiguration {
                        'params' => array(),
                );
 
-               if( !is_callable( $this->siteParamsCallback ) )
+               if( !is_callable( $this->siteParamsCallback ) ) {
                        return $default;
+               }
 
                $ret = call_user_func_array( $this->siteParamsCallback, array( $this, $wiki ) );
                # Validate the returned value
-               if( !is_array( $ret ) )
+               if( !is_array( $ret ) ) {
                        return $default;
+               }
 
                foreach( $default as $name => $def ){
                        if( !isset( $ret[$name] ) || ( is_array( $default[$name] ) && !is_array( $ret[$name] ) ) )
@@ -305,7 +304,7 @@ class SiteConfiguration {
        }
 
        /**
-        * Merge params beetween the ones passed to the function and the ones given
+        * Merge params between the ones passed to the function and the ones given
         * by self::$siteParamsCallback for backward compatibility
         * Values returned by self::getWikiParams() have the priority.
         *
@@ -338,6 +337,8 @@ class SiteConfiguration {
        /**
         * Work out the site and language name from a database name
         * @param $db
+        *
+        * @return array
         */
        public function siteFromDB( $db ) {
                // Allow override
@@ -376,10 +377,14 @@ class SiteConfiguration {
         * On encountering duplicate keys, merge the two, but ONLY if they're arrays.
         * PHP's array_merge_recursive() merges ANY duplicate values into arrays,
         * which is not fun
+        *
+        * @param $array1 array
+        *
+        * @return array
         */
        static function arrayMerge( $array1/* ... */ ) {
                $out = $array1;
-               for( $i=1; $i < func_num_args(); $i++ ) {
+               for( $i = 1; $i < func_num_args(); $i++ ) {
                        foreach( func_get_arg( $i ) as $key => $value ) {
                                if ( isset($out[$key]) && is_array($out[$key]) && is_array($value) ) {
                                        $out[$key] = self::arrayMerge( $out[$key], $value );
@@ -394,7 +399,7 @@ class SiteConfiguration {
 
                return $out;
        }
-       
+
        public function loadFullData() {
                if ($this->fullLoadCallback && !$this->fullLoadDone) {
                        call_user_func( $this->fullLoadCallback, $this );
@@ -402,4 +407,3 @@ class SiteConfiguration {
                }
        }
 }
-} // End of multiple inclusion guard