phing-types

# Class: PatternSet Source Location: /types/PatternSet.php
### Class Overview
    ProjectComponent
       |
       --DataType
          |
          --PatternSet
The patternset storage component. Carries all necessary data and methods for the patternset stuff. #### Author(s): Andreas Aderhold, andi@binarycloud.com #### Version: $Revision: 557 $ | ### Methods append createExclude createExcludesFile createInclude createIncludesFile getExcludePatterns getIncludePatterns getRef hasPatterns setExcludes setExcludesFile setIncludes setIncludesFile setRefid toString
### 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 33] The patternset storage component. Carries all necessary data and methods for the patternset stuff. #### Tags:
author: | Andreas Aderhold, andi@binarycloud.com
version: | $Revision: 557 $
[ Top ] ### Class Methods ### method append [line 230]
`void append( $other, $p)`
Adds the patterns of the other instance to this set. #### Parameters:
| $other |
| $p |
[ Top ] ### method createExclude [line 87]
`PatternSetNameEntry createExclude( )`
Add a name entry on the exclude list #### Tags:
return: | Reference to object
throws: | BuildException
[ Top ] ### method createExcludesFile [line 100]
`PatternSetNameEntry createExcludesFile( )`
add a name entry on the exclude files list #### Tags:
return: | Reference to object
throws: | BuildException
[ Top ] ### method createInclude [line 60]
`PatternSetNameEntry createInclude( )`
Add a name entry on the include list #### Tags:
return: | Reference to object
throws: | BuildException
[ Top ] ### method createIncludesFile [line 74]
`PatternSetNameEntry createIncludesFile( )`
Add a name entry on the include files list #### Tags:
return: | Reference to object
throws: | BuildException
[ Top ] ### method getExcludePatterns [line 264]
`void getExcludePatterns( $p)`
Returns the filtered exclude patterns. #### Parameters:
Project | $p |
[ Top ] ### method getIncludePatterns [line 253]
`void getIncludePatterns( $p)`
Returns the filtered include patterns. #### Parameters:
Project | $p |
[ Top ] ### method getRef [line 284]
`void getRef( $p)`
Performs the check for circular references and returns the referenced PatternSet. #### Parameters:
Project | $p |
[ Top ] ### method hasPatterns [line 275]
`void hasPatterns( )`
helper for FileSet. [ Top ] ### method setExcludes [line 140]
`void setExcludes( string $excludes)`
Sets the set of exclude patterns. Patterns may be separated by a comma or a space. #### Tags:
throws: | BuildException
#### Parameters:
string | $excludes | the string containing the exclude patterns
[ Top ] ### method setExcludesFile [line 186]
`void setExcludesFile( excludesFile $excludesFile)`
Sets the name of the file containing the excludes patterns. #### Parameters:
excludesFile | $excludesFile | The file to fetch the exclude patterns from.
[ Top ] ### method setIncludes [line 117]
`void setIncludes( string $includes)`
Sets the set of include patterns. Patterns may be separated by a comma or a space. #### Tags:
throws: | BuildException
#### Parameters:
string | $includes | the string containing the include patterns
[ Top ] ### method setIncludesFile [line 170]
`void setIncludesFile( includesFile $includesFile)`
Sets the name of the file containing the includes patterns. #### Parameters:
includesFile | $includesFile | The file to fetch the include patterns from.
[ Top ] ### method setRefid [line 46]
`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 toString [line 349]
`void toString( )`
[ Top ] Documentation generated on Mon, 19 Oct 2009 10:51:24 +0200 by phpDocumentor 1.4.3