BristolSU\Support\User\User Class Reference

Inheritance diagram for BristolSU\Support\User\User:

Collaboration diagram for BristolSU\Support\User\User:

Public Member Functions
	controlId ()
	controlUser ()
	routeNotificationForMail ()
	getEmailForVerification ()
	getEmailForPasswordReset ()

Protected Attributes
	$fillable
	$hidden

Detailed Description

Represents a user in the database

Definition at line 15 of file User.php.

Member Function Documentation

controlId()

BristolSU\Support\User\User::controlId

(

)

Get the ID of the control

Returns

int

Definition at line 42 of file User.php.

Referenced by BristolSU\Support\User\User\controlUser().

controlUser()

BristolSU\Support\User\User::controlUser

(

)

Get the control user attached to this database user

Returns

Definition at line 52 of file User.php.

References BristolSU\Support\User\User\controlId().

Referenced by BristolSU\Support\User\User\getEmailForPasswordReset(), BristolSU\Support\User\User\getEmailForVerification(), and BristolSU\Support\User\User\routeNotificationForMail().

getEmailForPasswordReset()

BristolSU\Support\User\User::getEmailForPasswordReset

(

)

Get the email address that should be used for password resets.

Returns

string

Exceptions

ValidationException

Definition at line 90 of file User.php.

References BristolSU\Support\User\User\controlUser().

getEmailForVerification()

BristolSU\Support\User\User::getEmailForVerification

(

)

Get the email address that should be used for verification.

Returns

string

Exceptions

ValidationException

Definition at line 73 of file User.php.

References BristolSU\Support\User\User\controlUser().

routeNotificationForMail()

BristolSU\Support\User\User::routeNotificationForMail

(

)

Get the user email to send a notification to

Returns

string|null

Definition at line 62 of file User.php.

References BristolSU\Support\User\User\controlUser().

Member Data Documentation

$fillable

BristolSU\Support\User\User::$fillable

protected

Initial value:

= [
        'control_id'
    ]

Definition at line 24 of file User.php.

$hidden

BristolSU\Support\User\User::$hidden

protected

Initial value:

= [
        'password', 'remember_token'
    ]

Definition at line 33 of file User.php.

---

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

• src/User/User.php