Selector that filters files based on whether they appear in another
directory tree.
It can contain a mapper element, so isn't available
as an ExtendSelector (since those parameters can't hold other
elements).
Methods
Creates an exception that indicates the user has generated a
loop of data types referencing each other.
circularReference()
Inherited
inherited_from |
\DataType::circularReference() |
inherited_from |
\BaseSelector::circularReference() |
Defines the FileNameMapper to use (nested mapper element).
createMapper()
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).
dieOnCircularReference($stk, \Project $p)
Inherited
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.
inherited_from |
\DataType::dieOnCircularReference() |
inherited_from |
\BaseSelector::dieOnCircularReference() |
Parameters
$stk
$p
Performs the check for circular references and returns the referenced object.
getCheckedRef($requiredClass, $dataTypeName)
Inherited
inherited_from |
\DataType::getCheckedRef() |
inherited_from |
\BaseSelector::getCheckedRef() |
Parameters
$requiredClass
$dataTypeName
Return the description for the current data type.
getDescription()
Inherited
inherited_from |
\DataType::getDescription() |
inherited_from |
\BaseSelector::getDescription() |
Returns any error messages that have been set.
getError() : \the
Inherited
inherited_from |
\BaseSelector::getError() |
Returns
\the
error condition
Returns a reference to current project
getProject() : \Project
Inherited
inherited_from |
\ProjectComponent::getProject() |
inherited_from |
\DataType::getProject() |
inherited_from |
\BaseSelector::getProject() |
Returns
\Project
Reference to current porject object
Has the refid attribute of this element been set?
isReference()
Inherited
inherited_from |
\DataType::isReference() |
inherited_from |
\BaseSelector::isReference() |
The heart of the matter.
isSelected(\PhingFile $basedir, \filename $filename, \PhingFile $file) : \whether
This is where the selector gets to decide
on the inclusion of a file in a particular fileset.
Parameters
$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
Exceptions
Returns
\whether
the file should be selected or not
Logs a message with the given priority.
log(string $msg, integer $level)
Inherited
inherited_from |
\ProjectComponent::log() |
inherited_from |
\DataType::log() |
inherited_from |
\BaseSelector::log() |
Parameters
$msg
string
The message to be logged.
$level
integer
The message's priority at this message should have
Creates an exception that indicates that this XML element must
not have child elements if the refid attribute is set.
noChildrenAllowed()
Inherited
inherited_from |
\DataType::noChildrenAllowed() |
inherited_from |
\BaseSelector::noChildrenAllowed() |
Template method being called when the data type has been
parsed completely.
parsingComplete() : void
Inherited
inherited_from |
\DataType::parsingComplete() |
inherited_from |
\BaseSelector::parsingComplete() |
Sets a description of the current data type.
setDescription($desc)
Inherited
It will be useful
in commenting what we are doing.
inherited_from |
\DataType::setDescription() |
inherited_from |
\BaseSelector::setDescription() |
Parameters
$desc
Allows all selectors to indicate a setup error.
setError(\msg $msg)
Inherited
Note that only
the first error message is recorded.
inherited_from |
\BaseSelector::setError() |
Parameters
$msg
\msg
The error message any BuildException should throw.
This sets whether to select a file if its dest file is present.
setPresent(string $fp)
It could be a
negate
boolean, but by doing things
this way, we get some documentation on how the system works.
A user looking at the documentation should clearly understand
that the ONLY files whose presence is being tested are those
that already exist in the source directory, hence the lack of
a
destonly
option.
Parameters
$fp
string
An attribute set to either srconly
or both
.
References the project to the current component.
setProject(\Project $project)
Inherited
inherited_from |
\ProjectComponent::setProject() |
inherited_from |
\DataType::setProject() |
inherited_from |
\BaseSelector::setProject() |
Parameters
$project
\Project
The reference to the current project
Set the value of the refid attribute.
setRefid(\Reference $r) : void
Inherited
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()
inherited_from |
\DataType::setRefid() |
inherited_from |
\BaseSelector::setRefid() |
Parameters
The name of the file or directory which is checked for matching
files.
setTargetdir(\PhingFile $targetdir)
Parameters
$targetdir
\targetdir
the directory to scan looking for matching files.
Creates an exception that indicates that refid has to be the
only attribute if it is set.
tooManyAttributes()
Inherited
inherited_from |
\DataType::tooManyAttributes() |
inherited_from |
\BaseSelector::tooManyAttributes() |
Subclasses can use this to throw the requisite exception
in isSelected() in the case of an error condition.
validate()
Inherited
inherited_from |
\BaseSelector::validate() |
Checks to make sure all settings are kosher.
verifySettings()
In this case, it
means that the targetdir attribute has been set and we have a mapper.
Properties
$description
Inherited
inherited_from |
\DataType::$$description |
inherited_from |
\BaseSelector::$$description |
$ref
Inherited
inherited_from |
\DataType::$$ref |
inherited_from |
\BaseSelector::$$ref |
$checked : boolean
Inherited
Subclasses 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).
inherited_from |
\DataType::$$checked |
inherited_from |
\BaseSelector::$$checked |
$project : \Project
Inherited
inherited_from |
\ProjectComponent::$$project |
inherited_from |
\DataType::$$project |
inherited_from |
\BaseSelector::$$project |
$errmsg
Inherited
inherited_from |
\BaseSelector::$$errmsg |