types/selectors/FilenameSelector.php
inherited
Classes
Selector that filters files based on the filename.
- Author
- Hans Lellelid, hans@xmpl.org (Phing)
- Author
- Bruce Atherton, bruce@callenish.com (Ant)
- Package
- phing.types.selectors
\FilenameSelector
Selector that filters files based on the filename.
- Parent(s)
- \BaseExtendSelector < \BaseSelector < \DataType < \ProjectComponent
- Author
- Hans Lellelid, hans@xmpl.org (Phing)
- Author
- Bruce Atherton, bruce@callenish.com (Ant)
Constants
Properties
$casesensitive= 'true'
trueDetails- Type
- n/a
$negated= 'false'
falseDetails- Type
- n/a
$pattern= 'null'
nullDetails- Type
- n/a
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(
)
:
voidsetCasesensitive(
\casesensitive $casesensitive
)
:
voidWhether to ignore case when checking filenames.
| Name | Type | Description |
|---|---|---|
| $casesensitive | \casesensitive | whether to pay attention to case sensitivity |
setDescription(
)
:
voidsetError(
)
:
voidsetName(
\pattern $pattern
)
:
voidThe name of the file, or the pattern for the name, that should be used for selection.
| Name | Type | Description |
|---|---|---|
| $pattern | \pattern | the file pattern that any filename must match against in order to be selected. |
setNegate(
\negated $negated
)
:
voidYou can optionally reverse the selection of this selector, thereby emulating an <exclude> tag, by setting the attribute negate to true. This is identical to surrounding the selector with <not></not>.
| Name | Type | Description |
|---|---|---|
| $negated | \negated | whether to negate this selection |
setParameters(
array $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 | array | 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 name attribute has been set.