# types/Parameter.php

A parameter is composed of a name, type and value. Nested Parameters are also possible, but the using task/type has to support them

Author
  Manuel Holtgrewe
Author
  Yannick Lecaillez
Package
  phing.types

## \Parameter
jump to top

Package: phing\types

A parameter is composed of a name, type and value. Nested Parameters are also possible, but the using task/type has to support them

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)
  \DataType < \ProjectComponent
Author
  Manuel Holtgrewe
Author
  Yannick Lecaillez
Version
  $Revision: 526 $

### Properties

`boolean $checked= 'true'`
inherited

Are we sure we don't hold circular references?

Inherited from: \DataType::$checked

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
Inherited_from
  \DataType::$checked

`$description= 'null'`
inherited

The descriptin the user has set.

Inherited from: \DataType::$description
Default value `null` Details

Type
Inherited_from
  \DataType::$description

`$name= ''`

Parameter name

Details

Type

`$parameters= 'array()'`

Nested parameters

Default value `array()`Details

Type

`\Project $project= 'null'`
inherited

Holds a reference to the project that a project component (a task, a target, etc.) belongs to

A reference to the current project instanceInherited from: \ProjectComponent::$project
Default value `null` Details

Type
  \Project
Inherited_from
  \ProjectComponent::$project

`$ref= 'null'`
inherited

Value to the refid attribute. Type of Reference

Inherited from: \DataType::$ref
Default value `null` Details

Type
Inherited_from
  \DataType::$ref

`$type= ''`

Paramter type

Details

Type

`$value= ''`

Parameter value

Details

Type

### Methods

`circularReference( ) : void`
inherited

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

Inherited from: \DataType::circularReference()
`createParam( ) : \Parameter`

Returns

Type | Description
--- | ---
\Parameter |

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

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).

Inherited from: \DataType::dieOnCircularReference()

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`
inherited

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

Inherited from: \DataType::getCheckedRef()
Parameters

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

`getDescription( ) : void`
inherited

Return the description for the current data type.

Inherited from: \DataType::getDescription()
`getName( ) : void`

`getParams( ) : array`

Returns

Type | Description
--- | ---
array | Nested parameters.

`getProject( ) : \Project`
inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()
Returns

Type | Description
--- | ---
\Project | Reference to current porject object

`getType( ) : void`

`getValue( ) : void`

`isReference( ) : void`
inherited

Has the refid attribute of this element been set?

Inherited from: \DataType::isReference()
`log( $msg, integer $level = Project::MSG_INFO ) : void`
inherited

Logs a message with the given priority.

Inherited from: \ProjectComponent::log()

@param string $msg The message to be logged.

Parameters

Name | Type | Description
--- | --- | ---
$msg |  |
$level | integer | The message's priority at this message should have

`noChildrenAllowed( ) : void`
inherited

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

Inherited from: \DataType::noChildrenAllowed()
`parsingComplete( ) : void`
inherited

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

Inherited from: \DataType::parsingComplete()
`setDescription( $desc ) : void`
inherited

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

Inherited from: \DataType::setDescription()
Parameters

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

`setListeningValue( \RegisterSlot $value ) : void`

Sets value to dynamic register slot.

Parameters

Name | Type | Description
--- | --- | ---
$value | \RegisterSlot |

`setName( $name ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$name |  |

`setProject( \Project $project ) : void`
inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()
Parameters

Name | Type | Description
--- | --- | ---
$project | \Project | The reference to the current project

`setRefid( \Reference $r ) : void`
inherited

Set the value of the refid attribute.

Inherited from: \DataType::setRefid()

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 |

`setType( $type ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$type |  |

`setValue( $value ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`tooManyAttributes( ) : void`
inherited

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

Inherited from: \DataType::tooManyAttributes()
Documentation was generated by DocBlox 0.15.1.