PHP Class SimpleBrowserHistory, simpletest

@package SimpleTest
Datei anzeigen Open project: simpletest/simpletest Class Usage Examples

Public Methods

Method Description
back ( ) : boolean Step back one place in the history. Stops at the first page.
forward ( ) : boolean Step forward one place. If already at the latest entry then nothing will happen.
getParameters ( ) : SimpleFormEncoding Parameters of last fetch from current history position.
getUrl ( ) : SimpleUrl Last fully qualified URL for current history position.
recordEntry ( SimpleUrl $url, SimpleEncoding $parameters ) Adds a successfully fetched page to the history.

Protected Methods

Method Description
atBeginning ( ) : boolean Test for being at the beginning.
atEnd ( ) : boolean Test for being at the last entry.
dropFuture ( ) Ditches all future entries beyond the current point.
isEmpty ( ) : boolean Test for no entries yet.

Method Details

atBeginning() protected method

Test for being at the beginning.
protected atBeginning ( ) : boolean
return boolean True if first.

atEnd() protected method

Test for being at the last entry.
protected atEnd ( ) : boolean
return boolean True if last.

back() public method

Step back one place in the history. Stops at the first page.
public back ( ) : boolean
return boolean True if any previous entries.

dropFuture() protected method

Ditches all future entries beyond the current point.
protected dropFuture ( )

forward() public method

Step forward one place. If already at the latest entry then nothing will happen.
public forward ( ) : boolean
return boolean True if any future entries.

getParameters() public method

Parameters of last fetch from current history position.
public getParameters ( ) : SimpleFormEncoding
return SimpleFormEncoding Post parameters.

getUrl() public method

Last fully qualified URL for current history position.
public getUrl ( ) : SimpleUrl
return SimpleUrl URL for this position.

isEmpty() protected method

Test for no entries yet.
protected isEmpty ( ) : boolean
return boolean True if empty.

recordEntry() public method

Adds a successfully fetched page to the history.
public recordEntry ( SimpleUrl $url, SimpleEncoding $parameters )
$url SimpleUrl URL of fetch.
$parameters SimpleEncoding Any post data with the fetch.