| [ Index ] |
PHP Cross Reference of MediaWiki-1.24.0 |
[Source view] [Print] [Project Stats]
Implements Special:UserLogin This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
| File Size: | 1651 lines (52 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
LoginForm:: (36 methods):
__construct()
load()
getDescription()
execute()
addNewAccountMailPassword()
addNewAccount()
addNewAccountInternal()
initUser()
authenticateUserData()
incLoginThrottle()
clearLoginThrottle()
attemptAutoCreate()
processLogin()
resetLoginForm()
mailPasswordInternal()
successfulLogin()
successfulCreation()
displaySuccessfulAction()
userBlockedMessage()
showReturnToPage()
executeReturnTo()
mainLoginForm()
showCreateOrLoginLink()
hasSessionCookie()
getLoginToken()
setLoginToken()
clearLoginToken()
getCreateaccountToken()
setCreateaccountToken()
clearCreateaccountToken()
renewSessionId()
cookieRedirectCheck()
onCookieRedirectCheck()
makeLanguageSelector()
makeLanguageSelectorLink()
getGroupName()
| __construct( $request = null ) X-Ref |
param: WebRequest $request |
| load() X-Ref |
| Loader |
| getDescription() X-Ref |
| No description |
| execute( $subPage ) X-Ref |
param: string|null $subPage |
| addNewAccountMailPassword() X-Ref |
| addNewAccount() X-Ref |
return: bool |
| addNewAccountInternal() X-Ref |
| Make a new user account using the loaded data. return: Status |
| initUser( $u, $autocreate ) X-Ref |
| Actually add a user to the database. Give it a User object that has been initialised with a name. param: User $u param: bool $autocreate True if this is an autocreation via auth plugin return: Status Status object, with the User object in the value member on success |
| authenticateUserData() X-Ref |
| Internally authenticate the login request. This may create a local account as a side effect if the authentication plugin allows transparent local account creation. return: int |
| incLoginThrottle( $username ) X-Ref |
| Increment the login attempt throttle hit count for the (username,current IP) tuple unless the throttle was already reached. param: string $username The user name return: bool|int The integer hit count or True if it is already at the limit |
| clearLoginThrottle( $username ) X-Ref |
| Clear the login attempt throttle hit count for the (username,current IP) tuple. param: string $username The user name return: void |
| attemptAutoCreate( $user ) X-Ref |
| Attempt to automatically create a user on login. Only succeeds if there is an external authentication method which allows it. param: User $user return: int Status code |
| processLogin() X-Ref |
| No description |
| resetLoginForm( Message $msg ) X-Ref |
| Show the Special:ChangePassword form, with custom message param: Message $msg |
| mailPasswordInternal( $u, $throttle = true, $emailTitle = 'passwordremindertitle',$emailText = 'passwordremindertext') X-Ref |
param: User $u param: bool $throttle param: string $emailTitle Message name of email title param: string $emailText Message name of email text return: Status |
| successfulLogin() X-Ref |
| Run any hooks registered for logins, then HTTP redirect to $this->mReturnTo (or Main Page if that's undefined). Formerly we had a nice message here, but that's really not as useful as just being sent to wherever you logged in from. It should be clear that the action was successful, given the lack of error messages plus the appearance of your name in the upper right. |
| successfulCreation() X-Ref |
| Run any hooks registered for logins, then display a message welcoming the user. |
| displaySuccessfulAction( $type, $title, $msgname, $injected_html ) X-Ref |
| Display a "successful action" page. param: string $type Condition of return to; see `executeReturnTo` param: string|Message $title Page's title param: string $msgname param: string $injected_html |
| userBlockedMessage( Block $block ) X-Ref |
| Output a message that informs the user that they cannot create an account because there is a block on them or their IP which prevents account creation. Note that User::isBlockedFromCreateAccount(), which gets this block, ignores the 'hardblock' setting on blocks (bug 13611). param: Block $block The block causing this error |
| showReturnToPage($type, $returnTo = '', $returnToQuery = '', $stickHTTPs = false) X-Ref |
| Add a "return to" link or redirect to it. Extensions can use this to reuse the "return to" logic after inject steps (such as redirection) into the login process. param: string $type One of the following: param: string $returnTo param: array|string $returnToQuery param: bool $stickHTTPs Keep redirect link on HTTPs |
| executeReturnTo( $type ) X-Ref |
| Add a "return to" link or redirect to it. param: string $type One of the following: |
| mainLoginForm( $msg, $msgtype = 'error' ) X-Ref |
param: string $msg param: string $msgtype |
| showCreateOrLoginLink( &$user ) X-Ref |
| Whether the login/create account form should display a link to the other form (in addition to whatever the skin provides). param: User $user return: bool |
| hasSessionCookie() X-Ref |
| Check if a session cookie is present. This will not pick up a cookie set during _this_ request, but is meant to ensure that the client is returning the cookie which was set on a previous pass through the system. return: bool |
| getLoginToken() X-Ref |
| Get the login token from the current session return: mixed |
| setLoginToken() X-Ref |
| Randomly generate a new login token and attach it to the current session |
| clearLoginToken() X-Ref |
| Remove any login token attached to the current session |
| getCreateaccountToken() X-Ref |
| Get the createaccount token from the current session return: mixed |
| setCreateaccountToken() X-Ref |
| Randomly generate a new createaccount token and attach it to the current session |
| clearCreateaccountToken() X-Ref |
| Remove any createaccount token attached to the current session |
| renewSessionId() X-Ref |
| Renew the user's session id, using strong entropy |
| cookieRedirectCheck( $type ) X-Ref |
param: string $type |
| onCookieRedirectCheck( $type ) X-Ref |
param: string $type |
| makeLanguageSelector() X-Ref |
| Produce a bar of links which allow the user to select another language during login/registration but retain "returnto" return: string |
| makeLanguageSelectorLink( $text, $lang ) X-Ref |
| Create a language selector link for a particular language Links back to this page preserving type and returnto param: string $text Link text param: string $lang Language code return: string |
| getGroupName() X-Ref |
| No description |
| Generated: Fri Nov 28 14:03:12 2014 | Cross-referenced by PHPXref 0.7.1 |