Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
82.35% covered (warning)
82.35%
14 / 17
50.00% covered (danger)
50.00%
1 / 2
CRAP
0.00% covered (danger)
0.00%
0 / 1
PermissionsError
82.35% covered (warning)
82.35%
14 / 17
50.00% covered (danger)
50.00%
1 / 2
7.27
0.00% covered (danger)
0.00%
0 / 1
 __construct
100.00% covered (success)
100.00%
14 / 14
100.00% covered (success)
100.00%
1 / 1
5
 report
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
6
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\Context\RequestContext;
22use MediaWiki\MediaWikiServices;
23use MediaWiki\Message\Message;
24use MediaWiki\Permissions\PermissionStatus;
25
26/**
27 * Show an error when a user tries to do something they do not have the necessary
28 * permissions for.
29 *
30 * @newable
31 * @since 1.18
32 * @ingroup Exception
33 */
34class PermissionsError extends ErrorPageError {
35    public ?string $permission;
36    public array $errors;
37
38    /**
39     * @stable to call
40     *
41     * @param string|null $permission A permission name or null if unknown
42     * @param array|PermissionStatus $errors Error message keys or [key, param...] arrays or
43     * PermissionStatus containing an array of errors; must not be empty if $permission is null
44     * @throws \InvalidArgumentException
45     */
46    public function __construct( ?string $permission, $errors = [] ) {
47        if ( $errors instanceof PermissionStatus ) {
48            $errors = $errors->toLegacyErrorArray();
49        }
50
51        if ( $permission === null && !$errors ) {
52            throw new \InvalidArgumentException( __METHOD__ .
53                ': $permission and $errors cannot both be empty' );
54        }
55
56        $this->permission = $permission;
57
58        if ( !count( $errors ) ) {
59            $errors = MediaWikiServices::getInstance()
60                ->getPermissionManager()
61                // @phan-suppress-next-line PhanTypeMismatchArgumentNullable Null on permission is check when used here
62                ->newFatalPermissionDeniedStatus( $this->permission, RequestContext::getMain() )
63                ->toLegacyErrorArray();
64        }
65
66        $this->errors = $errors;
67
68        // Give the parent class something to work with
69        parent::__construct( 'permissionserrors', Message::newFromSpecifier( $errors[0] ) );
70    }
71
72    public function report( $action = self::SEND_OUTPUT ) {
73        global $wgOut;
74
75        $wgOut->showPermissionsErrorPage( $this->errors, $this->permission );
76        if ( $action === self::SEND_OUTPUT ) {
77            $wgOut->output();
78        }
79    }
80}