A mapping selector is an abstract class adding mapping support to the base selector
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)
author |
Siad Ardroumli siad.ardroumli@gmail.com |
---|---|
package |
phing.types.selectors |
addConfigured(\FileNameMapper $fileNameMapper)
throws |
if more than one mapper defined |
---|---|
circularReference() : \BuildException
createMapper() : \a
throws |
if more than one mapper defined |
---|---|
\a
mapper to be configured
dieOnCircularReference( &$stk, \Project $p) : void
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.
throws |
---|
\Project
getCheckedRef( $requiredClass, $dataTypeName) : mixed
throws |
---|
mixed
getDescription()
retujrn |
string |
---|---|
getError() : string
string
the error condition
getProject() : \Project
isReference() : boolean
boolean
isSelected(\PhingFile $basedir, string $filename, \PhingFile $file) : boolean
throws |
---|
string
is the name of the file to check
boolean
whether the file should be selected or not
log(string $msg, integer $level = \Project::MSG_INFO) : void
string
The message to be logged.
integer
The message's priority at this message should have
noChildrenAllowed() : \BuildException
parsingComplete() : void
{@inheritdoc}
pushAndInvokeCircularReferenceCheck(\DataType $dt, &$stk, \Project $p)
selectionTest(\PhingFile $srcfile, \PhingFile $destfile) : true
true
if source file compares with destination file
setDescription(string $desc) : void
string
setError(string $msg) : void
string
The error message any BuildException should throw.
setProject(\Project $project) : void
setRefid(\Reference $r) : void
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()
\Reference
setTargetdir(\PhingFile $targetdir)
tooManyAttributes() : \BuildException
validate()
throws | |
---|---|
verifySettings()
errmsg : string
var |
---|
string
description : string
var |
---|
string
checked : boolean
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).
var |
---|
boolean
project : \Project