Class SimpleRealm

Description

Represents a single security realm's identity.

Located in /libraries/pear/simpletest/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, mixed $password)
 void stretch (SimpleUrl $url)
 string _getCommonPath (string $first, string $second)
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)
setIdentity (line 72)

Sets the identity to try within this realm.

  • access: public
void setIdentity (string $username, mixed $password)
  • string $username: Password in authentication dialog.
stretch (line 44)

Adds another location to the realm.

  • access: public
void stretch (SimpleUrl $url)
_getCommonPath (line 55)

Finds the common starting path.

  • return: Common directories.
  • access: private
string _getCommonPath (string $first, string $second)
  • string $first: Path to compare.
  • string $second: Path to compare.

Documentation generated on Fri, 11 Feb 2005 18:12:44 +0000 by phpDocumentor 1.3.0RC3