Redirect a user to the login page. More...
Public Member Functions | |
| __construct ($reasonMsg= 'exception-nologin-text', $titleMsg= 'exception-nologin', $params=array()) | |
| report () | |
| Redirect to Special:Userlogin if the specified message is compatible. | |
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 LoginForm::validErrorMessages. Otherwise, the user will just be shown the message rather than redirected.
- Example:
if( $user->isAnon() ) { throw new UserNotLoggedIn(); }
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' ); }
- See also:
- bug 37627
- Since:
- 1.20
Definition at line 52 of file UserNotLoggedIn.php.
Constructor & Destructor Documentation
| UserNotLoggedIn::__construct | ( | $ | reasonMsg = 'exception-nologin-text', |
| $ | titleMsg = 'exception-nologin', |
||
| $ | params = array() |
||
| ) |
- Note:
- The value of the $reasonMsg parameter must be put into LoginForm::validErrorMessages if you want the user to be automatically redirected to the login form.
- Parameters:
-
string $reasonMsg A message key containing the reason for the error. Optional, default: 'exception-nologin-text' string $titleMsg A message key to set the page title. Optional, default: 'exception-nologin' array $params Parameters to wfMessage(). Optional, default: array()
Reimplemented from ErrorPageError.
Definition at line 65 of file UserNotLoggedIn.php.
References ErrorPageError\$params.
Member Function Documentation
Redirect to Special:Userlogin if the specified message is compatible.
Otherwise, show an error page as usual.
Reimplemented from ErrorPageError.
Definition at line 77 of file UserNotLoggedIn.php.
References $output, $query, LoginForm\$validErrorMessages, array(), RequestContext\getMain(), SpecialPage\getTitleFor(), MWException\msg(), and wfArrayToCgi().
The documentation for this class was generated from the following file:
- includes/exception/UserNotLoggedIn.php
