PHP Class SimplePhpPageBuilder, simpletest

Afficher le fichier Open project: simpletest/simpletest Class Usage Examples

Méthodes publiques

Méthode 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.

Méthodes protégées

Méthode 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 méthode

Closes the most recently opened form.
protected acceptFormEnd ( )

acceptFormStart() protected méthode

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

acceptFrame() protected méthode

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

acceptFramesetEnd() protected méthode

Closes the most recently opened frameset.
protected acceptFramesetEnd ( )

acceptFramesetStart() protected méthode

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

acceptLabelEnd() protected méthode

Closes the most recently opened label.
protected acceptLabelEnd ( )

acceptLabelStart() protected méthode

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

acceptPageEnd() protected méthode

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

acceptTag() protected méthode

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

addContent() public méthode

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

addContentTagToOpenTags() protected méthode

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 méthode

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 méthode

This builder is always available.
public can ( ) : boolean
Résultat boolean Always true.

createPage() protected méthode

Creates an empty page.
protected createPage ( $response ) : SimplePage
Résultat SimplePage New unparsed page.

createParser() protected méthode

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

endElement() public méthode

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

free() public méthode

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

hasNamedTagOnOpenTagStack() protected méthode

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.
Résultat boolean True if any are still open.

isFormElement() protected méthode

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

isLoadingFrames() protected méthode

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

openTag() protected méthode

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

parse() public méthode

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

startElement() public méthode

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.
Résultat boolean False on parse error.