parser/ProjectHandler.php

Show: inherited
Table of Contents

Handler class for the <project> XML element This class handles all elements under the <project> element.

Access
public  
Author
Andreas Aderhold  
Copyright
(c) 2001,2002 THYRELL. All rights reserved  
Package
phing.parser  
Version
$Id: 393b1f3d8758281af2fd0153ffc6151333457527 $  

\ProjectHandler

Package: phing\parser

Handler class for the <project> XML element This class handles all elements under the <project> element.

Parent(s)
\AbstractHandler
Access
public  
Author
Andreas Aderhold  
Copyright
(c) 2001,2002 THYRELL. All rights reserved  
Version
$Id: 393b1f3d8758281af2fd0153ffc6151333457527 $  

Properties

Propertyprivate\ProjectConfigurator  $configurator= ''

The phing project configurator object.

Details
Type
\ProjectConfigurator
Propertypublic  $parentHandler= 'null'
inheritedInherited from: \AbstractHandler::$$parentHandler
Default valuenullDetails
Type
n/a
Inherited_from
\AbstractHandler::$$parentHandler  
Propertypublic  $parser= 'null'
inheritedInherited from: \AbstractHandler::$$parser
Default valuenullDetails
Type
n/a
Inherited_from
\AbstractHandler::$$parser  

Methods

methodpublic__construct( object $parser, object $parentHandler, object $configurator ) : void

Constructs a new ProjectHandler

The constructor must be called by all derived classes.

Parameters
Name Type Description
$parser object

the ExpatParser object

$parentHandler object

the parent handler that invoked this handler

$configurator object

the ProjectConfigurator object

Details
Access
public  
methodpubliccanonicalName(  $name ) : void
static

Parameters
Name Type Description
$name
methodpubliccharacters( string $data ) : void
inherited

Invoked by occurance of #PCDATA.

Inherited from: \AbstractHandler::characters()
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
inherited

Gets invoked when a XML element ends.

Inherited from: \AbstractHandler::endElement()

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
inherited

Gets invoked when element closes method.

Inherited from: \AbstractHandler::finished()
methodpublicinit( string $tag, array $attrs ) : void

Executes initialization actions required to setup the project. Usually this method handles the attributes of a tag.

Parameters
Name Type Description
$tag string

the tag that comes in

$attrs array

attributes the tag carries

Throws
Exception Description
\ExpatParseException if attributes are incomplete or invalid
Details
Access
public  
methodpublicstartElement( string $name, array $attrs ) : void

Handles start elements within the tag by creating and calling the required handlers for the detected element.

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 tag that comes in

$attrs array

attributes the tag carries

Throws
Exception Description
\ExpatParseException if a unxepected element occurs
Details
Access
public  
Documentation was generated by DocBlox 0.18.1.