types/selectors/SizeSelector.php
Selector that filters files based on their size.
- Author
- Hans Lellelid
(Phing) - Author
- Bruce Atherton
(Ant) - 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.
- Parent(s)
- \BaseExtendSelector < \ExtendFileSelector < \DataType < \ProjectComponent
- Author
- Hans Lellelid
(Phing) - Author
- Bruce Atherton
(Ant) - Version
- $Id$
Constants
Properties


$byteUnits= 'array("K", "k", "kilo", "KILO",
"Ki", "KI", "ki", "kibi", "KIBI",
"M", "m", "mega", "MEGA",
"Mi", "MI", "mi", "mebi", "MEBI",
"G", "g", "giga", "GIGA",
"Gi", "GI", "gi", "gibi", "GIBI",
"T", "t", "tera", "TERA",
/* You wish! */ "Ti", "TI", "ti", "tebi", "TEBI"
)'
array("K", "k", "kilo", "KILO",
"Ki", "KI", "ki", "kibi", "KIBI",
"M", "m", "mega", "MEGA",
"Mi", "MI", "mi", "mebi", "MEBI",
"G", "g", "giga", "GIGA",
"Gi", "GI", "gi", "gibi", "GIBI",
"T", "t", "tera", "TERA",
/* You wish! */ "Ti", "TI", "ti", "tebi", "TEBI"
)
Details- Type
- n/a


boolean
$checked= 'true'
Are we sure we don't hold circular references?
Inherited from: \DataType::$$checked\BaseSelector::$$checked\BaseExtendSelector::$$checkedSubclasses are responsible for setting this value to false if we'd need to investigate this condition (usually because a child element has been added that is a subclass of DataType).
true
Details- Type
- boolean
- Inherited_from
- \DataType::$$checked
- Inherited_from
- \BaseSelector::$$checked
- Inherited_from
- \BaseExtendSelector::$$checked


$description= 'null'
The descriptin the user has set.
Inherited from: \DataType::$$description\BaseSelector::$$description\BaseExtendSelector::$$descriptionnull
Details- Type
- n/a
- Inherited_from
- \DataType::$$description
- Inherited_from
- \BaseSelector::$$description
- Inherited_from
- \BaseExtendSelector::$$description


$errmsg= 'null'
null
Details- Type
- n/a
- Inherited_from
- \BaseSelector::$$errmsg
- Inherited_from
- \BaseExtendSelector::$$errmsg


$parameters= 'null'
null
Details- Type
- n/a
- Inherited_from
- \BaseExtendSelector::$$parameters


\Project
$project= 'null'
Holds a reference to the project that a project component (a task, a target, etc.) belongs to
A reference to the current project instanceInherited from: \ProjectComponent::$$project\DataType::$$project\BaseSelector::$$project\BaseExtendSelector::$$projectnull
Details- Type
- \Project
- Inherited_from
- \ProjectComponent::$$project
- Inherited_from
- \DataType::$$project
- Inherited_from
- \BaseSelector::$$project
- Inherited_from
- \BaseExtendSelector::$$project


$ref= 'null'
Value to the refid attribute. Type of Reference
Inherited from: \DataType::$$ref\BaseSelector::$$ref\BaseExtendSelector::$$refnull
Details- Type
- n/a
- Inherited_from
- \DataType::$$ref
- Inherited_from
- \BaseSelector::$$ref
- Inherited_from
- \BaseExtendSelector::$$ref


$sizeComparisons= 'array("less", "more", "equal")'
array("less", "more", "equal")
Details- Type
- n/a
Methods


circularReference(
)
:
void
Creates an exception that indicates the user has generated a loop of data types referencing each other.
Inherited from: \DataType::circularReference()\BaseSelector::circularReference()\BaseExtendSelector::circularReference()

dieOnCircularReference(
$stk, $p
)
:
void
Check to see whether any DataType we hold references to is included in the Stack (which holds all DataType instances that directly or indirectly reference this instance, including this instance itself).
Inherited from: \DataType::dieOnCircularReference()\BaseSelector::dieOnCircularReference()\BaseExtendSelector::dieOnCircularReference()If one is included, throw a BuildException created by circularReference
This implementation is appropriate only for a DataType that cannot hold other DataTypes as children.
The general contract of this method is that it shouldn't do anything if checked is true and set it to true on exit.
Name | Type | Description |
---|---|---|
$stk | ||
$p |


getCheckedRef(
$requiredClass, $dataTypeName
)
:
void
Performs the check for circular references and returns the referenced object.
Inherited from: \DataType::getCheckedRef()\BaseSelector::getCheckedRef()\BaseExtendSelector::getCheckedRef()Name | Type | Description |
---|---|---|
$requiredClass | ||
$dataTypeName |


