# types/DataType.php

## \DataType
jump to top

Package: phing\types

Base class for those classes that can appear inside the build file as stand alone data types.

This class handles the common description attribute and provides a default implementation for reference handling and checking for circular references that is appropriate for types that can not be nested inside elements of the same type (i.e. patternset but not path)

Parent(s)
  \ProjectComponent
Children
  \PhpCodeSnifferTask_FormatterElement
  \Parameter
  \TokenSource
  \PhingFilterReader
  \Excludes
  \FilterChain
  \Mapper
  \RegularExpression
  \AbstractFileSet
  \Description
  \Path
  \PatternSet
  \FileList
  \BaseSelector

### Properties

`boolean $checked= 'true'`

Are we sure we don't hold circular references?

Subclasses are responsible for setting this value to false if we'd need to investigate this condition (usually because a child element has been added that is a subclass of DataType).

Default value `true` Details

Type
  boolean

`$description= 'null'`

The descriptin the user has set.

Default value `null` Details

Type
  n/a

`$ref= 'null'`

Value to the refid attribute. Type of Reference

Default value `null` Details

Type
  n/a

### Methods

`circularReference( ) : void`

Creates an exception that indicates the user has generated a loop of data types referencing each other.

`dieOnCircularReference( $stk, $p ) : void`

Check to see whether any DataType we hold references to is included in the Stack (which holds all DataType instances that directly or indirectly reference this instance, including this instance itself).

If one is included, throw a BuildException created by circularReference

This implementation is appropriate only for a DataType that cannot hold other DataTypes as children.

The general contract of this method is that it shouldn't do anything if checked is true and set it to true on exit.

Parameters

Name | Type | Description
--- | --- | ---
$stk |  |
$p |  |

`getCheckedRef( $requiredClass, $dataTypeName ) : void`

Performs the check for circular references and returns the referenced object.

Parameters

Name | Type | Description
--- | --- | ---
$requiredClass |  |
$dataTypeName |  |

`getDescription( ) : void`

Return the description for the current data type.

`getProject( ) : void`

`isReference( ) : void`

Has the refid attribute of this element been set?

`log( ) : void`

`noChildrenAllowed( ) : void`

Creates an exception that indicates that this XML element must not have child elements if the refid attribute is set.

`parsingComplete( ) : void`

Template method being called when the data type has been parsed completely.

`setDescription( $desc ) : void`

Sets a description of the current data type. It will be useful in commenting what we are doing.

Parameters

Name | Type | Description
--- | --- | ---
$desc |  |

`setProject( ) : void`

`setRefid( \Reference $r ) : void`

Set the value of the refid attribute.

Subclasses may need to check whether any other attributes have been set as well or child elements have been created and thus override this method. if they do they must call parent::setRefid()

Parameters

Name | Type | Description
--- | --- | ---
$r | \Reference |

`tooManyAttributes( ) : void`

Creates an exception that indicates that refid has to be the only attribute if it is set.

Documentation was generated by DocBlox 0.17.1.