Docs For Class SimpleAuthenticator

Description

Manages security realms.

Located in /_tests/simpletest/authentication.php (line 132)

Variable Summary

mixed $_realms

Method Summary

static void addBasicHeaders ( &$request, string $username, string $password, SimpleHttpRequest $request)

SimpleAuthenticator SimpleAuthenticator ()

void addHeaders ( &$request, SimpleUrl $url, SimpleHttpRequest $request)

void addRealm (SimpleUrl $url, string $type, string $realm)

void restartSession ()

void setIdentityForRealm (string $host, string $realm, string $username, string $password)

Variables

mixed $_realms (line 133)

Methods

static method addBasicHeaders (line 232)

Presents the appropriate headers for this location for basic authentication.

access: public

static void addBasicHeaders ( &$request, string $username, string $password, SimpleHttpRequest $request)

SimpleHttpRequest $request: Request to modify.
string $username: Username for realm.
string $password: Password for realm.
&$request

Constructor SimpleAuthenticator (line 139)

Clears the realms.

access: public

SimpleAuthenticator SimpleAuthenticator ()

addHeaders (line 210)

Presents the appropriate headers for this location.

access: public

void addHeaders ( &$request, SimpleUrl $url, SimpleHttpRequest $request)

SimpleHttpRequest $request: Request to modify.
SimpleUrl $url: Base of realm.
&$request

addRealm (line 167)

Adds a new realm centered the current URL.

Browsers vary wildly on their behaviour in this regard. Mozilla ignores the realm and presents only when challenged, wasting bandwidth. IE just carries on presenting until a new challenge occours. SimpleTest tries to follow the spirit of the original standards committee and treats the base URL as the root of a file tree shaped realm.

access: public

void addRealm (SimpleUrl $url, string $type, string $realm)

SimpleUrl $url: Base of realm.
string $type: Authentication type for this realm. Only Basic authentication is currently supported.
string $realm: Name of realm.

restartSession (line 147)

Starts with no realms set up.

access: public

void restartSession ()

setIdentityForRealm (line 180)

Sets the current identity to be presented against that realm.

access: public

void setIdentityForRealm (string $host, string $realm, string $username, string $password)

string $host: Server hosting realm.
string $realm: Name of realm.
string $username: Username for realm.
string $password: Password for realm.