parser/NestedElementHandler.php
inherited
Classes
The nested element handler class.
This class handles the occurance of runtime registered tags like datatypes (fileset, patternset, etc) and it's possible nested tags. It introspects the implementation of the class and sets up the data structures.
- Access
- public
- Author
- Andreas Aderhold
- Copyright
- 2001,2002 THYRELL. All rights reserved
- Package
- phing.parser
- Version
- $Id$
\NestedElementHandler
The nested element handler class.
This class handles the occurance of runtime registered tags like datatypes (fileset, patternset, etc) and it's possible nested tags. It introspects the implementation of the class and sets up the data structures.
- Parent(s)
- \AbstractHandler
- Access
- public
- Author
- Andreas Aderhold
- Copyright
- 2001,2002 THYRELL. All rights reserved
- Version
- $Id$
Properties
object
$child= ''
Reference to the child object that represents the child tag of this nested element
- Type
- object
$childWrapper= ''
Reference to the child wrapper object
@var object
- Type
- n/a
object
$parent= ''
Reference to the parent object that represents the parent tag of this nested element
- Type
- object
$parentHandler= 'null'
nullDetails- Type
- n/a
- Inherited_from
- \AbstractHandler::$$parentHandler
$parentWrapper= ''
Reference to the parent wrapper object
@var object
- Type
- n/a
$parser= 'null'
nullDetails- Type
- n/a
- Inherited_from
- \AbstractHandler::$$parser
$target= ''
Reference to the related target object
@var object the target instance
- Type
- n/a
Methods
__construct(
object $parser, object $parentHandler, object $configurator, object $parent, object $parentWrapper, $target
)
:
voidConstructs a new NestedElement handler and sets up everything.
@param object the ExpatParser object
| Name | Type | Description |
|---|---|---|
| $parser | object | the parent handler that invoked this handler |
| $parentHandler | object | the ProjectConfigurator object |
| $configurator | object | the parent object this element is contained in |
| $parent | object | the parent wrapper object |
| $parentWrapper | object | the target object this task is contained in |
| $target |
- Access
- public
characters(
string $data
)
:
voidHandles character data.
| Name | Type | Description |
|---|---|---|
| $data | string | the CDATA that comes in |
| Exception | Description |
|---|---|
| \ExpatParseException | if the CDATA could not be set-up properly |
- Access
- public
endElement(
string $name
)
:
void
Can be overloaded by the child class. But should not. It hands over control to the parentHandler of this.
| Name | Type | Description |
|---|---|---|
| $name | string | the name of the XML element |
finished(
)
:
void
init(
string $propType, array $attrs
)
:
voidExecutes initialization actions required to setup the data structures related to the tag.
<
p> This includes:
- creation of the nested element
- calling the setters for attributes
- adding the element to the container object
- adding a reference to the element (if id attribute is given)
| Name | Type | Description |
|---|---|---|
| $propType | string | the tag that comes in |
| $attrs | array | attributes the tag carries |
| Exception | Description |
|---|---|
| \ExpatParseException | if the setup process fails |
- Access
- public
startElement(
string $name, array $attrs
)
:
voidChecks for nested tags within the current one. Creates and calls handlers respectively.
Must be overloaded by the child class. Throws an ExpatParseException if there is no handler registered for an element.
| Name | Type | Description |
|---|---|---|
| $name | string | the tag that comes in |
| $attrs | array | attributes the tag carries |
- Access
- public