MediaWiki  REL1_31
StubObject.php
Go to the documentation of this file.
1 <?php
22 use Wikimedia\ObjectFactory;
23 
45 class StubObject {
47  protected $global;
48 
50  protected $class;
51 
53  protected $factory;
54 
56  protected $params;
57 
64  public function __construct( $global = null, $class = null, $params = [] ) {
65  $this->global = $global;
66  if ( is_callable( $class ) ) {
67  $this->factory = $class;
68  } else {
69  $this->class = $class;
70  }
71  $this->params = $params;
72  }
73 
81  public static function isRealObject( $obj ) {
82  return is_object( $obj ) && !$obj instanceof StubObject;
83  }
84 
93  public static function unstub( &$obj ) {
94  if ( $obj instanceof StubObject ) {
95  $obj = $obj->_unstub( 'unstub', 3 );
96  }
97  }
98 
110  public function _call( $name, $args ) {
111  $this->_unstub( $name, 5 );
112  return call_user_func_array( [ $GLOBALS[$this->global], $name ], $args );
113  }
114 
119  public function _newObject() {
120  $params = $this->factory
121  ? [ 'factory' => $this->factory ]
122  : [ 'class' => $this->class ];
123  return ObjectFactory::getObjectFromSpec( $params + [
124  'args' => $this->params,
125  'closure_expansion' => false,
126  ] );
127  }
128 
137  public function __call( $name, $args ) {
138  return $this->_call( $name, $args );
139  }
140 
153  public function _unstub( $name = '_unstub', $level = 2 ) {
154  static $recursionLevel = 0;
155 
156  if ( !$GLOBALS[$this->global] instanceof StubObject ) {
157  return $GLOBALS[$this->global]; // already unstubbed.
158  }
159 
160  if ( get_class( $GLOBALS[$this->global] ) != $this->class ) {
161  $caller = wfGetCaller( $level );
162  if ( ++$recursionLevel > 2 ) {
163  throw new MWException( "Unstub loop detected on call of "
164  . "\${$this->global}->$name from $caller\n" );
165  }
166  wfDebug( "Unstubbing \${$this->global} on call of "
167  . "\${$this->global}::$name from $caller\n" );
168  $GLOBALS[$this->global] = $this->_newObject();
169  --$recursionLevel;
170  return $GLOBALS[$this->global];
171  }
172  }
173 }
174 
178 class StubUserLang extends StubObject {
179 
180  public function __construct() {
181  parent::__construct( 'wgLang' );
182  }
183 
196  public function findVariantLink( &$link, &$nt, $ignoreOtherCond = false ) {
197  global $wgLang;
198  $this->_unstub( 'findVariantLink', 3 );
199  $wgLang->findVariantLink( $link, $nt, $ignoreOtherCond );
200  }
201 
205  public function _newObject() {
206  return RequestContext::getMain()->getLanguage();
207  }
208 }
StubObject\$class
null string $class
Definition: StubObject.php:50
StubUserLang\__construct
__construct()
Definition: StubObject.php:180
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
StubObject\$global
null string $global
Definition: StubObject.php:47
array
the array() calling protocol came about after MediaWiki 1.4rc1.
StubObject
Class to implement stub globals, which are globals that delay loading the their associated module cod...
Definition: StubObject.php:45
StubObject\__call
__call( $name, $args)
Function called by PHP if no function with that name exists in this object.
Definition: StubObject.php:137
php
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:37
MWException
MediaWiki exception.
Definition: MWException.php:26
$wgLang
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
$link
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:3021
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
wfDebug
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
Definition: GlobalFunctions.php:994
StubUserLang
Stub object for the user language.
Definition: StubObject.php:178
StubObject\_call
_call( $name, $args)
Function called if any function exists with that name in this object.
Definition: StubObject.php:110
RequestContext\getMain
static getMain()
Get the RequestContext object associated with the main request.
Definition: RequestContext.php:434
StubObject\_newObject
_newObject()
Create a new object to replace this stub object.
Definition: StubObject.php:119
$args
if( $line===false) $args
Definition: cdb.php:64
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
StubObject\__construct
__construct( $global=null, $class=null, $params=[])
Definition: StubObject.php:64
StubObject\isRealObject
static isRealObject( $obj)
Returns a bool value whenever $obj is a stub object.
Definition: StubObject.php:81
StubObject\$params
array $params
Definition: StubObject.php:56
StubUserLang\_newObject
_newObject()
Definition: StubObject.php:205
StubObject\$factory
null callable $factory
Definition: StubObject.php:53
StubObject\_unstub
_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:153
StubObject\unstub
static unstub(&$obj)
Unstubs an object, if it is a stub object.
Definition: StubObject.php:93
wfGetCaller
wfGetCaller( $level=2)
Get the name of the function which called this function wfGetCaller( 1 ) is the function with the wfG...
Definition: GlobalFunctions.php:1547
$GLOBALS
$GLOBALS['IP']
Definition: ComposerHookHandler.php:6
StubUserLang\findVariantLink
findVariantLink(&$link, &$nt, $ignoreOtherCond=false)
Call Language::findVariantLink after unstubbing $wgLang.
Definition: StubObject.php:196