Constants

ENCRYPT_NONE

ENCRYPT_NONE

Encryption constants

ENCRYPT_MD5

ENCRYPT_MD5

ENCRYPT_SHA1

ENCRYPT_SHA1

ENCRYPT_CRYPT

ENCRYPT_CRYPT

ENCRYPT_BCRYPT

ENCRYPT_BCRYPT

ENCRYPT_MCRYPT

ENCRYPT_MCRYPT

ENCRYPT_CRYPT_MD5

ENCRYPT_CRYPT_MD5

ENCRYPT_CRYPT_SHA_256

ENCRYPT_CRYPT_SHA_256

ENCRYPT_CRYPT_SHA_512

ENCRYPT_CRYPT_SHA_512

NOT_VALID

NOT_VALID

Constant for credentials not being valid

VALID

VALID

Constant for credentials being valid

Properties

$result

$result : integer

Authentication result

Type

integer

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\Auth

Set the username

Parameters

string $username

Returns

\Pop\Auth\Auth

setPassword()

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

Set the password

Parameters

string $password

Returns

\Pop\Auth\Auth

authenticate()

authenticate(string  $username = null, string  $password = null) : \Pop\Auth\Auth

Method to authenticate

Parameters

string $username
string $password

Returns

\Pop\Auth\Auth