FileList represents an explicitly named list of files.
FileLists
are useful when you want to capture a list of files regardless of
whether they currently exist.
OR
(or a mixture of files="" and listfile="" can be used)
Methods
Construct a new FileList.
__construct($filelist)
Creates an exception that indicates the user has generated a
loop of data types referencing each other.
circularReference()
Inherited
| inherited_from |
\DataType::circularReference() |
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() |
Parameters
$stk
$p
Performs the check for circular references and returns the referenced object.
getCheckedRef($requiredClass, $dataTypeName)
Inherited
| inherited_from |
\DataType::getCheckedRef() |
Parameters
$requiredClass
$dataTypeName
Return the description for the current data type.
getDescription()
Inherited
| inherited_from |
\DataType::getDescription() |
Get the basedir for files in list.
getDir(\Project $p) : \PhingFile
Returns the list of files represented by this FileList.
getFiles(\Project $p) : array
Get the source "list" file that contains file names.
getListFile(\Project $p) : \PhingFile
Returns a reference to current project
getProject() : \Project
Inherited
| inherited_from |
\ProjectComponent::getProject() |
| inherited_from |
\DataType::getProject() |
Returns
\ProjectReference to current porject object
Performs the check for circular references and returns the
referenced FileSet.
getRef(\Project $p)
Has the refid attribute of this element been set?
isReference()
Inherited
| inherited_from |
\DataType::isReference() |
Logs a message with the given priority.
log(string $msg, integer $level)
Inherited
| inherited_from |
\ProjectComponent::log() |
| inherited_from |
\DataType::log() |
Parameters
$msg
stringThe message to be logged.
$level
integerThe 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() |
Template method being called when the data type has been
parsed completely.
parsingComplete() : void
Inherited
| inherited_from |
\DataType::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() |
Parameters
$desc
Base directory for files in list.
setDir(\PhingFile $dir)
Set the array of files in list.
setFiles(array $filenames)
Parameters
$filenames
array
Sets a source "list" file that contains filenames to add -- one per line.
setListFile(string $file)
References the project to the current component.
setProject(\Project $project)
Inherited
| inherited_from |
\ProjectComponent::setProject() |
| inherited_from |
\DataType::setProject() |
Parameters
$project
\ProjectThe reference to the current project
Makes this instance in effect a reference to another FileList
instance.
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()
Parameters
Creates an exception that indicates that refid has to be the
only attribute if it is set.
tooManyAttributes()
Inherited
| inherited_from |
\DataType::tooManyAttributes() |
Reads file names from a file and adds them to the files array.
readListFile(\Project $p)
Properties
$description
Inherited
| inherited_from |
\DataType::$$description |
$ref
Inherited
| inherited_from |
\DataType::$$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 |
$project : \Project
Inherited
| inherited_from |
\ProjectComponent::$$project |
| inherited_from |
\DataType::$$project |