phing-types

# Class: FileSet Source Location: /types/FileSet.php
### Class Overview
    ProjectComponent
       |
       --DataType
          |
          --AbstractFileSet
             |
             --FileSet
Moved out of MatchingTask to make it a standalone object that could be referenced (by scripts for example). #### Author(s): Arnout J. Kuiper <ajkuiper@wxs.nl> (Ant) Hans Lellelid <hans@xmpl.org> (Phing) Stefano Mazzocchi <stefano@apache.org> (Ant) Sam Ruby <rubys@us.ibm.com> (Ant) Stefan Bodewig <stefan.bodewig@epost.de> (Ant) Jon S. Stevens <jon@clearink.com> (Ant) Magesh Umasankar (Ant) #### Version: $Revision: 552 $ $Date: 2009-08-29 14:18:13 +0200 (Sat, 29 Aug 2009) $ | ### Methods __construct __clone
### Child classes: TarFileSet This is a FileSet with the option to specify permissions. ZipFileSet This is a FileSet with the to specify permissions. IterableFileSet FileSet adapter to SPL's Iterator. | ### Inherited Variables #### Class: AbstractFileSet AbstractFileSet::$additionalPatterns AbstractFileSet::$defaultPatterns AbstractFileSet::$dir AbstractFileSet::$expandSymbolicLinks AbstractFileSet::$isCaseSensitive AbstractFileSet::$selectors AbstractFileSet::$useDefaultExcludes #### Class: DataType DataType::$checked DataType::$description DataType::$ref #### Class: ProjectComponent ProjectComponent::$project | ### Inherited Methods #### Class: AbstractFileSet AbstractFileSet::__construct() AbstractFileSet::appendSelector() Add a new selector into this container. AbstractFileSet::createAnd() add an "And" selector entry on the selector list AbstractFileSet::createContains() add a contains selector entry on the selector list AbstractFileSet::createContainsRegexp() add a contains selector entry on the selector list AbstractFileSet::createCustom() add an extended selector entry on the selector list AbstractFileSet::createDate() add a selector date entry on the selector list AbstractFileSet::createDepend() add a depends selector entry on the selector list AbstractFileSet::createDepth() add a depth selector entry on the selector list AbstractFileSet::createExclude() add a name entry on the exclude list AbstractFileSet::createExcludesFile() add a name entry on the include files list AbstractFileSet::createFilename() add a selector filename entry on the selector list AbstractFileSet::createInclude() add a name entry on the include list AbstractFileSet::createIncludesFile() add a name entry on the include files list AbstractFileSet::createMajority() add a majority selector entry on the selector list AbstractFileSet::createNone() add a "None" selector entry on the selector list AbstractFileSet::createNot() add a "Not" selector entry on the selector list AbstractFileSet::createOr() add an "Or" selector entry on the selector list AbstractFileSet::createPatternSet() AbstractFileSet::createPresent() add a present selector entry on the selector list AbstractFileSet::createSelector() add a "Select" selector entry on the selector list AbstractFileSet::createSize() add a selector size entry on the selector list AbstractFileSet::createType() add a type selector entry on the selector list AbstractFileSet::getDir() AbstractFileSet::getDirectoryScanner() returns a reference to the dirscanner object belonging to this fileset AbstractFileSet::getRef() Performs the check for circular references and returns the referenced FileSet. AbstractFileSet::getSelectors() Returns the set of selectors as an array. AbstractFileSet::hasPatterns() Indicates whether there are any patterns here. AbstractFileSet::hasSelectors() Indicates whether there are any selectors here. AbstractFileSet::selectorCount() Gives the count of the number of selectors in this container AbstractFileSet::selectorElements() Returns an array for accessing the set of selectors. AbstractFileSet::setCaseSensitive() Sets case sensitivity of the file system AbstractFileSet::setDefaultexcludes() Sets whether default exclusions should be used or not. AbstractFileSet::setDir() AbstractFileSet::setExcludes() Sets the set of exclude patterns. Patterns may be separated by a comma or a space. AbstractFileSet::setExcludesfile() Sets the name of the file containing the includes patterns. AbstractFileSet::setExpandSymbolicLinks() Sets whether to expand/dereference symbolic links, default is false AbstractFileSet::setIncludes() Sets the set of include patterns. Patterns may be separated by a comma or a space. AbstractFileSet::setIncludesfile() Sets the name of the file containing the includes patterns. AbstractFileSet::setRefid() Makes this instance in effect a reference to another PatternSet instance. AbstractFileSet::setupDirectoryScanner() feed dirscanner with infos defined by this fileset #### 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 38] Moved out of MatchingTask to make it a standalone object that could be referenced (by scripts for example). #### Tags:
author: | Arnout J. Kuiper <ajkuiper@wxs.nl> (Ant)
author: | Hans Lellelid <hans@xmpl.org> (Phing)
author: | Stefano Mazzocchi <stefano@apache.org> (Ant)
author: | Sam Ruby <rubys@us.ibm.com> (Ant)
author: | Stefan Bodewig <stefan.bodewig@epost.de> (Ant)
author: | Jon S. Stevens <jon@clearink.com> (Ant)
author: | Magesh Umasankar (Ant)
version: | $Revision: 552 $ $Date: 2009-08-29 14:18:13 +0200 (Sat, 29 Aug 2009) $
[ Top ] ### Class Methods ### constructor __construct [line 40]
`FileSet __construct( [ $fileset = null])`
Overrides AbstractFileSet::__construct() (parent method not documented) #### Parameters:
| $fileset |
[ Top ] ### method __clone [line 48]
`void __clone( )`
Return a FileSet that has the same basedir and same patternsets as this one. #### Tags:
access: | public
[ Top ] Documentation generated on Mon, 19 Oct 2009 10:50:57 +0200 by phpDocumentor 1.4.3