getDescription(
)
:
void
Return the description for the current data type.
Inherited from: \DataType::getDescription()\BaseSelector::getDescription()\BaseExtendSelector::getDescription()

getError(
)
:
\the
Returns any error messages that have been set.
Inherited from: \BaseSelector::getError()\BaseExtendSelector::getError()Type | Description |
---|---|
\the | error condition |


getParameters(
)
:
\the
Allows access to the parameters gathered and set within the <custom> tag.
Inherited from: \BaseExtendSelector::getParameters()Type | Description |
---|---|
\the | set of parameters defined for this selector |


getProject(
)
:
\Project
Returns a reference to current project
Inherited from: \ProjectComponent::getProject()\DataType::getProject()\BaseSelector::getProject()\BaseExtendSelector::getProject()Type | Description |
---|---|
\Project | Reference to current porject object |


isReference(
)
:
void
Has the refid attribute of this element been set?
Inherited from: \DataType::isReference()\BaseSelector::isReference()\BaseExtendSelector::isReference()

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.
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 | the file should be selected or not |


log(
string $msg, integer $level
=
Project::MSG_INFO
)
:
void
Logs a message with the given priority.
Inherited from: \ProjectComponent::log()\DataType::log()\BaseSelector::log()\BaseExtendSelector::log()Name | Type | Description |
---|---|---|
$msg | string | The message to be logged. |
$level | integer | The message's priority at this message should have |


noChildrenAllowed(
)
:
void
Creates an exception that indicates that this XML element must not have child elements if the refid attribute is set.
Inherited from: \DataType::noChildrenAllowed()\BaseSelector::noChildrenAllowed()\BaseExtendSelector::noChildrenAllowed()

parsingComplete(
)
:
void
Template method being called when the data type has been parsed completely.
Inherited from: \DataType::parsingComplete()\BaseSelector::parsingComplete()\BaseExtendSelector::parsingComplete()

setDescription(
$desc
)
:
void
Sets a description of the current data type. It will be useful in commenting what we are doing.
Inherited from: \DataType::setDescription()\BaseSelector::setDescription()\BaseExtendSelector::setDescription()Name | Type | Description |
---|---|---|
$desc |


setError(
\msg $msg
)
:
void
Allows all selectors to indicate a setup error. Note that only the first error message is recorded.
Inherited from: \BaseSelector::setError()\BaseExtendSelector::setError()Name | Type | Description |
---|---|---|
$msg | \msg | The error message any BuildException should throw. |


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.
Name | Type | Description |
---|---|---|
$parameters | \parameters | the complete set of parameters for this selector |


setProject(
\Project $project
)
:
void
References the project to the current component.
Inherited from: \ProjectComponent::setProject()\DataType::setProject()\BaseSelector::setProject()\BaseExtendSelector::setProject()Name | Type | Description |
---|---|---|
$project | \Project | The reference to the current project |


setRefid(
\Reference $r
)
:
void
Set the value of the refid attribute.
Inherited from: \DataType::setRefid()\BaseSelector::setRefid()\BaseExtendSelector::setRefid()Subclasses may need to check whether any other attributes have been set as well or child elements have been created and thus override this method. if they do they must call parent::setRefid()
Name | Type | Description |
---|---|---|
$r | \Reference |


setUnits(
\$units $units
)
:
void
Sets the units to use for the comparison. This is a little complicated because common usage has created standards that play havoc with capitalization rules. Thus, some people will use "K" for indicating 1000's, when the SI standard calls for "k". Others have tried to introduce "K" as a multiple of 1024, but that falls down when you reach "M", since "m" is already defined as 0.001.
<
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
)
:
void
A size selector needs to know what size to base its selecting on.
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
)
:
void
This specifies when the file should be selected, whether it be when the file matches a particular size, when it is smaller, or whether it is larger.
Name | Type | Description |
---|---|---|
$cmp | \cmp | The comparison to perform, an EnumeratedAttribute |


tooManyAttributes(
)
:
void
Creates an exception that indicates that refid has to be the only attribute if it is set.
Inherited from: \DataType::tooManyAttributes()\BaseSelector::tooManyAttributes()\BaseExtendSelector::tooManyAttributes()

validate(
)
:
void
Subclasses can use this to throw the requisite exception in isSelected() in the case of an error condition.
Inherited from: \BaseSelector::validate()\BaseExtendSelector::validate()

verifySettings(
)
:
void
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.