Class SimpleRealm

Description

Represents a single security realm's identity.

Located in /authentication.php (line 18)


	
			
Method Summary
 SimpleRealm SimpleRealm (string $type, SimpleUrl $url)
 string getCommonPath (string $first, string $second)
 string getPassword ()
 string getUsername ()
 boolean isIn (string $part, string $whole)
 boolean isWithin (SimpleUrl $url)
 void setIdentity (string $username,  $password)
 void stretch (SimpleUrl $url)
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.
getCommonPath (line 55)

Finds the common starting path.

  • return: Common directories.
  • access: protected
string getCommonPath (string $first, string $second)
  • string $first: Path to compare.
  • string $second: Path to compare.
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 ()
isIn (line 121)

Tests to see if one string is a substring of another.

  • return: True if the small bit is in the big bit.
  • access: protected
boolean isIn (string $part, string $whole)
  • string $part: Small bit.
  • string $whole: Big bit.
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,  $password)
  • string $username: Password in authentication dialog.
  • $password
stretch (line 44)

Adds another location to the realm.

  • access: public
void stretch (SimpleUrl $url)

Documentation generated on Sun, 31 Oct 2010 16:30:54 -0500 by phpDocumentor 1.4.3