SimpleRealm Class Reference

Public Member Functions
	SimpleRealm ($type, $url)
	stretch ($url)
	_getCommonPath ($first, $second)
	setIdentity ($username, $password)
	getUsername ()
	getPassword ()
	isWithin ($url)
	_isIn ($part, $whole)
Data Fields
	$_type
	$_root
	$_username
	$_password

---

Detailed Description

Definition at line 18 of file authentication.php.

---

Member Function Documentation

_getCommonPath	(	$	first,
		$	second
	)

Finds the common starting path.

Parameters:

string	$first	Path to compare.
string	$second	Path to compare.

Returns:

string Common directories. private

Definition at line 55 of file authentication.php.

Here is the caller graph for this function:

_isIn	(	$	part,
		$	whole
	)

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

Parameters:

string	$part	Small bit.
string	$whole	Big bit.

Returns:

boolean True if the small bit is in the big bit. private

Definition at line 121 of file authentication.php.

Here is the caller graph for this function:

getPassword

(

)

Accessor for current identity.

Returns:

string Last succesful password. public

Definition at line 91 of file authentication.php.

getUsername

(

)

Accessor for current identity.

Returns:

string Last succesful username. public

Definition at line 82 of file authentication.php.

isWithin

(

$

url

)

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

Parameters:

SimpleUrl

$url

URL to test.

Returns:

boolean True if subpath. public

Definition at line 102 of file authentication.php.

Here is the call graph for this function:

setIdentity	(	$	username,
		$	password
	)

Sets the identity to try within this realm.

Parameters:

string	$username	Username in authentication dialog.
string	$username	Password in authentication dialog. public

Definition at line 72 of file authentication.php.

SimpleRealm	(	$	type,
		$	url
	)

Starts with the initial entry directory.

Parameters:

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

Definition at line 32 of file authentication.php.

stretch

(

$

url

)

Adds another location to the realm.

Parameters:

SimpleUrl

$url

Somewhere in realm. public

Definition at line 44 of file authentication.php.

Here is the call graph for this function:

---

Field Documentation

$_password

Definition at line 22 of file authentication.php.

$_root

Definition at line 20 of file authentication.php.

$_type

Definition at line 19 of file authentication.php.

$_username

Definition at line 21 of file authentication.php.

---

The documentation for this class was generated from the following file:

• C:/xampp/htdocs/moodle/lib/simpletestlib/authentication.php