6eec17e9a9
Add doc-typehints to class properties found by the PropertyDocumentation sniff to improve the documentation. Once the sniff is enabled it avoids that new code is missing type declarations. This is focused on documentation and does not change code. Change-Id: I1da4b272a6b28c419cc8e860d142dae19ca0bbcf
67 lines
2.3 KiB
PHP
67 lines
2.3 KiB
PHP
<?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
|
|
*/
|
|
|
|
namespace MediaWiki\StubObject;
|
|
|
|
/**
|
|
* Class to allow throwing wfDeprecated warnings
|
|
* when people use globals that we do not want them to.
|
|
*/
|
|
class DeprecatedGlobal extends StubObject {
|
|
/** @var string|false */
|
|
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
|
|
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();
|
|
}
|
|
}
|
|
|
|
/** @deprecated class alias since 1.40 */
|
|
class_alias( DeprecatedGlobal::class, 'DeprecatedGlobal' );
|