1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
|
<?php
/**
* Class to implement stub globals, which are globals that delay loading the
* their associated module code by deferring initialisation until the first
* method call.
*
* Note on unstub loops:
*
* Unstub loops (infinite recursion) sometimes occur when a constructor calls
* another function, and the other function calls some method of the stub. The
* best way to avoid this is to make constructors as lightweight as possible,
* deferring any initialisation which depends on other modules. As a last
* resort, you can use StubObject::isRealObject() to break the loop, but as a
* general rule, the stub object mechanism should be transparent, and code
* which refers to it should be kept to a minimum.
*/
class StubObject {
var $mGlobal, $mClass, $mParams;
/**
* Constructor.
*
* @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;
$this->mClass = $class;
$this->mParams = $params;
}
/**
* Returns a bool value whetever $obj is a stub object. Can be used to break
* a infinite loop when unstubbing an object.
*
* @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);
}
/**
* Function called if any function exists with that name in this object.
* It is used to unstub the object. Only used internally, PHP will call
* self::__call() function and that function will call this function.
* This function will also call the function with the same name in the real
* object.
*
* @param $name String: name of the function called
* @param $args Array: arguments
*/
function _call( $name, $args ) {
$this->_unstub( $name, 5 );
return call_user_func_array( array( $GLOBALS[$this->mGlobal], $name ), $args );
}
/**
* Create a new object to replace this stub object.
* @return object
*/
function _newObject() {
return MWFunction::newObj( $this->mClass, $this->mParams );
}
/**
* Function called by PHP if no function with that name exists in this
* object.
*
* @param $name String: name of the function called
* @param $args Array: arguments
*/
function __call( $name, $args ) {
return $this->_call( $name, $args );
}
/**
* This function creates a new object of the real class and replace it in
* the global variable.
* This is public, for the convenience of external callers wishing to access
* properties, e.g. eval.php
*
* @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.
*/
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 );
$caller = wfGetCaller( $level );
if ( ++$recursionLevel > 2 ) {
throw new MWException( "Unstub loop detected on call of \${$this->mGlobal}->$name from $caller\n" );
}
wfDebug( "Unstubbing \${$this->mGlobal} on call of \${$this->mGlobal}::$name from $caller\n" );
$GLOBALS[$this->mGlobal] = $this->_newObject();
--$recursionLevel;
wfProfileOut( $fname );
}
}
}
/**
* 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' );
}
function __call( $name, $args ) {
return $this->_call( $name, $args );
}
/**
* @return Language
*/
function _newObject() {
global $wgLanguageCode;
$obj = Language::factory( $wgLanguageCode );
$obj->initEncoding();
$obj->initContLang();
return $obj;
}
}
/**
* Stub object for the user language. It depends of the user preferences and
* "uselang" parameter that can be passed to index.php. This object have to be
* in $wgLang global.
*/
class StubUserLang extends StubObject {
function __construct() {
parent::__construct( 'wgLang' );
}
function __call( $name, $args ) {
return $this->_call( $name, $args );
}
/**
* @return Language
*/
function _newObject() {
return RequestContext::getMain()->getLanguage();
}
}
|