DeprecatedGlobal.php 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. <?php
  2. /**
  3. * Delayed loading of deprecated global objects.
  4. *
  5. * This program is free software; you can redistribute it and/or modify
  6. * it under the terms of the GNU General Public License as published by
  7. * the Free Software Foundation; either version 2 of the License, or
  8. * (at your option) any later version.
  9. *
  10. * This program is distributed in the hope that it will be useful,
  11. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. * GNU General Public License for more details.
  14. *
  15. * You should have received a copy of the GNU General Public License along
  16. * with this program; if not, write to the Free Software Foundation, Inc.,
  17. * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18. * http://www.gnu.org/copyleft/gpl.html
  19. *
  20. * @file
  21. */
  22. /**
  23. * Class to allow throwing wfDeprecated warnings
  24. * when people use globals that we do not want them to.
  25. */
  26. class DeprecatedGlobal extends StubObject {
  27. protected $version;
  28. /**
  29. * @param string $name Global name
  30. * @param callable|string $callback Factory function or class name to construct
  31. * @param bool|string $version Version global was deprecated in
  32. */
  33. function __construct( $name, $callback, $version = false ) {
  34. parent::__construct( $name, $callback );
  35. $this->version = $version;
  36. }
  37. // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore,PSR2.Classes.PropertyDeclaration.ScopeMissing
  38. function _newObject() {
  39. /* Put the caller offset for wfDeprecated as 6, as
  40. * that gives the function that uses this object, since:
  41. * 1 = this function ( _newObject )
  42. * 2 = StubObject::_unstub
  43. * 3 = StubObject::_call
  44. * 4 = StubObject::__call
  45. * 5 = DeprecatedGlobal::<method of global called>
  46. * 6 = Actual function using the global.
  47. * Of course its theoretically possible to have other call
  48. * sequences for this method, but that seems to be
  49. * rather unlikely.
  50. */
  51. wfDeprecated( '$' . $this->global, $this->version, false, 6 );
  52. return parent::_newObject();
  53. }
  54. }