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