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