SimpleBrowserHistory Class Reference

Public Member Functions
	SimpleBrowserHistory ()
	_isEmpty ()
	_atBeginning ()
	_atEnd ()
	recordEntry ($url, $parameters)
	getUrl ()
	getParameters ()
	back ()
	forward ()
	_dropFuture ()
Data Fields
	$_sequence
	$_position

---

Detailed Description

Definition at line 30 of file browser.php.

---

Member Function Documentation

_atBeginning

(

)

Test for being at the beginning.

Returns:

boolean True if first. private

Definition at line 57 of file browser.php.

Here is the call graph for this function:

Here is the caller graph for this function:

_atEnd

(

)

Test for being at the last entry.

Returns:

boolean True if last. private

Definition at line 66 of file browser.php.

Here is the call graph for this function:

Here is the caller graph for this function:

_dropFuture

(

)

Ditches all future entries beyond the current point. private

Definition at line 143 of file browser.php.

Here is the call graph for this function:

Here is the caller graph for this function:

_isEmpty

(

)

Test for no entries yet.

Returns:

boolean True if empty. private

Definition at line 48 of file browser.php.

Here is the caller graph for this function:

back

(

)

Step back one place in the history. Stops at the first page.

Returns:

boolean True if any previous entries. public

Definition at line 116 of file browser.php.

Here is the call graph for this function:

forward

(

)

Step forward one place. If already at the latest entry then nothing will happen.

Returns:

boolean True if any future entries. public

Definition at line 130 of file browser.php.

Here is the call graph for this function:

getParameters

(

)

Parameters of last fetch from current history position.

Returns:

SimpleFormEncoding Post parameters. public

Definition at line 103 of file browser.php.

Here is the call graph for this function:

getUrl

(

)

Last fully qualified URL for current history position.

Returns:

SimpleUrl URL for this position. public

Definition at line 90 of file browser.php.

Here is the call graph for this function:

recordEntry	(	$	url,
		$	parameters
	)

Adds a successfully fetched page to the history.

Parameters:

SimpleUrl	$url	URL of fetch.
SimpleEncoding	$parameters	Any post data with the fetch. public

Definition at line 76 of file browser.php.

Here is the call graph for this function:

SimpleBrowserHistory

(

)

Starts empty. public

Definition at line 38 of file browser.php.

---

Field Documentation

$_position

Definition at line 32 of file browser.php.

$_sequence

Definition at line 31 of file browser.php.

---

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

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