This is a condition that checks to see if a file passes an embedded 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)
package |
phing |
---|
__toString() : string
string
comma separated list of Selectors contained in this one
appendSelector(\FileSelector $selector) : void
circularReference() : \BuildException
createAnd() : \AndSelector
createContains()
createContainsRegexp()
createCustom()
createDate()
createDepend()
createDepth()
createDifferent()
createFilename()
createMajority()
createNone()
createNot()
createOr() : \OrSelector
createPresent()
createReadable()
createSelector() : \SelectSelector
createSize()
createType()
createWritable()
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
evaluate() : true
true
if the file is selected by the embedded selector.
getCheckedRef( $requiredClass, $dataTypeName) : mixed
throws |
---|
mixed
getDescription()
retujrn |
string |
---|---|
getProject() : \Project
getRef(\Project $p) : \FileSet
getSelectors(\Project $p) : array
hasSelectors() : boolean
boolean
Whether any selectors are in this container
isReference() : boolean
boolean
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)
selectorCount() : integer
throws | |
---|---|
integer
The number of selectors in this container
selectorElements() : array
array
The array of selectors
setDescription(string $desc) : void
string
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
tooManyAttributes() : \BuildException
validate()
Ordinarily, this will validate all the elements of a selector container even if the isSelected() method of some elements is never called. This has two effects:
baseDir :
selectorsList :
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