phing-types

# Class: AbstractFileSet Source Location: /types/AbstractFileSet.php
### Class Overview
    ProjectComponent
       |
       --DataType
          |
          --AbstractFileSet
The FileSet class provides methods and properties for accessing and managing filesets. It extends ProjectComponent and thus inherits all methods and properties (not explicitly declared). See ProjectComponent for further detail. #### Author(s): Hans Lellelid <hans@xmpl.org> Andreas Aderhold <andi@binarycloud.com> #### Version: $Revision: 552 $ $Date: 2009-08-29 14:18:13 +0200 (Sat, 29 Aug 2009) $ Implements interfaces: SelectorContainer | ### Variables $additionalPatterns $defaultPatterns $dir $expandSymbolicLinks $isCaseSensitive $selectors $useDefaultExcludes | ### Methods __construct appendSelector createAnd createContains createContainsRegexp createCustom createDate createDepend createDepth createExclude createExcludesFile createFilename createInclude createIncludesFile createMajority createNone createNot createOr createPatternSet createPresent createSelector createSize createType getDir getDirectoryScanner getRef getSelectors hasPatterns hasSelectors selectorCount selectorElements setCaseSensitive setDefaultexcludes setDir setExcludes setExcludesfile setExpandSymbolicLinks setIncludes setIncludesfile setRefid setupDirectoryScanner
### Child classes: DirSet Subclass as hint for supporting tasks that the included directories instead of files should be used. FileSet Moved out of MatchingTask to make it a standalone object that could be referenced (by scripts for example). | ### 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 69] The FileSet class provides methods and properties for accessing and managing filesets. It extends ProjectComponent and thus inherits all methods and properties (not explicitly declared). See ProjectComponent for further detail. TODO: merge this with patternsets: FileSet extends PatternSet !!! requires additional mods to the parsing algo [HL] .... not sure if that really makes so much sense. I think that perhaps they should use common utility class if there really is that much shared functionality #### Tags:
author: | Hans Lellelid <hans@xmpl.org>
author: | Andreas Aderhold <andi@binarycloud.com>
version: | $Revision: 552 $ $Date: 2009-08-29 14:18:13 +0200 (Sat, 29 Aug 2009) $
see: | ProjectComponent
[ Top ] ### Class Variables #### $additionalPatterns = array() [line 89] #### Tags:
access: | public
Type: | mixed
[ Top ] #### $defaultPatterns = [line 87] #### Tags:
access: | public
Type: | PatternSet
[ Top ] #### $dir = [line 90] #### Tags:
access: | public
Type: | mixed
[ Top ] #### $expandSymbolicLinks = false [line 82] Whether to expand/dereference symbolic links, default is false #### Tags:
access: | protected
Type: | boolean
[ Top ] #### $isCaseSensitive = true [line 91] #### Tags:
access: | public
Type: | mixed
[ Top ] #### $selectors = array() [line 92] #### Tags:
access: | public
Type: | mixed
[ Top ] #### $useDefaultExcludes = true [line 76] #### Tags:
access: | public
Type: | boolean
[ Top ] ### Class Methods ### constructor __construct [line 94]
`AbstractFileSet __construct( [ $fileset = null])`
Overridden in child classes as: DirSet::__construct() FileSet::__construct() #### Parameters:
| $fileset |
[ Top ] ### method appendSelector [line 433]
`void appendSelector( $selector)`
Add a new selector into this container. #### Tags:
access: | public
Implementation of: SelectorContainer::appendSelector #### Parameters:
selector | $selector | the new selector to add
[ Top ] ### method createAnd [line 454]
`void createAnd( )`
add an "And" selector entry on the selector list #### Tags:
access: | public
Implementation of: SelectorContainer::createAnd [ Top ] ### method createContains [line 535]
`void createContains( )`
add a contains selector entry on the selector list #### Tags:
access: | public
Implementation of: SelectorContainer::createContains [ Top ] ### method createContainsRegexp [line 544]
`void createContainsRegexp( )`
add a contains selector entry on the selector list #### Tags:
access: | public
[ Top ] ### method createCustom [line 526]
`void createCustom( )`
add an extended selector entry on the selector list #### Tags:
access: | public
Implementation of: SelectorContainer::createCustom [ Top ] ### method createDate [line 499]
`void createDate( )`
add a selector date entry on the selector list #### Tags:
access: | public
Implementation of: SelectorContainer::createDate [ Top ] ### method createDepend [line 571]
`void createDepend( )`
add a depends selector entry on the selector list #### Tags:
access: | public
Implementation of: SelectorContainer::createDepend [ Top ] ### method createDepth [line 562]
`void createDepth( )`
add a depth selector entry on the selector list #### Tags:
access: | public
Implementation of: SelectorContainer::createDepth [ Top ] ### method createExclude [line 185]
`void createExclude( )`
add a name entry on the exclude list [ Top ] ### method createExcludesFile [line 195]
`void createExcludesFile( )`
add a name entry on the include files list [ Top ] ### method createFilename [line 517]
`void createFilename( )`
add a selector filename entry on the selector list #### Tags:
access: | public
Implementation of: SelectorContainer::createFilename [ Top ] ### method createInclude [line 165]
`void createInclude( )`
add a name entry on the include list [ Top ] ### method createIncludesFile [line 175]
`void createIncludesFile( )`
add a name entry on the include files list [ Top ] ### method createMajority [line 490]
`void createMajority( )`
add a majority selector entry on the selector list #### Tags:
access: | public
Implementation of: SelectorContainer::createMajority [ Top ] ### method createNone [line 481]
`void createNone( )`
add a "None" selector entry on the selector list #### Tags:
access: | public
Implementation of: SelectorContainer::createNone [ Top ] ### method createNot [line 472]
`void createNot( )`
add a "Not" selector entry on the selector list #### Tags:
access: | public
Implementation of: SelectorContainer::createNot [ Top ] ### method createOr [line 463]
`void createOr( )`
add an "Or" selector entry on the selector list #### Tags:
access: | public
Implementation of: SelectorContainer::createOr [ Top ] ### method createPatternSet [line 154]
`void createPatternSet( )`
[ Top ] ### method createPresent [line 553]
`void createPresent( )`
add a present selector entry on the selector list #### Tags:
access: | public
Implementation of: SelectorContainer::createPresent [ Top ] ### method createSelector [line 445]
`void createSelector( )`
add a "Select" selector entry on the selector list #### Tags:
access: | public
Implementation of: SelectorContainer::createSelector [ Top ] ### method createSize [line 508]
`void createSize( )`
add a selector size entry on the selector list #### Tags:
access: | public
Implementation of: SelectorContainer::createSize [ Top ] ### method createType [line 580]
`void createType( )`
add a type selector entry on the selector list #### Tags:
access: | public
[ Top ] ### method getDir [line 146]
`void getDir( $p)`
#### Parameters:
Project | $p |
[ Top ] ### method getDirectoryScanner [line 273]
`void getDirectoryScanner( $p)`
returns a reference to the dirscanner object belonging to this fileset #### Parameters:
Project | $p |
[ Top ] ### method getRef [line 327]
`void getRef( $p)`
Performs the check for circular references and returns the referenced FileSet. #### Parameters:
Project | $p |
[ Top ] ### method getSelectors [line 403]
`an getSelectors( $p)`
Returns the set of selectors as an array. #### Tags:
return: | array of selectors in this container
access: | public
Implementation of: SelectorContainer::getSelectors #### Parameters:
Project | $p |
[ Top ] ### method hasPatterns [line 362]
`boolean hasPatterns( )`
Indicates whether there are any patterns here. #### Tags:
return: | Whether any patterns are in this container.
access: | public
[ Top ] ### method hasSelectors [line 350]
`boolean hasSelectors( )`
Indicates whether there are any selectors here. #### Tags:
return: | Whether any selectors are in this container
access: | public
Implementation of: SelectorContainer::hasSelectors [ Top ] ### method selectorCount [line 387]
`int selectorCount( )`
Gives the count of the number of selectors in this container #### Tags:
return: | The number of selectors in this container
access: | public
Implementation of: SelectorContainer::selectorCount [ Top ] ### method selectorElements [line 421]
`array selectorElements( )`
Returns an array for accessing the set of selectors. #### Tags:
return: | The array of selectors
access: | public
Implementation of: SelectorContainer::selectorElements [ Top ] ### method setCaseSensitive [line 268]
`void setCaseSensitive( $isCaseSensitive)`
Sets case sensitivity of the file system #### Parameters:
| $isCaseSensitive |
[ Top ] ### method setDefaultexcludes [line 258]
`void setDefaultexcludes( $useDefaultExcludes $useDefaultExcludes)`
Sets whether default exclusions should be used or not. #### Parameters:
$useDefaultExcludes | $useDefaultExcludes | "true"|"on"|"yes" when default exclusions should be used, "false"|"off"|"no" when they shouldn't be used.
[ Top ] ### method setDir [line 135]
`void setDir( $dir)`
#### Parameters:
| $dir |
[ Top ] ### method setExcludes [line 218]
`void setExcludes( $excludes)`
Sets the set of exclude patterns. Patterns may be separated by a comma or a space. #### Parameters:
| $excludes |
[ Top ] ### method setExcludesfile [line 244]
`void setExcludesfile( $excl $excl)`
Sets the name of the file containing the includes patterns. #### Tags:
throws: | BE
#### Parameters:
$excl | $excl | The file to fetch the exclude patterns from.
[ Top ] ### method setExpandSymbolicLinks [line 110]
`void setExpandSymbolicLinks( $expandSymbolicLinks)`
Sets whether to expand/dereference symbolic links, default is false #### Parameters:
| $expandSymbolicLinks |
[ Top ] ### method setIncludes [line 207]
`void setIncludes( $includes)`
Sets the set of include patterns. Patterns may be separated by a comma or a space. #### Parameters:
| $includes |
[ Top ] ### method setIncludesfile [line 231]
`void setIncludesfile( $incl $incl)`
Sets the name of the file containing the includes patterns. #### Tags:
throws: | BE
#### Parameters:
$incl | $incl | The file to fetch the include patterns from.
[ Top ] ### method setRefid [line 121]
`void setRefid( Reference $r)`
Makes this instance in effect a reference to another PatternSet instance. You must not set another attribute or nest elements inside this element if you make it a reference. Overrides DataType::setRefid() (Set the value of the refid attribute.) #### Parameters:
Reference | $r |
[ Top ] ### method setupDirectoryScanner [line 296]
`void setupDirectoryScanner( $ds, $p)`
feed dirscanner with infos defined by this fileset #### Tags:
access: | protected
#### Parameters:
DirectoryScanner | $ds |
Project | $p |
[ Top ] Documentation generated on Mon, 19 Oct 2009 10:50:14 +0200 by phpDocumentor 1.4.3