Class SimpleBrowserHistory

Description

Browser history list.

Located in /libraries/pear/simpletest/browser.php (line 24)


	
			
Variable Summary
 mixed $_position
 mixed $_sequence
Method Summary
 SimpleBrowserHistory SimpleBrowserHistory ()
 boolean back ()
 boolean forward ()
 string getMethod ()
 array getParameters ()
 void recordEntry (string $method, SimpleUrl $url, array $parameters)
 boolean _atBeginning ()
 boolean _atEnd ()
 void _dropFuture ()
 boolean _isEmpty ()
Variables
mixed $_position (line 26)
mixed $_sequence (line 25)
Methods
Constructor SimpleBrowserHistory (line 32)

Starts empty.

  • access: public
SimpleBrowserHistory SimpleBrowserHistory ()
back (line 125)

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

  • return: True if any previous entries.
  • access: public
boolean back ()
forward (line 139)

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

  • return: True if any future entries.
  • access: public
boolean forward ()
getMethod (line 86)

Last fetching method for current history position.

  • return: GET or POST for this point in the history.
  • access: public
string getMethod ()
getParameters (line 112)

Parameters of last fetch from current history position.

  • return: Hash of post parameters.
  • access: public
array getParameters ()
getUrl (line 99)

Last fully qualified URL for current history position.

  • return: URL for this position.
  • access: public
SimpleUrl getUrl ()
recordEntry (line 71)

Adds a successfully fetched page to the history.

  • access: public
void recordEntry (string $method, SimpleUrl $url, array $parameters)
  • string $method: GET or POST.
  • SimpleUrl $url: URL of fetch.
  • array $parameters: Any post data with the fetch.
_atBeginning (line 51)

Test for being at the beginning.

  • return: True if first.
  • access: private
boolean _atBeginning ()
_atEnd (line 60)

Test for being at the last entry.

  • return: True if last.
  • access: private
boolean _atEnd ()
_dropFuture (line 152)

Ditches all future entries beyond the current point.

  • access: private
void _dropFuture ()
_isEmpty (line 42)

Test for no entries yet.

  • return: True if empty.
  • access: private
boolean _isEmpty ()

Documentation generated on Fri, 3 Dec 2004 12:26:15 +0000 by phpDocumentor 1.3.0RC3