LocalizedException.php 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. <?php
  2. /**
  3. * This program is free software; you can redistribute it and/or modify
  4. * it under the terms of the GNU General Public License as published by
  5. * the Free Software Foundation; either version 2 of the License, or
  6. * (at your option) any later version.
  7. *
  8. * This program is distributed in the hope that it will be useful,
  9. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11. * GNU General Public License for more details.
  12. *
  13. * You should have received a copy of the GNU General Public License along
  14. * with this program; if not, write to the Free Software Foundation, Inc.,
  15. * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16. * http://www.gnu.org/copyleft/gpl.html
  17. *
  18. * @file
  19. */
  20. /**
  21. * Basic localized exception.
  22. *
  23. * @since 1.29
  24. * @ingroup Exception
  25. * @note Don't use this in a situation where MessageCache is not functional.
  26. */
  27. class LocalizedException extends Exception implements ILocalizedException {
  28. /** @var string|array|MessageSpecifier */
  29. protected $messageSpec;
  30. /**
  31. * @param string|array|MessageSpecifier $messageSpec See Message::newFromSpecifier
  32. * @param int $code
  33. * @param Exception|Throwable|null $previous The previous exception used for the exception
  34. * chaining.
  35. */
  36. public function __construct( $messageSpec, $code = 0, $previous = null ) {
  37. $this->messageSpec = $messageSpec;
  38. // Exception->getMessage() should be in plain English, not localized.
  39. // So fetch the English version of the message, without local
  40. // customizations, and make a basic attempt to turn markup into text.
  41. $msg = $this->getMessageObject()->inLanguage( 'en' )->useDatabase( false )->text();
  42. $msg = preg_replace( '!</?(var|kbd|samp|code)>!', '"', $msg );
  43. $msg = Sanitizer::stripAllTags( $msg );
  44. parent::__construct( $msg, $code, $previous );
  45. }
  46. public function getMessageObject() {
  47. return Message::newFromSpecifier( $this->messageSpec );
  48. }
  49. }