types/selectors/PresentSelector.php
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).
- Author
- Hans Lellelid
(Phing) - Author
- Bruce Atherton
(Ant) - Package
- phing.types.selectors
\PresentSelector
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).
This class handles the common description attribute and provides a default implementation for reference handling and checking for circular references that is appropriate for types that can not be nested inside elements of the same type (i.e. patternset but not path)
- Parent(s)
- \BaseSelector < \DataType < \ProjectComponent
- Author
- Hans Lellelid
(Phing) - Author
- Bruce Atherton
(Ant) - Version
- $Id$
Properties


boolean
$checked= 'true'
Are we sure we don't hold circular references?
Inherited from: \DataType::$$checked\BaseSelector::$$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


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


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


$filePresence= 'array("srconly", "both")'
array("srconly", "both")
Details- Type
- n/a


\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::$$projectnull
Details- Type
- \Project
- Inherited_from
- \ProjectComponent::$$project
- Inherited_from
- \DataType::$$project
- Inherited_from
- \BaseSelector::$$project


$ref= 'null'
Value to the refid attribute. Type of Reference
Inherited from: \DataType::$$ref\BaseSelector::$$refnull
Details- Type
- n/a
- Inherited_from
- \DataType::$$ref
- Inherited_from
- \BaseSelector::$$ref
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()

createMapper(
)
:
void
Defines the FileNameMapper to use (nested mapper element).
Exception | Description |
---|---|
\BuildException |


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()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()Name | Type | Description |
---|---|---|
$requiredClass | ||
$dataTypeName |


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

getProject(
)
:
\Project
Returns a reference to current project
Inherited from: \ProjectComponent::getProject()\DataType::getProject()\BaseSelector::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()

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 | 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(
string $msg, integer $level
=
Project::MSG_INFO
)
:
void
Logs a message with the given priority.
Inherited from: \ProjectComponent::log()\DataType::log()\BaseSelector::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()

parsingComplete(
)
:
void
Template method being called when the data type has been parsed completely.
Inherited from: \DataType::parsingComplete()\BaseSelector::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()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()Name | Type | Description |
---|---|---|
$msg | \msg | The error message any BuildException should throw. |


setPresent(
string $fp
)
:
void
This sets whether to select a file if its dest file is present.
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.
Name | Type | Description |
---|---|---|
$fp | string | An attribute set to either |


setProject(
\Project $project
)
:
void
References the project to the current component.
Inherited from: \ProjectComponent::setProject()\DataType::setProject()\BaseSelector::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()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 |


setTargetdir(
\targetdir $targetdir
)
:
void
The name of the file or directory which is checked for matching files.
Name | Type | Description |
---|---|---|
$targetdir | \targetdir | the directory to scan looking for matching files. |


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()

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