Merge "[JobQueue] Added support for approximate FIFO job queues."
[lhc/web/wiklou.git] / includes / StubObject.php
index f1847a3..cc0adb7 100644 (file)
@@ -1,4 +1,24 @@
 <?php
+/**
+ * Delayed loading of global objects.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
 
 /**
  * Class to implement stub globals, which are globals that delay loading the
@@ -21,10 +41,10 @@ class StubObject {
        /**
         * Constructor.
         *
-        * @param String $global name of the global variable.
-        * @param String $class name of the class of the real object.
-        * @param Array $param array of parameters to pass to contructor of the real
-        *                     object.
+        * @param $global String: name of the global variable.
+        * @param $class String: name of the class of the real object.
+        * @param $params Array: parameters to pass to contructor of the real
+        *               object.
         */
        function __construct( $global = null, $class = null, $params = array() ) {
                $this->mGlobal = $global;
@@ -36,8 +56,8 @@ class StubObject {
         * Returns a bool value whetever $obj is a stub object. Can be used to break
         * a infinite loop when unstubbing an object.
         *
-        * @param Object $obj object to check.
-        * @return bool true if $obj is not an instance of StubObject class.
+        * @param $obj Object to check.
+        * @return Boolean: true if $obj is not an instance of StubObject class.
         */
        static function isRealObject( $obj ) {
                return is_object( $obj ) && !($obj instanceof StubObject);
@@ -50,8 +70,9 @@ class StubObject {
         * This function will also call the function with the same name in the real
         * object.
         *
-        * @param String $name name of the function called.
-        * @param Array $args array of arguments.
+        * @param $name String: name of the function called
+        * @param $args Array: arguments
+        * @return mixed
         */
        function _call( $name, $args ) {
                $this->_unstub( $name, 5 );
@@ -60,17 +81,19 @@ class StubObject {
 
        /**
         * Create a new object to replace this stub object.
+        * @return object
         */
        function _newObject() {
-               return wfCreateObject( $this->mClass, $this->mParams );
+               return MWFunction::newObj( $this->mClass, $this->mParams );
        }
 
        /**
         * Function called by PHP if no function with that name exists in this
         * object.
         *
-        * @param String $name name of the function called
-        * @param Array $args array of arguments
+        * @param $name String: name of the function called
+        * @param $args Array: arguments
+        * @return mixed
         */
        function __call( $name, $args ) {
                return $this->_call( $name, $args );
@@ -82,12 +105,18 @@ class StubObject {
         * This is public, for the convenience of external callers wishing to access
         * properties, e.g. eval.php
         *
-        * @param String $name name of the method called in this object.
-        * @param Integer $level level to go in the stact trace to get the function
-        *                       who called this function.
+        * @param $name String: name of the method called in this object.
+        * @param $level Integer: level to go in the stact trace to get the function
+        *               who called this function.
+        * @throws MWException
         */
        function _unstub( $name = '_unstub', $level = 2 ) {
                static $recursionLevel = 0;
+
+               if ( !($GLOBALS[$this->mGlobal] instanceof StubObject) ) {
+                       return $GLOBALS[$this->mGlobal]; // already unstubbed.
+               }
+
                if ( get_class( $GLOBALS[$this->mGlobal] ) != $this->mClass ) {
                        $fname = __METHOD__.'-'.$this->mGlobal;
                        wfProfileIn( $fname );
@@ -106,10 +135,13 @@ class StubObject {
 /**
  * Stub object for the content language of this wiki. This object have to be in
  * $wgContLang global.
+ *
+ * @deprecated since 1.18
  */
 class StubContLang extends StubObject {
 
        function __construct() {
+               wfDeprecated( __CLASS__, '1.18' );
                parent::__construct( 'wgContLang' );
        }
 
@@ -117,9 +149,12 @@ class StubContLang extends StubObject {
                return $this->_call( $name, $args );
        }
 
+       /**
+        * @return Language
+        */
        function _newObject() {
-               global $wgContLanguageCode;
-               $obj = Language::factory( $wgContLanguageCode );
+               global $wgLanguageCode;
+               $obj = Language::factory( $wgLanguageCode );
                $obj->initEncoding();
                $obj->initContLang();
                return $obj;
@@ -141,56 +176,10 @@ class StubUserLang extends StubObject {
                return $this->_call( $name, $args );
        }
 
+       /**
+        * @return Language
+        */
        function _newObject() {
-               global $wgContLanguageCode, $wgRequest, $wgUser, $wgContLang;
-               $code = $wgRequest->getVal( 'uselang', $wgUser->getOption( 'language' ) );
-
-               // if variant is explicitely selected, use it instead the one from wgUser
-               // see bug #7605
-               if( $wgContLang->hasVariants() && in_array($code, $wgContLang->getVariants()) ){
-                       $variant = $wgContLang->getPreferredVariant();
-                       if( $variant != $wgContLanguageCode )
-                               $code = $variant;
-               }
-
-               # Validate $code
-               if( empty( $code ) || !preg_match( '/^[a-z-]+$/', $code ) || ( $code === 'qqq' ) ) {
-                       wfDebug( "Invalid user language code\n" );
-                       $code = $wgContLanguageCode;
-               }
-
-               if( $code === $wgContLanguageCode ) {
-                       return $wgContLang;
-               } else {
-                       $obj = Language::factory( $code );
-                       return $obj;
-               }
-       }
-}
-
-/**
- * Stub object for the user. The initialisation of the will depend of
- * $wgCommandLineMode. If it's true, it will be an anonymous user and if it's
- * false, the user will be loaded from credidentails provided by cookies. This
- * object have to be in $wgUser global.
- */
-class StubUser extends StubObject {
-
-       function __construct() {
-               parent::__construct( 'wgUser' );
-       }
-
-       function __call( $name, $args ) {
-               return $this->_call( $name, $args );
-       }
-
-       function _newObject() {
-               global $wgCommandLineMode;
-               if( $wgCommandLineMode ) {
-                       $user = new User;
-               } else {
-                       $user = User::newFromSession();
-               }
-               return $user;
+               return RequestContext::getMain()->getLanguage();
        }
 }