\Pop\Auth\AdapterEncryptedAdapter

Auth abstract adapter class

Summary

Methods
Properties
Constants
getUsername()
getPassword()
setUsername()
setPassword()
authenticate()
setEncryption()
setEncryptionOptions()
getEncryption()
getEncryptionOptions()
verifyPassword()
No public properties found
No constants found
No protected methods found
$username
$password
$encryption
$encryptionOptions
N/A
No private methods found
No private properties found
N/A

Properties

$username

$username : string

Username to authenticate against

Type

string

$password

$password : string

Password to authenticate against

Type

string

$encryption

$encryption : integer

Encryption method to use

Type

integer

$encryptionOptions

$encryptionOptions : array

Encryption options. Possible options are:

'salt' // Custom Salt 'secret' // Secret pepper

'cost' // Bcrypt cost 'prefix' // Bcrypt prefix

'rounds' // Sha rounds

'cipher' // Mcrypt cipher 'mode' // Mcrypt cipher 'source' // Mcrypt source

Type

array

Methods

getUsername()

getUsername() : string

Get the username

Returns

string

getPassword()

getPassword() : string

Get the password

Returns

string

setUsername()

setUsername(string  $username) : \Pop\Auth\Adapter\AbstractAdapter

Set the username

Parameters

string $username

Returns

\Pop\Auth\Adapter\AbstractAdapter

setPassword()

setPassword(string  $password) : \Pop\Auth\Adapter\AbstractAdapter

Set the password

Parameters

string $password

Returns

\Pop\Auth\Adapter\AbstractAdapter

authenticate()

authenticate() : integer

Method to authenticate

Returns

integer

setEncryption()

setEncryption(integer  $encryption, array  $options = array()) : \Pop\Auth\Adapter\AbstractAdapter

Method to set the encryption

Parameters

integer $encryption
array $options

Returns

\Pop\Auth\Adapter\AbstractAdapter

setEncryptionOptions()

setEncryptionOptions(array  $options = array()) : \Pop\Auth\Adapter\AbstractAdapter

Method to set the encryption options

Parameters

array $options

Returns

\Pop\Auth\Adapter\AbstractAdapter

getEncryption()

getEncryption() : integer

Get encryption

Returns

integer

getEncryptionOptions()

getEncryptionOptions() : array

Get encryption options

Returns

array

verifyPassword()

verifyPassword(string  $hash, string  $attemptedPassword) : boolean

Method to verify password

Parameters

string $hash
string $attemptedPassword

Returns

boolean