phing-parser
[ class tree: phing-parser ] [ index: phing-parser ] [ all elements ]

Class: DataTypeHandler

Source Location: /parser/DataTypeHandler.php

Class Overview

AbstractHandler
   |
   --DataTypeHandler

Configures a Project (complete with Targets and Tasks) based on a XML build file.


Author(s):

Version:

  • $Revision: 526 $ $Date: 2009-08-11 14:11:17 +0200 (Tue, 11 Aug 2009) $

Copyright:

  • © 2001,2002 THYRELL. All rights reserved

Methods


Inherited Variables

Inherited Methods

Class: AbstractHandler

AbstractHandler::__construct()
Constructs a SAX handler parser.
AbstractHandler::characters()
Invoked by occurance of #PCDATA.
AbstractHandler::endElement()
Gets invoked when a XML element ends.
AbstractHandler::finished()
Gets invoked when element closes method.
AbstractHandler::startElement()
Gets invoked when a XML open tag occurs

Class Details

[line 39]
Configures a Project (complete with Targets and Tasks) based on a XML build file.

Design/ZE2 migration note: If PHP would support nested classes. All the phing/parser/*Filter classes would be nested within this class




Tags:

author:  Andreas Aderhold <andi@binarycloud.com>
version:  $Revision: 526 $ $Date: 2009-08-11 14:11:17 +0200 (Tue, 11 Aug 2009) $
copyright:  © 2001,2002 THYRELL. All rights reserved
access:  public


[ Top ]


Class Methods


constructor __construct [line 53]

DataTypeHandler __construct( AbstractSAXParser $parser, AbstractHandler $parentHandler, ProjectConfigurator $configurator, [Target $target = null])

Constructs a new DataTypeHandler and sets up everything.



Overrides AbstractHandler::__construct() (Constructs a SAX handler parser.)

Parameters:

AbstractSAXParser   $parser   The XML parser (default: ExpatParser)
AbstractHandler   $parentHandler   The parent handler that invoked this handler.
ProjectConfigurator   $configurator   The ProjectConfigurator object
Target   $target   The target object this datatype is contained in (null for top-level datatypes).

[ Top ]

method characters [line 108]

void characters( string $data)

Handles character data.



Tags:

access:  public


Overrides AbstractHandler::characters() (Invoked by occurance of #PCDATA.)

Parameters:

string   $data   the CDATA that comes in

[ Top ]

method endElement [line 139]

void endElement( string $name)

Overrides endElement for data types. Tells the type handler that processing the element had been finished so handlers know they can perform actions that need to be based on the data contained within the element.



Overrides AbstractHandler::endElement() (Gets invoked when a XML element ends.)

Parameters:

string   $name   the name of the XML element

[ Top ]

method init [line 76]

void init( string $propType, array $attrs)

Executes initialization actions required to setup the data structures related to the tag.

This includes:

  • creation of the datatype object
  • calling the setters for attributes
  • adding the type to the target object if any
  • adding a reference to the task (if id attribute is given)




Tags:

throws:  ExpatParseException if attributes are incomplete or invalid
access:  public


Parameters:

string   $propType   the tag that comes in
array   $attrs   attributes the tag carries

[ Top ]

method startElement [line 125]

void startElement( string $name, array $attrs)

Checks for nested tags within the current one. Creates and calls handlers respectively.



Tags:

access:  public


Overrides AbstractHandler::startElement() (Gets invoked when a XML open tag occurs)

Parameters:

string   $name   the tag that comes in
array   $attrs   attributes the tag carries

[ Top ]


Documentation generated on Mon, 19 Oct 2009 10:50:43 +0200 by phpDocumentor 1.4.3