Docs For Class SimpleBrowserHistory

SimpleBrowserHistory

Description

Browser history list.

Located in /browser.php (line 36)

Method Summary

boolean atBeginning ()

boolean atEnd ()

boolean back ()

void dropFuture ()

boolean forward ()

SimpleFormEncoding getParameters ()

SimpleUrl getUrl ()

boolean isEmpty ()

void recordEntry (SimpleUrl $url, SimpleEncoding $parameters)

Methods

atBeginning (line 54)

Test for being at the beginning.

return: True if first.
access: protected

boolean atBeginning ()

atEnd (line 63)

Test for being at the last entry.

return: True if last.
access: protected

boolean atEnd ()

back (line 113)

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

return: True if any previous entries.
access: public

boolean back ()

dropFuture (line 140)

Ditches all future entries beyond the current point.

access: protected

void dropFuture ()

forward (line 127)

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 100)

Parameters of last fetch from current history position.

return: Post parameters.
access: public

SimpleFormEncoding getParameters ()

getUrl (line 87)

Last fully qualified URL for current history position.

return: URL for this position.
access: public

SimpleUrl getUrl ()

isEmpty (line 45)

Test for no entries yet.

return: True if empty.
access: protected

boolean isEmpty ()

recordEntry (line 73)

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 Sun, 31 Oct 2010 16:31:01 -0500 by phpDocumentor 1.4.3