classes/phing/types/selectors/SizeSelector.php
Classes
Selector that filters files based on their size.
- author
- Hans Lellelid
- author
- Bruce Atherton
- package
- phing.types.selectors
\SizeSelector
Selector that filters files based on their size.
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
- Bruce Atherton
- package
- phing.types.selectors
- version
- $Revision: 526 $
Constants
Properties
$byteUnits= 'array'
arrayDetails- Type
$cmp= '2'
2Details- Type
$multiplier= '1'
1Details- Type
$size= ''
- Type
$sizeComparisons= 'array'
arrayDetails- Type
$sizelimit= ''
- Type
Methods
isSelected(
\basedir $basedir, \filename $filename, \file $file
)
:
\whether| 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 |
| Type | Description |
|---|---|
| \whether |
setParameters(
\parameters $parameters
)
:
It translates each parameter into the appropriate setXXX() call.
| Name | Type | Description |
|---|---|---|
| $parameters | \parameters | the complete set of parameters for this selector |
setUnits(
\$units $units
)
:
void<
p> To get around this complexity, a number of standards bodies have proposed the 2^10 standard, and at least one has adopted it. But we are still left with a populace that isn't clear on how capitalization should work.
<
p> We therefore ignore capitalization as much as possible. Completely mixed case is not possible, but all upper and lower forms are accepted for all long and short forms. Since we have no need to work with the 0.001 case, this practice works here.
<
p> This function translates all the long and short forms that a unit prefix can occur in and translates them into a single multiplier.
| Name | Type | Description |
|---|---|---|
| $units | \$units | The units to compare the size to. |
setValue(
\size $size
)
:
This will be further modified by the multiplier to get an actual size limit.
| Name | Type | Description |
|---|---|---|
| $size | \size | the size to select against expressed in units |
setWhen(
\cmp $cmp
)
:
| Name | Type | Description |
|---|---|---|
| $cmp | \cmp | The comparison to perform, an EnumeratedAttribute |
toString(
)
:
verifySettings(
)
:
Checks to make sure all settings are kosher. In this case, it means that the size attribute has been set (to a positive value), that the multiplier has a valid setting, and that the size limit is valid. Since the latter is a calculated value, this can only fail due to a programming error.
If a problem is detected, the setError() method is called.