MediaWiki master
UserNotLoggedIn Class Reference

Redirect a user to the login page. More...

Inherits ErrorPageError.

Collaboration diagram for UserNotLoggedIn:

Public Member Functions

 __construct ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin', $params=[])
 
 report ( $action=self::SEND_OUTPUT)
 Redirect to Special:Userlogin if the specified message is compatible.
 
- Public Member Functions inherited from ErrorPageError
 getMessageObject ()
 Return a Message object for this exception.
 
- Public Member Functions inherited from MWException
 getHTML ()
 Format an HTML message for the current exception object.
 
 getPageTitle ()
 Return the title of the page when reporting this error in a HTTP response.
 
 getText ()
 Format plain text message for the current exception object.
 
 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.
 
 reportHTML ()
 Output the exception report using HTML.
 
 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
 $msg
 
 $params
 
 $title
 
const SEND_OUTPUT = 0
 
const STAGE_OUTPUT = 1
 

Detailed Description

Redirect a user to the login page.

This is essentially an ErrorPageError exception which by default uses the 'exception-nologin' as a title and 'exception-nologin-text' for the message.

Note
In order for this exception to redirect, the error message passed to the constructor has to be explicitly added to LoginHelper::validErrorMessages or with the LoginFormValidErrorMessages hook. Otherwise, the user will just be shown the message rather than redirected.
Example:
if ( $user->isAnon() ) {
throw new UserNotLoggedIn();
}
Redirect a user to the login page.

Note the parameter order differs from ErrorPageError, this allows you to simply specify a reason without overriding the default title.

Example:
if ( $user->isAnon() ) {
throw new UserNotLoggedIn( 'action-require-loggedin' );
}
Stability: newable
See also
T39627
Since
1.20

Definition at line 57 of file UserNotLoggedIn.php.

Constructor & Destructor Documentation

◆ __construct()

UserNotLoggedIn::__construct ( $reasonMsg = 'exception-nologin-text',
$titleMsg = 'exception-nologin',
$params = [] )
Stability: stable
to call
Note
The value of the $reasonMsg parameter must be set with the LoginFormValidErrorMessages hook if you want the user to be automatically redirected to the login form.
Parameters
string$reasonMsgA message key containing the reason for the error. Optional, default: 'exception-nologin-text'
string$titleMsgA message key to set the page title. Optional, default: 'exception-nologin'
array$paramsParameters to wfMessage(). Optional, default: []

Reimplemented from ErrorPageError.

Definition at line 72 of file UserNotLoggedIn.php.

References $params.

Member Function Documentation

◆ report()

UserNotLoggedIn::report ( $action = self::SEND_OUTPUT)

Redirect to Special:Userlogin if the specified message is compatible.

Otherwise, show an error page as usual.

Parameters
int$action

Reimplemented from ErrorPageError.

Definition at line 85 of file UserNotLoggedIn.php.

References MWException\msg(), and wfArrayToCgi().


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