ProdigyView Documentation
Back to top  

PVRequestAuth

package

data

Methods

The constructor called when initializing the object

__construct(array $options = array())

Arguments

$options

array

Options used to help

Parses the digest retrieved from the server variable.

_parseDigest(string $digest) : mixed
access

protected

Arguments

$digest

string

The digest data retrieved from the server application

Response

mixed

$value Returns the digest in array if all the parts are available, otherwirse false

Authenticate takes place by validating credentials passed in against the username and password retrieved during the processAuth method.

authenticate(array $credentials = array()) : boolean
access

public

Arguments

$credentials

array

An array that should contain the username and password to check against

Response

boolean

$authenticated Returns true if the variables match, otherwise false

Returns the username and password set in the processAuth Method.

getCredentials() : array
access

public

Response

array

$credtentials

Returns the realm that is currently set.

getRealm() : string
access

public

Response

string

$realm

This methods sets up the digest, username, and password for the class. The digest, username, and password are server variables and are associated with http_auth_digest, server_auth_user, server_auther password set in the construct. This method is called automatically by the constructor.

processAuth() : void
access

public

Set the credentials to be stored in the class as protected variables.

setCredentials( $credentials = array()) : void
access

public

Arguments

$credentials

Set the realm

setRealm(string $realm) : void
access

public

Arguments

$realm

string

The realm to be used

Properties

_username

_username :

Type(s)

_password

_password :

Type(s)

_realm

_realm :

Type(s)

_digest

_digest :

Type(s)

_server_auth_digest

_server_auth_digest :

Type(s)

_server_auth_user

_server_auth_user :

Type(s)

_server_auth_password

_server_auth_password :

Type(s)