Docs For Class SimpleRealm

SimpleRealm

Description

Represents a single security realm's identity.

Located in /authentication.php (line 18)

Variable Summary

mixed $_password

mixed $_root

mixed $_type

mixed $_username

Method Summary

SimpleRealm SimpleRealm (string $type, SimpleUrl $url)

string getPassword ()

string getUsername ()

boolean isWithin (SimpleUrl $url)

void setIdentity (string $username, $password)

void stretch (SimpleUrl $url)

Variables

mixed $_password (line 22)

mixed $_root (line 20)

mixed $_type (line 19)

mixed $_username (line 21)

Methods

Constructor SimpleRealm (line 32)

Starts with the initial entry directory.

access: public

SimpleRealm SimpleRealm (string $type, SimpleUrl $url)

string $type: Authentication type for this realm. Only Basic authentication is currently supported.
SimpleUrl $url: Somewhere in realm.

getPassword (line 91)

Accessor for current identity.

return: Last succesful password.
access: public

string getPassword ()

getUsername (line 82)

Accessor for current identity.

return: Last succesful username.
access: public

string getUsername ()

isWithin (line 102)

Test to see if the URL is within the directory tree of the realm.

return: True if subpath.
access: public

boolean isWithin (SimpleUrl $url)

SimpleUrl $url: URL to test.

setIdentity (line 72)

Sets the identity to try within this realm.

access: public

void setIdentity (string $username, $password)

string $username: Password in authentication dialog.
$password

stretch (line 44)

Adds another location to the realm.

access: public

void stretch (SimpleUrl $url)

SimpleUrl $url: Somewhere in realm.

Documentation generated on Sun, 04 May 2008 09:21:16 -0500 by phpDocumentor 1.3.0