types/FileList.php
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)
- Author
- Hans Lellelid
- Package
- phing.types
- Version
- $Id$
\FileList
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)
- Parent(s)
- \DataType < \ProjectComponent
- Author
- Hans Lellelid
- Version
- $Id$
Properties


boolean
$checked= 'true'
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).
true
Details- Type
- boolean
- Inherited_from
- \DataType::$$checked


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


__construct(
$filelist
=
null
)
:
void
Construct a new FileList.
Name | Type | Description |
---|---|---|
$filelist |


circularReference(
)
:
void
Creates an exception that indicates the user has generated a loop of data types referencing each other.
Inherited from: \DataType::circularReference()

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


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

getDir(
$p
)
:
\PhingFile
Get the basedir for files in list.
Name | Type | Description |
---|---|---|
$p |
Type | Description |
---|---|
\PhingFile |


getFiles(
\Project $p
)
:
array
Returns the list of files represented by this FileList.
Name | Type | Description |
---|---|---|
$p | \Project |
Type | Description |
---|---|
array |


getListFile(
\Project $p
)
:
\PhingFile
Get the source "list" file that contains file names.
Name | Type | Description |
---|---|---|
$p | \Project |
Type | Description |
---|---|
\PhingFile |


getProject(
)
:
\Project
Returns a reference to current project
Inherited from: \ProjectComponent::getProject()\DataType::getProject()Type | Description |
---|---|
\Project | Reference to current porject object |


getRef(
\Project $p
)
:
void
Performs the check for circular references and returns the referenced FileSet.
Name | Type | Description |
---|---|---|
$p | \Project |


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

parsingComplete(
)
:
void
Template method being called when the data type has been parsed completely.
Inherited from: \DataType::parsingComplete()

readListFile(
\Project $p
)
:
void
Reads file names from a file and adds them to the files array.
Name | Type | Description |
---|---|---|
$p | \Project |


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


setDir(
\PhingFile $dir
)
:
void
Base directory for files in list.
Name | Type | Description |
---|---|---|
$dir | \PhingFile |


setFiles(
array $filenames
)
:
void
Set the array of files in list.
Name | Type | Description |
---|---|---|
$filenames | array |


setListFile(
string $file
)
:
void
Sets a source "list" file that contains filenames to add -- one per line.
Name | Type | Description |
---|---|---|
$file | string |


setProject(
\Project $project
)
:
void
References the project to the current component.
Inherited from: \ProjectComponent::setProject()\DataType::setProject()Name | Type | Description |
---|---|---|
$project | \Project | The reference to the current project |


setRefid(
\Reference $r
)
:
void
Makes this instance in effect a reference to another FileList instance.
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 |


tooManyAttributes(
)
:
void
Creates an exception that indicates that refid has to be the only attribute if it is set.
Inherited from: \DataType::tooManyAttributes()