DeprecatedGlobal.php

Go to the documentation of this file.

<?php
 
// phpcs:disable MediaWiki.Commenting.FunctionComment.ObjectTypeHintReturn
// phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
 
namespace MediaWiki\StubObject;
 
class DeprecatedGlobal extends StubObject {
    protected $version;
 
    public function __construct( $name, $callback, $version = false ) {
        parent::__construct( $name, $callback );
        $this->version = $version;
    }
 
    public function _newObject() {
        /*
         * Put the caller offset for wfDeprecated as 6, as
         * that gives the function that uses this object, since:
         *
         * 1 = this function ( _newObject )
         * 2 = MediaWiki\StubObject\StubObject::_unstub
         * 3 = MediaWiki\StubObject\StubObject::_call
         * 4 = MediaWiki\StubObject\StubObject::__call
         * 5 = MediaWiki\StubObject\DeprecatedGlobal::<method of global called>
         * 6 = Actual function using the global.
         * (the same applies to _get/__get or _set/__set instead of _call/__call)
         *
         * Of course its theoretically possible to have other call
         * sequences for this method, but that seems to be
         * rather unlikely.
         */
        wfDeprecated( '$' . $this->global, $this->version, false, 6 );
        return parent::_newObject();
    }
}