# types/selectors/BaseSelectorContainer.php

## \BaseSelectorContainer
jump to top

Package: phing\types\selectors

This is the base class for selectors that can contain other selectors.

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)

Implements
  \SelectorContainer
Parent(s)
  \BaseSelector < \DataType < \ProjectComponent
Children
  \OrSelector
  \AndSelector
  \NoneSelector
  \MajoritySelector
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

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

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

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

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

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

Type
  n/a

### Methods

`appendSelector( \selector $selector ) : \the`

Add a new selector into this container.

Parameters

Name | Type | Description
--- | --- | ---
$selector | \selector | the new selector to add

Returns

Type | Description
--- | ---
\the | selector that was added

`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()
`createAnd( ) : void`

add an "And" selector entry on the selector list

`createContains( ) : void`

add a contains selector entry on the selector list

`createContainsRegexp( ) : void`

add a contains selector entry on the selector list

`createCustom( ) : void`

add an extended selector entry on the selector list

`createDate( ) : void`

add a selector date entry on the selector list

`createDepend( ) : void`

add a depends selector entry on the selector list

`createDepth( ) : void`

add a depth selector entry on the selector list

`createFilename( ) : void`

add a selector filename entry on the selector list

`createMajority( ) : void`

add a majority selector entry on the selector list

`createNone( ) : void`

add a "None" selector entry on the selector list

`createNot( ) : void`

add a "Not" selector entry on the selector list

`createOr( ) : void`

add an "Or" selector entry on the selector list

`createPresent( ) : void`

add a present selector entry on the selector list

`createSelector( ) : void`

add a "Select" selector entry on the selector list

`createSize( ) : void`

add a selector size entry on the selector list

`createType( ) : void`

add a type selector entry on the selector list

`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()
`getSelectors( $p ) : \an`

Returns a copy of the selectors as an array.

Parameters

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

Returns

Type | Description
--- | ---
\an | array of selectors in this container

`hasSelectors( ) : \whether`

Indicates whether there are any selectors here.

Returns

Type | Description
--- | ---
\whether | any selectors are in this container

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

Method that each selector will implement to create their selection behaviour. If there is a problem with the setup of a selector, it can throw a BuildException to indicate the problem.

Inherited from: \FileSelector::isSelected()\BaseSelector::isSelected()
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 | if the selector was not configured correctly

`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()
`selectorCount( ) : \the`

Gives the count of the number of selectors in this container

Returns

Type | Description
--- | ---
\the | number of selectors in this container

`selectorElements( ) : \an`

Returns an array for accessing the set of selectors (not a copy).

Returns

Type | Description
--- | ---
\an | enumerator that goes through each of the selectors

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

`toString( ) : \comma`

Convert the Selectors within this container to a string. This will just be a helper class for the subclasses that put their own name around the contents listed here.

Returns

Type | Description
--- | ---
\comma | separated list of Selectors contained in this one

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

This implementation validates the container by calling verifySettings() and then validates each contained selector provided that the selector implements the validate interface.

Ordinarily, this will validate all the elements of a selector container even if the isSelected() method of some elements is never called. This has two effects:

- Validation will often occur twice.
- Since it is not required that selectors derive from BaseSelector, there could be selectors in the container whose error conditions are not detected if their isSelected() call is never made.

`verifySettings( ) : void`
inherited

Subclasses can override this method to provide checking of their state. So long as they call validate() from isSelected(), this will be called automatically (unless they override validate()).

Implementations should check for incorrect settings and call setError() as necessary.

Inherited from: \BaseSelector::verifySettings()
Documentation was generated by DocBlox 0.17.1.