# types/selectors/DepthSelector.php

Selector that filters files based on the how deep in the directory tree they are.

Author
  Hans Lellelid (Phing)
Author
  Bruce Atherton (Ant)
Package
  phing.types.selectors
Version
  $Revision: 526 $

## \DepthSelector
jump to top

Package: phing\types\selectors

Selector that filters files based on the how deep in the directory tree they are.

Parent(s)
  \BaseExtendSelector < \BaseSelector < \DataType < \ProjectComponent
Author
  Hans Lellelid (Phing)
Author
  Bruce Atherton (Ant)
Version
  $Revision: 526 $

### Constants

`MIN_KEY = "min"`

`MAX_KEY = "max"`

### Properties

`$max= '-1'`
Default value`-1` Details

Type
  n/a

`$min= '-1'`
Default value`-1` Details

Type
  n/a

### Methods

`circularReference( ) : void`

`dieOnCircularReference( ) : void`

`getCheckedRef( ) : void`

`getDescription( ) : void`

`getError( ) : void`

`getParameters( ) : void`

`getProject( ) : void`

`isReference( ) : void`

`isSelected( \basedir $basedir, \filename $filename, \file $file ) : \whether`

The heart of the matter. This is where the selector gets to decide on the inclusion of a file in a particular fileset. Most of the work for this selector is offloaded into SelectorUtils, a static class that provides the same services for both FilenameSelector and DirectoryScanner.

Parameters

Name | Type | Description
--- | --- | ---
$basedir | \basedir | the base directory the scan is being done from
$filename | \filename | is the name of the file to check
$file | \file | is a PhingFile object the selector can use

Returns

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

`log( ) : void`

`noChildrenAllowed( ) : void`

`parsingComplete( ) : void`

`setDescription( ) : void`

`setError( ) : void`

`setMax( \min $max ) : void`

The minimum depth below the basedir before a file is selected.

Parameters

Name | Type | Description
--- | --- | ---
$max | \min | maximum directory levels below basedir to go

`setMin( \min $min ) : void`

The minimum depth below the basedir before a file is selected.

Parameters

Name | Type | Description
--- | --- | ---
$min | \min | minimum directory levels below basedir to go

`setParameters( \parameters $parameters ) : void`

When using this as a custom selector, this method will be called.

It translates each parameter into the appropriate setXXX() call.

Parameters

Name | Type | Description
--- | --- | ---
$parameters | \parameters | the complete set of parameters for this selector

`setProject( ) : void`

`setRefid( ) : void`

`toString( ) : void`

`tooManyAttributes( ) : void`

`validate( ) : void`

`verifySettings( ) : void`

Checks to make sure all settings are kosher. In this case, it means that the max depth is not lower than the min depth.

Documentation was generated by DocBlox 0.17.1.