MediaWiki REL1_37
DeprecatedGlobal Class Reference

Class to allow throwing wfDeprecated warnings when people use globals that we do not want them to. More...

Inheritance diagram for DeprecatedGlobal:
Collaboration diagram for DeprecatedGlobal:

Public Member Functions

 __construct ( $name, $callback, $version=false)
 
 _newObject ()
 Create a new object to replace this stub object.
 
- Public Member Functions inherited from StubObject
 __call ( $name, $args)
 Function called by PHP if no function with that name exists in this object.
 
 __get ( $name)
 Function called by PHP if no property with that name exists in this object.
 
 __set ( $name, $value)
 Function called by PHP if no property with that name exists in this object.
 
 _call ( $name, $args)
 Function called if any function exists with that name in this object.
 
 _get ( $name)
 Wrapper for __get(), similar to _call() above.
 
 _set ( $name, $value)
 Wrapper for __set(), similar to _call() above.
 
 _unstub ( $name='_unstub', $level=2)
 This function creates a new object of the real class and replace it in the global variable.
 

Protected Attributes

 $version
 
- Protected Attributes inherited from StubObject
null string $class
 
null callable $factory
 
null string $global
 
array $params
 

Additional Inherited Members

- Static Public Member Functions inherited from StubObject
static isRealObject ( $obj)
 Returns a bool value whenever $obj is a stub object.
 
static unstub (&$obj)
 Unstubs an object, if it is a stub object.
 

Detailed Description

Class to allow throwing wfDeprecated warnings when people use globals that we do not want them to.

Definition at line 27 of file DeprecatedGlobal.php.

Constructor & Destructor Documentation

◆ __construct()

DeprecatedGlobal::__construct (   $name,
  $callback,
  $version = false 
)
Parameters
string$nameGlobal name
callable | string$callbackFactory function or class name to construct
string | false$versionVersion global was deprecated in

Reimplemented from StubObject.

Definition at line 35 of file DeprecatedGlobal.php.

References $version.

Member Function Documentation

◆ _newObject()

DeprecatedGlobal::_newObject ( )

Create a new object to replace this stub object.

Returns
object

Reimplemented from StubObject.

Definition at line 41 of file DeprecatedGlobal.php.

References wfDeprecated().

Member Data Documentation

◆ $version

DeprecatedGlobal::$version
protected

Definition at line 28 of file DeprecatedGlobal.php.

Referenced by __construct().


The documentation for this class was generated from the following file: