PHP Class SimplePhpPageBuilder, simpletest

Datei anzeigen Open project: simpletest/simpletest Class Usage Examples

Public Methods

Method Description
addContent ( string $text ) : boolean Unparsed, but relevant data. The data is added to every open tag.
can ( ) : boolean This builder is always available.
endElement ( string $name ) : boolean End of element event.
free ( ) Frees up any references so as to allow the PHP garbage collection from unset() to work.
parse ( $response ) : SimplePage Reads the raw content and send events into the page to be built.
startElement ( string $name, hash $attributes ) : boolean Start of element event. Opens a new tag.

Protected Methods

Method Description
acceptFormEnd ( ) Closes the most recently opened form.
acceptFormStart ( SimpleFormTag $tag ) Opens a form. New widgets go here.
acceptFrame ( SimpleFrameTag $tag ) Takes a single frame tag and stashes it in the current frame set.
acceptFramesetEnd ( ) Closes the most recently opened frameset.
acceptFramesetStart ( SimpleFramesetTag $tag ) Opens a frameset. A frameset may contain nested frameset tags.
acceptLabelEnd ( ) Closes the most recently opened label.
acceptLabelStart ( SimpleFormTag $tag ) Opens a label for a described widget.
acceptPageEnd ( ) Marker for end of complete page. Any work in progress can now be closed.
acceptTag ( SimpleTag $tag ) Adds a tag to the page.
addContentTagToOpenTags ( SimpleTag &$tag ) Parsed data in tag form.
addContentToAllOpenTags ( string $text ) Any content fills all currently open tags unless it is part of an option tag.
createPage ( $response ) : SimplePage Creates an empty page.
createParser ( SimplePhpPageBuilder &$listener ) : SimpleSaxParser Creates the parser used with the builder.
hasNamedTagOnOpenTagStack ( string $name ) : boolean Test to see if there are any open tags awaiting closure that match the tag name.
isFormElement ( string $name ) : boolean Tests to see if a tag is a possible form element.
isLoadingFrames ( ) : boolean Test to see if in the middle of reading a frameset.
openTag ( SimpleTag $tag ) Opens a tag for receiving content.

Method Details

acceptFormEnd() protected method

Closes the most recently opened form.
protected acceptFormEnd ( )

acceptFormStart() protected method

Opens a form. New widgets go here.
protected acceptFormStart ( SimpleFormTag $tag )
$tag SimpleFormTag Tag to accept.

acceptFrame() protected method

Takes a single frame tag and stashes it in the current frame set.
protected acceptFrame ( SimpleFrameTag $tag )
$tag SimpleFrameTag Tag to accept.

acceptFramesetEnd() protected method

Closes the most recently opened frameset.
protected acceptFramesetEnd ( )

acceptFramesetStart() protected method

Opens a frameset. A frameset may contain nested frameset tags.
protected acceptFramesetStart ( SimpleFramesetTag $tag )
$tag SimpleFramesetTag Tag to accept.

acceptLabelEnd() protected method

Closes the most recently opened label.
protected acceptLabelEnd ( )

acceptLabelStart() protected method

Opens a label for a described widget.
protected acceptLabelStart ( SimpleFormTag $tag )
$tag SimpleFormTag Tag to accept.

acceptPageEnd() protected method

Marker for end of complete page. Any work in progress can now be closed.
protected acceptPageEnd ( )

acceptTag() protected method

Adds a tag to the page.
protected acceptTag ( SimpleTag $tag )
$tag SimpleTag Tag to accept.

addContent() public method

Unparsed, but relevant data. The data is added to every open tag.
public addContent ( string $text ) : boolean
$text string May include unparsed tags.
return boolean False on parse error.

addContentTagToOpenTags() protected method

The parsed tag is added to every open tag. Used for adding options to select fields only.
protected addContentTagToOpenTags ( SimpleTag &$tag )
$tag SimpleTag Option tags only.

addContentToAllOpenTags() protected method

Any content fills all currently open tags unless it is part of an option tag.
protected addContentToAllOpenTags ( string $text )
$text string May include unparsed tags.

can() public method

This builder is always available.
public can ( ) : boolean
return boolean Always true.

createPage() protected method

Creates an empty page.
protected createPage ( $response ) : SimplePage
return SimplePage New unparsed page.

createParser() protected method

Creates the parser used with the builder.
protected createParser ( SimplePhpPageBuilder &$listener ) : SimpleSaxParser
$listener SimplePhpPageBuilder Target of parser.
return SimpleSaxParser Parser to generate events for the builder.

endElement() public method

End of element event.
public endElement ( string $name ) : boolean
$name string Element name.
return boolean False on parse error.

free() public method

Frees up any references so as to allow the PHP garbage collection from unset() to work.
public free ( )

hasNamedTagOnOpenTagStack() protected method

Test to see if there are any open tags awaiting closure that match the tag name.
protected hasNamedTagOnOpenTagStack ( string $name ) : boolean
$name string Element name.
return boolean True if any are still open.

isFormElement() protected method

Tests to see if a tag is a possible form element.
protected isFormElement ( string $name ) : boolean
$name string HTML element name.
return boolean True if form element.

isLoadingFrames() protected method

Test to see if in the middle of reading a frameset.
protected isLoadingFrames ( ) : boolean
return boolean True if inframeset.

openTag() protected method

Multiple tags will be receiving input at the same time.
protected openTag ( SimpleTag $tag )
$tag SimpleTag New content tag.

parse() public method

Reads the raw content and send events into the page to be built.
public parse ( $response ) : SimplePage
$response SimpleHttpResponse Fetched response.
return SimplePage Newly parsed page.

startElement() public method

Start of element event. Opens a new tag.
public startElement ( string $name, hash $attributes ) : boolean
$name string Element name.
$attributes hash Attributes without content are marked as true.
return boolean False on parse error.