MediaWiki  master
PermissionsError Class Reference

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

Inheritance diagram for PermissionsError:
Collaboration diagram for PermissionsError:

Public Member Functions

 __construct ( $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! More...
 
 getMessageObject ()
 Return a Message object for this exception. More...
 
- Public Member Functions inherited from MWException
 getHTML ()
 Format an HTML message for the current exception object. More...
 
 getPageTitle ()
 Return the title of the page when reporting this error in a HTTP response. More...
 
 getText ()
 Format plain text message for the current exception object. More...
 
 isLoggable ()
 Whether to log this exception in the exception debug log. More...
 
 msg ( $key, $fallback,... $params)
 Get a message from i18n. More...
 
 report ()
 Output a report about the exception and takes care of formatting. More...
 
 reportHTML ()
 Output the exception report using HTML. More...
 
 useMessageCache ()
 Can the extension use the Message class/wfMessage to get i18n-ed messages? More...
 

Public Attributes

 $errors
 
 $permission
 
- Public Attributes inherited from ErrorPageError
 $msg
 
 $params
 
 $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. More...
 

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 32 of file PermissionsError.php.

Constructor & Destructor Documentation

◆ __construct()

PermissionsError::__construct (   $permission,
  $errors = [] 
)
Stability: stable
to call
Parameters
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
Exceptions

Definition at line 43 of file PermissionsError.php.

References $errors, $permission, $wgLang, UserGroupMembership\getLink(), RequestContext\getMain(), and Message\newFromSpecifier().

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 80 of file PermissionsError.php.

References $wgOut.

Member Data Documentation

◆ $errors

PermissionsError::$errors

Definition at line 33 of file PermissionsError.php.

Referenced by __construct().

◆ $permission

PermissionsError::$permission

Definition at line 33 of file PermissionsError.php.

Referenced by __construct().


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