MediaWiki REL1_30
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 ()
 Output a report about the exception and takes care of formatting.
 
- 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
 getHTML ()
 If $wgShowExceptionDetails is true, return a HTML message with a backtrace to the error, otherwise show a message to ask to set it to true to show that information.
 
 getPageTitle ()
 Return the title of the page when reporting this error in a HTTP response.
 
 getText ()
 Get the text to display when reporting the error on the command line.
 
 isLoggable ()
 Whether to log this exception in the exception debug log.
 
 msg ( $key, $fallback)
 Get a message from i18n.
 
 reportHTML ()
 Output the exception report using HTML.
 
 useMessageCache ()
 Can the extension use the Message class/wfMessage to get i18n-ed messages?
 
 useOutputPage ()
 Should the exception use $wgOut to output the error?
 

Public Attributes

 $errors
 
 $permission
 
- Public Attributes inherited from ErrorPageError
 $msg
 
 $params
 
 $title
 

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.

Since
1.18

Definition at line 28 of file PermissionsError.php.

Constructor & Destructor Documentation

◆ __construct()

PermissionsError::__construct (   $permission,
  $errors = [] 
)
Parameters
string | null$permissionA permission name or null if unknown
array$errorsError message keys or [key, param...] arrays; must not be empty if $permission is null
Exceptions

\InvalidArgumentException

Definition at line 37 of file PermissionsError.php.

References $errors, $permission, $wgLang, as, errors, UserGroupMembership\getLink(), RequestContext\getMain(), and global.

Member Function Documentation

◆ report()

PermissionsError::report ( )

Output a report about the exception and takes care of formatting.

It will be either HTML or plain text based on isCommandLine().

Reimplemented from ErrorPageError.

Definition at line 66 of file PermissionsError.php.

References $wgOut, errors, and global.

Member Data Documentation

◆ $errors

PermissionsError::$errors

Definition at line 29 of file PermissionsError.php.

Referenced by __construct().

◆ $permission

PermissionsError::$permission

Definition at line 29 of file PermissionsError.php.

Referenced by __construct().


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