LoginHandler Class Reference
[Pages_login]
Handle login/logout requests.
More...
Public Member Functions | |
| changePassword ($args=array()) | |
| implicitAuthLogin () | |
| implicitAuthReturn () | |
| index () | |
| lostPassword () | |
| requestResetPassword () | |
| resetPassword ($args) | |
| savePassword () | |
| signIn () | |
| signOut () | |
Detailed Description
Handle login/logout requests.Definition at line 18 of file LoginHandler.inc.php.
Member Function Documentation
| LoginHandler.changePassword | ( | $ | args = array() |
) |
Display form to change user's password.
- Parameters:
-
$args array first argument may contain user's username
Definition at line 261 of file LoginHandler.inc.php.
| LoginHandler.implicitAuthLogin | ( | ) |
Handle login when implicitAuth is enabled. If the user came in on a non-ssl url - then redirect back to the ssl url
Definition at line 57 of file LoginHandler.inc.php.
References Request.getBasePath(), Request.getProtocol(), Request.getServerHost(), Config.getVar(), Request.redirectSSL(), and Request.redirectUrl().
| LoginHandler.implicitAuthReturn | ( | ) |
This is the function that Shibboleth redirects to - after the user has authenticated.
Definition at line 74 of file LoginHandler.inc.php.
References Request.getUserVar(), Validation.isLoggedIn(), Validation.login(), and Request.redirect().
| LoginHandler.index | ( | ) |
Display user login form. Redirect to user index page if user is already validated.
Reimplemented from Handler.
Definition at line 24 of file LoginHandler.inc.php.
References TemplateManager.getManager(), SessionManager.getManager(), Request.getProtocol(), Request.getUserVar(), Config.getVar(), Validation.isLoggedIn(), Request.redirect(), and Request.redirectSSL().
| LoginHandler.lostPassword | ( | ) |
Display form to reset a user's password.
Definition at line 151 of file LoginHandler.inc.php.
References TemplateManager.getManager().
| LoginHandler.requestResetPassword | ( | ) |
Send a request to reset a user's password
Definition at line 160 of file LoginHandler.inc.php.
References Validation.generatePasswordResetHash(), DAORegistry.getDAO(), TemplateManager.getManager(), Request.getRequestedPage(), Request.getSite(), Request.getUserVar(), and Request.url().
| LoginHandler.resetPassword | ( | $ | args | ) |
Reset a user's password
- Parameters:
-
$args array first param contains the username of the user whose password is to be reset
Definition at line 197 of file LoginHandler.inc.php.
References Validation.encryptCredentials(), Validation.generatePassword(), Validation.generatePasswordResetHash(), DAORegistry.getDAO(), TemplateManager.getManager(), Request.getRequestedPage(), Request.getSite(), Request.getUserVar(), Request.redirect(), and Request.url().
| LoginHandler.savePassword | ( | ) |
Save user's new password.
Definition at line 277 of file LoginHandler.inc.php.
References Validation.login(), Request.redirect(), and Handler.validate().
| LoginHandler.signIn | ( | ) |
Validate a user's credentials and log the user in.
Definition at line 90 of file LoginHandler.inc.php.
References TemplateManager.getManager(), SessionManager.getManager(), Request.getProtocol(), Request.getServerHost(), Request.getUserVar(), Config.getVar(), Validation.isLoggedIn(), Validation.login(), Validation.logout(), Request.redirect(), Request.redirectNonSSL(), Request.redirectSSL(), and Request.redirectUrl().
| LoginHandler.signOut | ( | ) |
Log a user out.
Definition at line 139 of file LoginHandler.inc.php.
References Request.getRequestedPage(), Validation.isLoggedIn(), Validation.logout(), and Request.redirect().
The documentation for this class was generated from the following file:
- pages/login/LoginHandler.inc.php
