ef470ebf7f
These comments do not add anything. I argue they are worse than having no comments, because I have to read them first to understand they actually don't explain anything. Removing them makes room for actual improvements in the future (if needed). Change-Id: Iee70aad681b3385e9af282d5581c10addbb91ac4
66 lines
2.2 KiB
PHP
66 lines
2.2 KiB
PHP
<?php
|
|
/**
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
/**
|
|
* Interface for MediaWiki-localized exceptions
|
|
*
|
|
* @since 1.29
|
|
* @ingroup Exception
|
|
*/
|
|
interface ILocalizedException {
|
|
/**
|
|
* Return a Message object for this exception
|
|
* @return Message
|
|
*/
|
|
public function getMessageObject();
|
|
}
|
|
|
|
/**
|
|
* Basic localized exception.
|
|
*
|
|
* @since 1.29
|
|
* @ingroup Exception
|
|
* @note Don't use this in a situation where MessageCache is not functional.
|
|
*/
|
|
class LocalizedException extends Exception implements ILocalizedException {
|
|
/** @var string|array|MessageSpecifier */
|
|
protected $messageSpec;
|
|
|
|
/**
|
|
* @param string|array|MessageSpecifier $messageSpec See Message::newFromSpecifier
|
|
* @param int $code
|
|
* @param Exception|Throwable $previous The previous exception used for the exception chaining.
|
|
*/
|
|
public function __construct( $messageSpec, $code = 0, $previous = null ) {
|
|
$this->messageSpec = $messageSpec;
|
|
|
|
// Exception->getMessage() should be in plain English, not localized.
|
|
// So fetch the English version of the message, without local
|
|
// customizations, and make a basic attempt to turn markup into text.
|
|
$msg = $this->getMessageObject()->inLanguage( 'en' )->useDatabase( false )->text();
|
|
$msg = preg_replace( '!</?(var|kbd|samp|code)>!', '"', $msg );
|
|
$msg = Sanitizer::stripAllTags( $msg );
|
|
parent::__construct( $msg, $code, $previous );
|
|
}
|
|
|
|
public function getMessageObject() {
|
|
return Message::newFromSpecifier( $this->messageSpec );
|
|
}
|
|
}
|