\Dewdrop\AuthUserInterface

User interface for auth components

Summary

Methods
Constants
getId()
getShortName()
getFullName()
getEmailAddress()
getUsername()
hashPassword()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

getId()

getId() : integer

Get ID

Returns

integer

getShortName()

getShortName() : string

Get short name (e.g., Jane D)

Returns

string

getFullName()

getFullName() : string

Get full name (e.g., John Doe)

Returns

string

getEmailAddress()

getEmailAddress() : string

Get email address

Returns

string

getUsername()

getUsername() : string

Returns the username used to authenticate the user.

Returns

string —

The username

hashPassword()

hashPassword(string  $plaintextPassword) : \Dewdrop\Auth\UserInterface

Hashes the given plain text password and stores the result

Parameters

string $plaintextPassword

Returns

\Dewdrop\Auth\UserInterface