Docs For Class SimpleBrowserHistory

SimpleBrowserHistory

Description

Browser history list.

Located in /browser.php (line 35)

Method Summary

SimpleBrowserHistory __construct ()

boolean atBeginning ()

boolean atEnd ()

boolean back ()

void dropFuture ()

boolean forward ()

SimpleFormEncoding getParameters ()

SimpleUrl getUrl ()

boolean isEmpty ()

void recordEntry (SimpleUrl $url, SimpleEncoding $parameters)

Methods

Constructor __construct (line 43)

Starts empty.

access: public

SimpleBrowserHistory __construct ()

atBeginning (line 62)

Test for being at the beginning.

return: True if first.
access: protected

boolean atBeginning ()

atEnd (line 71)

Test for being at the last entry.

return: True if last.
access: protected

boolean atEnd ()

back (line 121)

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

return: True if any previous entries.
access: public

boolean back ()

dropFuture (line 148)

Ditches all future entries beyond the current point.

access: protected

void dropFuture ()

forward (line 135)

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

return: True if any future entries.
access: public

boolean forward ()

getParameters (line 108)

Parameters of last fetch from current history position.

return: Post parameters.
access: public

SimpleFormEncoding getParameters ()

getUrl (line 95)

Last fully qualified URL for current history position.

return: URL for this position.
access: public

SimpleUrl getUrl ()

isEmpty (line 53)

Test for no entries yet.

return: True if empty.
access: protected

boolean isEmpty ()

recordEntry (line 81)

Adds a successfully fetched page to the history.

access: public

void recordEntry (SimpleUrl $url, SimpleEncoding $parameters)

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

Documentation generated on Thu, 01 Oct 2009 20:54:25 -0500 by phpDocumentor 1.4.2