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, $status=[])
 
 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?
 

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.
 
- Public Attributes inherited from ErrorPageError
string MessageSpecifier $msg
 
array $params
 
string MessageSpecifier $title
 
const SEND_OUTPUT = 0
 
const STAGE_OUTPUT = 1
 

Detailed Description

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

Stability: newable
Since
1.18

Definition at line 34 of file PermissionsError.php.

Constructor & Destructor Documentation

◆ __construct()

PermissionsError::__construct ( ?string $permission,
$status = [] )
Stability: stable
to call
Parameters
string | null$permissionA permission name or null if unknown
PermissionStatus | array$statusPermissionStatus containing an array of errors, or an error array like in PermissionManager::getPermissionErrors(); must not be empty if $permission is null

Definition at line 49 of file PermissionsError.php.

References StatusValue\fatal(), StatusValue\getMessages(), and StatusValue\isGood().

Member Function Documentation

◆ report()

PermissionsError::report ( $action = self::SEND_OUTPUT)
Stability: stable
to override
Parameters
int$action
Exceptions
FatalError
MWException

Reimplemented from ErrorPageError.

Definition at line 104 of file PermissionsError.php.

References $wgOut.


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