types/selectors/DepthSelector.php
inherited
Classes
Selector that filters files based on the how deep in the directory tree they are.
- Author
- Hans Lellelid
- Author
- Bruce Atherton
- Package
- phing.types.selectors
- Version
- $Revision: 526 $
\DepthSelector
Selector that filters files based on the how deep in the directory tree they are.
- Parent(s)
- \BaseExtendSelector < \BaseSelector < \DataType < \ProjectComponent
- Author
- Hans Lellelid
- Author
- Bruce Atherton
- Version
- $Revision: 526 $
Constants
Properties
Methods
circularReference(
)
:
voiddieOnCircularReference(
)
:
voidgetCheckedRef(
)
:
voidgetDescription(
)
:
voidgetError(
)
:
voidgetParameters(
)
:
voidgetProject(
)
:
voidisReference(
)
:
voidisSelected(
\basedir $basedir, \filename $filename, \file $file
)
:
\whetherThe 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.
| 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 |
| Type | Description |
|---|---|
| \whether | the file should be selected or not |
log(
)
:
voidnoChildrenAllowed(
)
:
voidparsingComplete(
)
:
voidsetDescription(
)
:
voidsetError(
)
:
voidsetMax(
\min $max
)
:
voidThe minimum depth below the basedir before a file is selected.
| Name | Type | Description |
|---|---|---|
| $max | \min | maximum directory levels below basedir to go |
setMin(
\min $min
)
:
voidThe minimum depth below the basedir before a file is selected.
| Name | Type | Description |
|---|---|---|
| $min | \min | minimum directory levels below basedir to go |
setParameters(
\parameters $parameters
)
:
voidWhen using this as a custom selector, this method will be called.
It translates each parameter into the appropriate setXXX() call.
| Name | Type | Description |
|---|---|---|
| $parameters | \parameters | the complete set of parameters for this selector |
setProject(
)
:
voidsetRefid(
)
:
voidtoString(
)
:
voidtooManyAttributes(
)
:
voidvalidate(
)
:
voidverifySettings(
)
:
voidChecks to make sure all settings are kosher. In this case, it means that the max depth is not lower than the min depth.