Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
92.31% covered (success)
92.31%
12 / 13
100.00% covered (success)
100.00%
1 / 1
CRAP
100.00% covered (success)
100.00%
1 / 1
UserBlockedError
100.00% covered (success)
100.00%
12 / 12
100.00% covered (success)
100.00%
1 / 1
4
100.00% covered (success)
100.00%
1 / 1
 __construct
100.00% covered (success)
100.00%
12 / 12
100.00% covered (success)
100.00%
1 / 1
4
1<?php
2/**
3 * @license GPL-2.0-or-later
4 * @file
5 */
6
7namespace MediaWiki\Exception;
8
9use MediaWiki\Block\Block;
10use MediaWiki\Context\RequestContext;
11use MediaWiki\Language\RawMessage;
12use MediaWiki\MediaWikiServices;
13use MediaWiki\User\UserIdentity;
14
15/**
16 * Show an error when the user tries to do something whilst blocked.
17 *
18 * @newable
19 * @since 1.18
20 * @ingroup Exception
21 */
22class UserBlockedError extends ErrorPageError {
23    /**
24     * @stable to call
25     * @param Block $block
26     * @param UserIdentity|null $user
27     * @param mixed $language Unused since 1.42
28     * @param string|null $ip
29     */
30    public function __construct(
31        Block $block,
32        ?UserIdentity $user = null,
33        $language = null,
34        $ip = null
35    ) {
36        $context = RequestContext::getMain();
37        if ( $user === null || $ip === null ) {
38            // If any of these are not passed in, use the global context
39            $user = $context->getUser();
40            $ip = $context->getRequest()->getIP();
41        }
42
43        // @todo This should be passed in via the constructor
44        $messages = MediaWikiServices::getInstance()->getFormatterFactory()
45            ->getBlockErrorFormatter( $context )
46            ->getMessages( $block, $user, $ip );
47
48        if ( count( $messages ) === 1 ) {
49            $message = $messages[0];
50        } else {
51            $message = new RawMessage( '* $' . implode( "\n* \$", range( 1, count( $messages ) ) ) );
52            $message->params( $messages )->parse();
53        }
54
55        parent::__construct( 'blockedtitle', $message );
56    }
57}
58
59/** @deprecated class alias since 1.44 */
60class_alias( UserBlockedError::class, 'UserBlockedError' );