Code Coverage
 
Classes and Traits
Functions and Methods
Lines
Total
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
2 / 2
CRAP
100.00% covered (success)
100.00%
5 / 5
DeprecatedGlobal
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
2 / 2
2
100.00% covered (success)
100.00%
5 / 5
 __construct
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
3 / 3
 _newObject
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
2 / 2
<?php
/**
 * Delayed loading of deprecated global objects.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 */
/**
 * Class to allow throwing wfDeprecated warnings
 * when people use globals that we do not want them to.
 */
class DeprecatedGlobal extends StubObject {
    protected $version;
    /**
     * @param string $name Global name
     * @param callable|string $callback Factory function or class name to construct
     * @param string|false $version Version global was deprecated in
     */
    public function __construct( $name, $callback, $version = false ) {
        parent::__construct( $name, $callback );
        $this->version = $version;
    }
    // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore,PSR2.Classes.PropertyDeclaration.ScopeMissing
    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 = StubObject::_unstub
         * 3 = StubObject::_call
         * 4 = StubObject::__call
         * 5 = DeprecatedGlobal::<method of global called>
         * 6 = Actual function using the global.
         * 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();
    }
}