# types/selectors/ExtendSelector.php

Selector that selects files by forwarding the request on to other classes.

TODO - Consider adding Path (phing.types.Path) support to this class and to the Mappers class. See Ant versions for implimentation details.

Author
  Hans Lellelid (Phing)
Author
  Bruce Atherton (Ant)
Package
  phing.types.selectors

## \ExtendSelector
jump to top

Package: phing\types\selectors

Selector that selects files by forwarding the request on to other classes.

TODO - Consider adding Path (phing.types.Path) support to this class and to the Mappers class. See Ant versions for implimentation details.

Parent(s)
  \BaseSelector < \DataType < \ProjectComponent
Author
  Hans Lellelid (Phing)
Author
  Bruce Atherton (Ant)

### Properties

`boolean $checked= 'true'`
inherited

Are we sure we don't hold circular references?

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

`$classname= ''`
Details

Type
  n/a

`$description= 'null'`
inherited

The descriptin the user has set.

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

Type
  n/a
Inherited_from
  \DataType::$$description
Inherited_from
  \BaseSelector::$$description

`$dynselector= ''`
Details

Type
  n/a

`$errmsg= 'null'`
inherited Inherited from: \BaseSelector::$$errmsg
Default value `null` Details

Type
  n/a
Inherited_from
  \BaseSelector::$$errmsg

`$parameters= 'array()'`
Default value `array()`Details

Type
  n/a

`$ref= 'null'`
inherited

Value to the refid attribute. Type of Reference

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

Type
  n/a
Inherited_from
  \DataType::$$ref
Inherited_from
  \BaseSelector::$$ref

### Methods

`addParam( \p $p ) : void`

Create new parameters to pass to custom selector.

Parameters

Name | Type | Description
--- | --- | ---
$p | \p | The new Parameter object

`circularReference( ) : void`
inherited

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

Inherited from: \DataType::circularReference()\BaseSelector::circularReference()
`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()\BaseSelector::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()\BaseSelector::getCheckedRef()
Parameters

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

`getDescription( ) : void`
inherited

Return the description for the current data type.

Inherited from: \DataType::getDescription()\BaseSelector::getDescription()
`getError( ) : \the`
inherited

Returns any error messages that have been set.

Inherited from: \BaseSelector::getError()
Returns

Type | Description
--- | ---
\the | error condition

`getProject( ) : void`
inherited

Inherited from: ProjectComponent::getProject()\DataType::getProject()\BaseSelector::getProject()
`isReference( ) : void`
inherited

Has the refid attribute of this element been set?

Inherited from: \DataType::isReference()\BaseSelector::isReference()
`isSelected( \basedir $basedir, \filename $filename, \file $file ) : \whether`

Allows the custom selector to choose whether to select a file. This is also where the Parameters are passed to the custom selector.

Parameters

Name | Type | Description
--- | --- | ---
$basedir | \basedir | A PhingFile object for the base directory
$filename | \filename | The name of the file to check
$file | \file | A PhingFile object for this filename

Returns

Type | Description
--- | ---
\whether | the file should be selected or not

Throws

Exception | Description
--- | ---
\BuildException |

`log( ) : void`
inherited

Inherited from: ProjectComponent::log()\DataType::log()\BaseSelector::log()
`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()\BaseSelector::noChildrenAllowed()
`parsingComplete( ) : void`
inherited

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

Inherited from: \DataType::parsingComplete()\BaseSelector::parsingComplete()
`selectorCreate( ) : void`

Instantiates the identified custom selector class.

`setClassname( \classname $classname ) : void`

Sets the classname of the custom selector.

Parameters

Name | Type | Description
--- | --- | ---
$classname | \classname | is the class which implements this selector

`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()\BaseSelector::setDescription()
Parameters

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

`setError( \msg $msg ) : void`
inherited

Allows all selectors to indicate a setup error. Note that only the first error message is recorded.

Inherited from: \BaseSelector::setError()
Parameters

Name | Type | Description
--- | --- | ---
$msg | \msg | The error message any BuildException should throw.

`setProject( ) : void`
inherited

Inherited from: ProjectComponent::setProject()\DataType::setProject()\BaseSelector::setProject()
`setRefid( \Reference $r ) : void`
inherited

Set the value of the refid attribute.

Inherited from: \DataType::setRefid()\BaseSelector::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 |

`tooManyAttributes( ) : void`
inherited

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

Inherited from: \DataType::tooManyAttributes()\BaseSelector::tooManyAttributes()
`validate( ) : void`
inherited

Subclasses can use this to throw the requisite exception in isSelected() in the case of an error condition.

Inherited from: \BaseSelector::validate()
`verifySettings( ) : void`

These are errors specific to ExtendSelector only. If there are errors in the custom selector, it should throw a BuildException when isSelected() is called.

Documentation was generated by DocBlox 0.17.1.