MediaWiki  1.27.2
StubObject.php
Go to the documentation of this file.
1 <?php
44 class StubObject {
46  protected $global;
47 
49  protected $class;
50 
52  protected $params;
53 
61  public function __construct( $global = null, $class = null, $params = [] ) {
62  $this->global = $global;
63  $this->class = $class;
64  $this->params = $params;
65  }
66 
74  public static function isRealObject( $obj ) {
75  return is_object( $obj ) && !$obj instanceof StubObject;
76  }
77 
86  public static function unstub( &$obj ) {
87  if ( $obj instanceof StubObject ) {
88  $obj = $obj->_unstub( 'unstub', 3 );
89  }
90  }
91 
103  public function _call( $name, $args ) {
104  $this->_unstub( $name, 5 );
105  return call_user_func_array( [ $GLOBALS[$this->global], $name ], $args );
106  }
107 
112  public function _newObject() {
114  'class' => $this->class,
115  'args' => $this->params,
116  'closure_expansion' => false,
117  ] );
118  }
119 
128  public function __call( $name, $args ) {
129  return $this->_call( $name, $args );
130  }
131 
144  public function _unstub( $name = '_unstub', $level = 2 ) {
145  static $recursionLevel = 0;
146 
147  if ( !$GLOBALS[$this->global] instanceof StubObject ) {
148  return $GLOBALS[$this->global]; // already unstubbed.
149  }
150 
151  if ( get_class( $GLOBALS[$this->global] ) != $this->class ) {
152  $caller = wfGetCaller( $level );
153  if ( ++$recursionLevel > 2 ) {
154  throw new MWException( "Unstub loop detected on call of "
155  . "\${$this->global}->$name from $caller\n" );
156  }
157  wfDebug( "Unstubbing \${$this->global} on call of "
158  . "\${$this->global}::$name from $caller\n" );
159  $GLOBALS[$this->global] = $this->_newObject();
160  --$recursionLevel;
161  return $GLOBALS[$this->global];
162  }
163  }
164 }
165 
169 class StubUserLang extends StubObject {
170 
171  public function __construct() {
172  parent::__construct( 'wgLang' );
173  }
174 
187  public function findVariantLink( &$link, &$nt, $ignoreOtherCond = false ) {
188  global $wgLang;
189  $this->_unstub( 'findVariantLink', 3 );
190  $wgLang->findVariantLink( $link, $nt, $ignoreOtherCond );
191  }
192 
196  public function _newObject() {
197  return RequestContext::getMain()->getLanguage();
198  }
199 }
static getObjectFromSpec($spec)
Instantiate an object based on a specification array.
array $params
Definition: StubObject.php:52
_newObject()
Create a new object to replace this stub object.
Definition: StubObject.php:112
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
wfDebug($text, $dest= 'all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as $wgLang
Definition: design.txt:56
if($line===false) $args
Definition: cdb.php:64
the value to return A Title object or null for latest to be modified or replaced by the hook handler or if authentication is not possible after cache objects are set for highlighting & $link
Definition: hooks.txt:2581
static getMain()
Static methods.
$GLOBALS['IP']
_unstub($name= '_unstub', $level=2)
This function creates a new object of the real class and replace it in the global variable...
Definition: StubObject.php:144
Class to implement stub globals, which are globals that delay loading the their associated module cod...
Definition: StubObject.php:44
static unstub(&$obj)
Unstubs an object, if it is a stub object.
Definition: StubObject.php:86
_call($name, $args)
Function called if any function exists with that name in this object.
Definition: StubObject.php:103
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
__construct($global=null, $class=null, $params=[])
Constructor.
Definition: StubObject.php:61
Stub object for the user language.
Definition: StubObject.php:169
findVariantLink(&$link, &$nt, $ignoreOtherCond=false)
Call Language::findVariantLink after unstubbing $wgLang.
Definition: StubObject.php:187
__call($name, $args)
Function called by PHP if no function with that name exists in this object.
Definition: StubObject.php:128
null string $class
Definition: StubObject.php:49
null string $global
Definition: StubObject.php:46
wfGetCaller($level=2)
Get the name of the function which called this function wfGetCaller( 1 ) is the function with the wfG...
static isRealObject($obj)
Returns a bool value whenever $obj is a stub object.
Definition: StubObject.php:74
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:310