- Users\UserPassword
class Users \ UserPassword
Allows users to be logged in with emails and passwords.
Method Summary
| Name | Description |
|---|---|
| addPassword(Connection $db, User $user, $password) | Add a password to the given account. |
| changePassword(Connection $db, User $user, $password) | Change the given users' password. Removes all existing passwords and then adds a new password. |
| completePasswordReset(Connection $db, $email, $secret, $new_password) | |
| deletePasswords(Connection $db, User $user) | Delete all paswords for the given user. |
| forgottenPassword(Connection $db, $email) | Create a forgotten password secret which is stored in the database. This will return a secret which must then be passed along with the mail to completePasswordReset() in order to reset the password. It is up to the application to send the appropriate email/etc. |
| getPasswordUser(Connection $db, $email) | |
| hash($password) | |
| tryLogin(Connection $db, $email, $password) | Try logging in as a user with the given email and password. |
| trySignup(Connection $db, $email, $password) |
static function addPassword(Connection $db, User $user, $password)
Add a password to the given account.
- Throws:
static function changePassword(Connection $db, User $user, $password)
Change the given users' password. Removes all existing passwords and then adds a new password.
- Throws:
static function completePasswordReset(Connection $db, $email, $secret, $new_password)
- Throws:
static function deletePasswords(Connection $db, User $user)
Delete all paswords for the given user.
static function forgottenPassword(Connection $db, $email)
Create a forgotten password secret which is stored in the database. This will return a secret which must then be passed along with the mail to completePasswordReset() in order to reset the password. It is up to the application to send the appropriate email/etc.
- Throws:
static function getPasswordUser(Connection $db, $email)
- Throws:
static function hash($password)
static function tryLogin(Connection $db, $email, $password)
Try logging in as a user with the given email and password.
- Returns:
- Throws:
static function trySignup(Connection $db, $email, $password)
- Returns:
- Throws: