phing-types

# Class: FileList Source Location: /types/FileList.php
### Class Overview
    ProjectComponent
       |
       --DataType
          |
          --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. #### Author(s): Hans Lellelid <hans@xmpl.org> #### Version: $Revision: 526 $ | ### Variables $dir $filenames $listfile | ### Methods __construct getDir getFiles getListFile getRef setDir setFiles setListFile setRefid
### Inherited Variables #### Class: DataType DataType::$checked DataType::$description DataType::$ref #### Class: ProjectComponent ProjectComponent::$project | ### Inherited Methods #### Class: DataType DataType::circularReference() Creates an exception that indicates the user has generated a loop of data types referencing each other. DataType::dieOnCircularReference() 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). DataType::getCheckedRef() Performs the check for circular references and returns the referenced object. DataType::getDescription() Return the description for the current data type. DataType::isReference() Has the refid attribute of this element been set? DataType::noChildrenAllowed() Creates an exception that indicates that this XML element must not have child elements if the refid attribute is set. DataType::parsingComplete() Template method being called when the data type has been parsed completely. DataType::setDescription() Sets a description of the current data type. It will be useful in commenting what we are doing. DataType::setRefid() Set the value of the refid attribute. DataType::tooManyAttributes() Creates an exception that indicates that refid has to be the only attribute if it is set. #### Class: ProjectComponent ProjectComponent::getProject() Returns a reference to current project ProjectComponent::log() Logs a message with the given priority. ProjectComponent::setProject() References the project to the current component.
### Class Details [line 47] 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. <filelist id="docfiles" dir="${phing.docs.dir}" files="chapters/Installation.html,chapters/Setup.html"/> OR <filelist dir="${doc.src.dir}" listfile="${phing.docs.dir}/PhingGuide.book"/> (or a mixture of files="" and listfile="" can be used) #### Tags:
author: | Hans Lellelid <hans@xmpl.org>
version: | $Revision: 526 $
[ Top ] ### Class Variables #### $dir = [line 55] Base directory for this file list. #### Tags:
access: | public
Type: | mixed
[ Top ] #### $filenames = array() [line 52] Array containing all filenames. #### Tags:
access: | public
Type: | mixed
[ Top ] #### $listfile = [line 58] PhingFile that contains a list of files (one per line). #### Tags:
access: | public
Type: | mixed
[ Top ] ### Class Methods ### constructor __construct [line 64]
`FileList __construct( [ $filelist = null], array $filelist;)`
Construct a new FileList. #### Parameters:
array | $filelist; |
| $filelist |
[ Top ] ### method getDir [line 101]
`PhingFile getDir( $p)`
Get the basedir for files in list. #### Parameters:
Project | $p |
[ Top ] ### method getFiles [line 161]
`array getFiles( $p)`
Returns the list of files represented by this FileList. #### Parameters:
Project | $p |
[ Top ] ### method getListFile [line 148]
`PhingFile getListFile( $p)`
Get the source "list" file that contains file names. #### Parameters:
Project | $p |
[ Top ] ### method getRef [line 182]
`void getRef( $p)`
Performs the check for circular references and returns the referenced FileSet. #### Parameters:
Project | $p |
[ Top ] ### method setDir [line 87]
`void setDir( $dir)`
Base directory for files in list. #### Parameters:
PhingFile | $dir |
[ Top ] ### method setFiles [line 113]
`void setFiles( array $filenames)`
Set the array of files in list. #### Parameters:
array | $filenames |
[ Top ] ### method setListFile [line 133]
`void setListFile( string $file)`
Sets a source "list" file that contains filenames to add -- one per line. #### Parameters:
string | $file |
[ Top ] ### method setRefid [line 76]
`void setRefid( Reference $r)`
Makes this instance in effect a reference to another FileList instance. Overrides DataType::setRefid() (Set the value of the refid attribute.) #### Parameters:
Reference | $r |
[ Top ] Documentation generated on Mon, 19 Oct 2009 10:50:54 +0200 by phpDocumentor 1.4.3