includes/exception/LocalizedException.php

   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 /**
  22  * Basic localized exception.
  23  *
  24  * @since 1.29
  25  * @ingroup Exception
  26  * @note Don't use this in a situation where MessageCache is not functional.
  27  */
  28 class LocalizedException extends Exception implements ILocalizedException {
  29         /** @var string|array|MessageSpecifier */
  30         protected $messageSpec;
  31
  32         /**
  33          * @param string|array|MessageSpecifier $messageSpec See Message::newFromSpecifier
  34          * @param int $code
  35          * @param Exception|Throwable|null $previous The previous exception used for the exception
  36          *  chaining.
  37          */
  38         public function __construct( $messageSpec, $code = 0, $previous = null ) {
  39                 $this->messageSpec = $messageSpec;
  40
  41                 // Exception->getMessage() should be in plain English, not localized.
  42                 // So fetch the English version of the message, without local
  43                 // customizations, and make a basic attempt to turn markup into text.
  44                 $msg = $this->getMessageObject()->inLanguage( 'en' )->useDatabase( false )->text();
  45                 $msg = preg_replace( '!</?(var|kbd|samp|code)>!', '"', $msg );
  46                 $msg = Sanitizer::stripAllTags( $msg );
  47                 parent::__construct( $msg, $code, $previous );
  48         }
  49
  50         public function getMessageObject() {
  51                 return Message::newFromSpecifier( $this->messageSpec );
  52         }
  53 }