MediaWiki master
PermissionsError Class Reference

Show an error when a user tries to do something they do not have the necessary permissions for. More...

Inherits ErrorPageError.

Collaboration diagram for PermissionsError:

Public Member Functions

 __construct (?string $permission, $errors=[])
 report ( $action=self::SEND_OUTPUT)
- Public Member Functions inherited from ErrorPageError
 __construct ( $title, $msg, $params=[])
 Note: these arguments are keys into wfMessage(), not text!
 getMessageObject ()
 Return a Message object for this exception.
- Public Member Functions inherited from MWException
 hasOverriddenHandler ()
 isLoggable ()
 Whether to log this exception in the exception debug log.
 msg ( $key, $fallback,... $params)
 Get a message from i18n.
 report ()
 Output a report about the exception and takes care of formatting.
 useMessageCache ()
 Can the extension use the Message class/wfMessage to get i18n-ed messages?

Public Attributes

array $errors
string $permission
- Public Attributes inherited from ErrorPageError
string MessageSpecifier $msg
array $params
string MessageSpecifier $title
const SEND_OUTPUT = 0
const STAGE_OUTPUT = 1

Additional Inherited Members

- Static Public Member Functions inherited from MWException
static isCommandLine ()
 Check whether we are in command line mode or not to report the exception in the correct format.

Detailed Description

Show an error when a user tries to do something they do not have the necessary permissions for.

Stability: newable

Definition at line 34 of file PermissionsError.php.

Constructor & Destructor Documentation

◆ __construct()

PermissionsError::__construct ( ?string $permission,
$errors = [] )
Stability: stable
to call
string | null$permissionA permission name or null if unknown
array | PermissionStatus$errorsError message keys or [key, param...] arrays or PermissionStatus containing an array of errors; must not be empty if $permission is null


Definition at line 46 of file PermissionsError.php.

Member Function Documentation

◆ report()

PermissionsError::report ( $action = self::SEND_OUTPUT)
Stability: stable
to override

Reimplemented from ErrorPageError.

Definition at line 72 of file PermissionsError.php.

References $wgOut.

Member Data Documentation

◆ $errors

array PermissionsError::$errors

Definition at line 36 of file PermissionsError.php.

◆ $permission

string PermissionsError::$permission

Definition at line 35 of file PermissionsError.php.

The documentation for this class was generated from the following file: