dataface_actions_forgot_password Class Reference

Public Member Functions
	handle ($params)
	response ($p)
	create_reset_password_table ()
	clear_expired ()
	send_reset_email_for_username ($username)
	send_reset_email_for_email ($email)
	send_reset_email_for_user (Dataface_Record $user)
	reset_password_with_uuid ($uuid)
	delete_request_with_uuid ($uuid)
Static Public Attributes
static	$TABLE_RESET_PASSWORD = 'dataface__reset_password'
static	$EX_MULTIPLE_USERS_WITH_SAME_EMAIL = 500
static	$EX_NO_USERS_WITH_EMAIL = 501
static	$EX_NO_EMAIL_COLUMN_FOUND = 502
static	$EX_NO_USERNAME_COLUMN_FOUND = 504
static	$EX_NO_USERNAME_FOR_USER = 503
static	$EX_NO_SUCH_UUID = 505
static	$EX_USER_NOT_FOUND = 506
static	$EX_NO_EMAIL_FOR_USER = 507
static	$EX_NO_USERS_FOUND_WITH_USERNAME = 508
static	$EX_MULTIPLE_USERS_WITH_SAME_USERNAME = 509

---

Detailed Description

Definition at line 2 of file forgot_password.php.

---

Member Function Documentation

clear_expired

(

)

Deletes expired reset password requests from the table.

Definition at line 116 of file forgot_password.php.

create_reset_password_table

(

)

Creates th reset password table that keeps track of reset password requests.

Definition at line 98 of file forgot_password.php.

delete_request_with_uuid

(

$

uuid

)

Definition at line 407 of file forgot_password.php.

handle

(

$

params

)

Definition at line 15 of file forgot_password.php.

reset_password_with_uuid

(

$

uuid

)

Definition at line 288 of file forgot_password.php.

response

(

$

p

)

Definition at line 89 of file forgot_password.php.

send_reset_email_for_email

(

$

email

)

Sends reset email to a particular email address. This first checks to see if the email address belongs to a valid user account.

Parameters:

string

$email

The email address to send to.

Returns:

void

Exceptions:

Exception	Code: self::$EX_MULTIPLE_USERS_WITH_SAME_EMAIL
Exception	Code: self::$EX_NO_USERS_WITH_EMAIL
Exception	Code: self::$EX_NO_EMAIL_COLUMN_FOUND

Definition at line 158 of file forgot_password.php.

send_reset_email_for_user

(

Dataface_Record $

user

)

Sends the reset email to a particular user.

Parameters:

Dataface_Record

$user

The user record.

Returns:

true on success

Exceptions:

Exception	code: self::$EX_NO_USERNAME_FOR_USER If username is blank
Exception	code: self::$EX_NO_EMAIL_COLUMN_FOUND No email column was found in the users table.
Exception	code: self::$EX_NO_USERS_FOUND_WITH_EMAIL If the user record doesn't have an email address.

Definition at line 186 of file forgot_password.php.

send_reset_email_for_username

(

$

username

)

Definition at line 126 of file forgot_password.php.

---

Field Documentation

$EX_MULTIPLE_USERS_WITH_SAME_EMAIL = 500 [static]

Definition at line 4 of file forgot_password.php.

$EX_MULTIPLE_USERS_WITH_SAME_USERNAME = 509 [static]

Definition at line 13 of file forgot_password.php.

$EX_NO_EMAIL_COLUMN_FOUND = 502 [static]

Definition at line 6 of file forgot_password.php.

$EX_NO_EMAIL_FOR_USER = 507 [static]

Definition at line 11 of file forgot_password.php.

$EX_NO_SUCH_UUID = 505 [static]

Definition at line 9 of file forgot_password.php.

$EX_NO_USERNAME_COLUMN_FOUND = 504 [static]

Definition at line 7 of file forgot_password.php.

$EX_NO_USERNAME_FOR_USER = 503 [static]

Definition at line 8 of file forgot_password.php.

$EX_NO_USERS_FOUND_WITH_USERNAME = 508 [static]

Definition at line 12 of file forgot_password.php.

$EX_NO_USERS_WITH_EMAIL = 501 [static]

Definition at line 5 of file forgot_password.php.

$EX_USER_NOT_FOUND = 506 [static]

Definition at line 10 of file forgot_password.php.

$TABLE_RESET_PASSWORD = 'dataface__reset_password' [static]

Definition at line 3 of file forgot_password.php.

---

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

• actions/forgot_password.php