\Pop\AuthAuthInterface

Auth interface

Summary

Methods
Constants
getResult()
isValid()
getUsername()
getPassword()
setUsername()
setPassword()
authenticate()
verify()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

getResult()

getResult() : integer

Get the authentication result

Returns

integer

isValid()

isValid() : boolean

Determine if the authentication attempt was valid

Returns

boolean

getUsername()

getUsername() : string

Get the username

Returns

string

getPassword()

getPassword() : string

Get the password

Returns

string

setUsername()

setUsername(string  $username) : \Pop\Auth\AuthInterface

Set the username

Parameters

string $username

Returns

\Pop\Auth\AuthInterface

setPassword()

setPassword(string  $password) : \Pop\Auth\AuthInterface

Set the password

Parameters

string $password

Returns

\Pop\Auth\AuthInterface

authenticate()

authenticate(string  $username, string  $password) : integer

Method to authenticate

Parameters

string $username
string $password

Returns

integer

verify()

verify(string  $password, string  $hash) : boolean

Method to verify a password against a hash

Parameters

string $password
string $hash

Returns

boolean