classes/phing/types/selectors/TypeSelector.php
Classes
Selector that selects a certain kind of file: directory or regular file.
- author
- Hans Lellelid
- author
- Jeff Turner
- package
- phing.types.selectors
- version
- $Revision: 526 $
\TypeSelector
Selector that selects a certain kind of file: directory or regular file.
It provides support for gathering the parameters together as well as for assigning an error message and throwing a build exception if an error is detected.
- Extends from
- \BaseExtendSelector
- author
- Hans Lellelid
- author
- Jeff Turner
- package
- phing.types.selectors
- version
- $Revision: 526 $
Constants
Properties
Methods
isSelected(
\PhingFile $basedir, string $filename, \PhingFile $file
)
:
booleanThe heart of the matter. This is where the selector gets to decide
on the inclusion of a file in a particular fileset.
| Name | Type | Description |
|---|---|---|
| $basedir | \PhingFile | the base directory the scan is being done from |
| $filename | string | is the name of the file to check |
| $file | \PhingFile | is a PhingFile object the selector can use |
| Type | Description |
|---|---|
| boolean |
setParameters(
array $parameters
)
:
When 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 |
setType(
string $type
)
:
Set the type of file to require.
| Name | Type | Description |
|---|---|---|
| $type | string | The type of file - 'file' or 'dir' |
toString(
)
:
string
| Type | Description |
|---|---|
| string |
verifySettings(
)
:
Checks to make sure all settings are kosher. In this case, it
means that the pattern attribute has been set.