parser/AbstractHandler.php

Show: inherited
Table of Contents

This is an abstract class all SAX handler classes must extend

Author
Andreas Aderhold  
Copyright
2001,2002 THYRELL. All rights reserved  
Package
phing.parser  
Version
$Id$  

\AbstractHandler

Package: phing\parser

This is an abstract class all SAX handler classes must extend

Children
\NestedElementHandler
\TargetHandler
\DataTypeHandler
\TaskHandler
\ProjectHandler
\RootHandler
Author
Andreas Aderhold  
Copyright
2001,2002 THYRELL. All rights reserved  
Version
$Id$  

Properties

Propertypublic  $parentHandler= 'null'
Default valuenullDetails
Type
n/a
Propertypublic  $parser= 'null'
Default valuenullDetails
Type
n/a

Methods

methodprotected__construct( object $parser, object $parentHandler ) : void

Constructs a SAX handler parser.

The constructor must be called by all derived classes.

Parameters
Name Type Description
$parser object

the parser object

$parentHandler object

the parent handler of this handler

methodpubliccharacters( string $data ) : void

Invoked by occurance of #PCDATA.

Parameters
Name Type Description
$data string

the name of the XML element

Details
Access
public  
Exception
ExpatParserException if there is no CDATA but method was called  
methodpublicendElement( string $name ) : void

Gets invoked when a XML element ends.

Can be overloaded by the child class. But should not. It hands over control to the parentHandler of this.

Parameters
Name Type Description
$name string

the name of the XML element

methodprotectedfinished( ) : void

Gets invoked when element closes method.

methodpublicstartElement( string $name, array $attribs ) : void

Gets invoked when a XML open tag occurs

Must be overloaded by the child class. Throws an ExpatParseException if there is no handler registered for an element.

Parameters
Name Type Description
$name string

the name of the XML element

$attribs array

the attributes of the XML element

Documentation was generated by DocBlox 0.18.1.