ApiQueryDisabled.php 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. <?php
  2. /**
  3. * Copyright © 2008 Roan Kattouw "<Firstname>.<Lastname>@gmail.com"
  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. * API module that does nothing
  24. *
  25. * Use this to disable core modules with e.g.
  26. * $wgAPIPropModules['modulename'] = 'ApiQueryDisabled';
  27. *
  28. * To disable top-level modules, use ApiDisabled instead
  29. *
  30. * @ingroup API
  31. */
  32. class ApiQueryDisabled extends ApiQueryBase {
  33. public function execute() {
  34. $this->addWarning( [ 'apierror-moduledisabled', $this->getModuleName() ] );
  35. }
  36. public function getAllowedParams() {
  37. return [];
  38. }
  39. public function getSummaryMessage() {
  40. return 'apihelp-query+disabled-summary';
  41. }
  42. public function getExtendedDescription() {
  43. return 'apihelp-query+disabled-extended-description';
  44. }
  45. }