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

author | Andreas Aderhold
author | Hans Lellelid
version | $Id$
see | \global\ProjectComponent
package | phing.types

### Methods

## __construct()

    __construct($fileset)

### Parameters

#### $fileset

## Add a new selector into this container.

    appendSelector(\FileSelector $selector) : \the

### Parameters

#### $selector

`\selector`

the new selector to add

### Returns

`\the`selector that was added

## Creates an exception that indicates the user has generated a loop of data types referencing each other.

    circularReference()

Inherited

inherited_from | \DataType::circularReference()

## add an "And" selector entry on the selector list

    createAnd()

## add a contains selector entry on the selector list

    createContains()

## add a contains selector entry on the selector list

    createContainsRegexp()

## add an extended selector entry on the selector list

    createCustom()

## add a selector date entry on the selector list

    createDate()

## add a depends selector entry on the selector list

    createDepend()

## add a depth selector entry on the selector list

    createDepth()

## add a name entry on the exclude list

    createExclude()

## add a name entry on the include files list

    createExcludesFile()

## add a selector filename entry on the selector list

    createFilename()

## add a name entry on the include list

    createInclude()

## add a name entry on the include files list

    createIncludesFile()

## add a majority selector entry on the selector list

    createMajority()

## add a "None" selector entry on the selector list

    createNone()

## add a "Not" selector entry on the selector list

    createNot()

## add an "Or" selector entry on the selector list

    createOr()

## createPatternSet()

    createPatternSet()

## add a present selector entry on the selector list

    createPresent()

## add a "Select" selector entry on the selector list

    createSelector()

## add a selector size entry on the selector list

    createSize()

## add a type selector entry on the selector list

    createType()

## 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).

    dieOnCircularReference($stk, \Project $p)

Inherited

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.

inherited_from | \DataType::dieOnCircularReference()

### Parameters

#### $stk

#### $p

## Performs the check for circular references and returns the referenced object.

    getCheckedRef($requiredClass, $dataTypeName)

Inherited

inherited_from | \DataType::getCheckedRef()

### Parameters

#### $requiredClass

#### $dataTypeName

## Return the description for the current data type.

    getDescription()

Inherited

inherited_from | \DataType::getDescription()

## getDir()

    getDir(\Project $p)

### Parameters

#### $p

## returns a reference to the dirscanner object belonging to this fileset

    getDirectoryScanner(\Project $p)

### Parameters

#### $p

## Returns a reference to current project

    getProject() : \Project

Inherited

inherited_from | \ProjectComponent::getProject()
inherited_from | \DataType::getProject()

### Returns

`\Project`Reference to current porject object

## Performs the check for circular references and returns the referenced FileSet.

    getRef(\Project $p)

### Parameters

#### $p

## Returns the set of selectors as an array.

    getSelectors(\Project $p) : \an

### Parameters

#### $p

### Returns

`\an`array of selectors in this container

## Indicates whether there are any patterns here.

    hasPatterns() : boolean

### Returns

`boolean`Whether any patterns are in this container.

## Indicates whether there are any selectors here.

    hasSelectors() : boolean

### Returns

`boolean`Whether any selectors are in this container

## Has the refid attribute of this element been set?

    isReference()

Inherited

inherited_from | \DataType::isReference()

## Logs a message with the given priority.

    log(string $msg, integer $level)

Inherited

inherited_from | \ProjectComponent::log()
inherited_from | \DataType::log()

### Parameters

#### $msg

`string`

The message to be logged.

#### $level

`integer`

The message's priority at this message should have

## Creates an exception that indicates that this XML element must not have child elements if the refid attribute is set.

    noChildrenAllowed()

Inherited

inherited_from | \DataType::noChildrenAllowed()

## Template method being called when the data type has been parsed completely.

    parsingComplete() : void

Inherited

inherited_from | \DataType::parsingComplete()

## Gives the count of the number of selectors in this container

    selectorCount() : int

### Returns

`int`The number of selectors in this container

## Returns an array for accessing the set of selectors.

    selectorElements() : array

### Returns

`array`The array of selectors

## Sets case sensitivity of the file system

    setCaseSensitive($isCaseSensitive)

### Parameters

#### $isCaseSensitive

## Sets whether default exclusions should be used or not.

    setDefaultexcludes($useDefaultExcludes)

### Parameters

#### $useDefaultExcludes

"true"|"on"|"yes" when default exclusions should be used, "false"|"off"|"no" when they shouldn't be used.

## Sets a description of the current data type.

    setDescription($desc)

Inherited

It will be useful in commenting what we are doing.

inherited_from | \DataType::setDescription()

### Parameters

#### $desc

## setDir()

    setDir($dir)

### Parameters

#### $dir

## Sets the set of exclude patterns.

    setExcludes($excludes)

Patterns may be separated by a comma or a space.

### Parameters

#### $excludes

## Sets the name of the file containing the includes patterns.

    setExcludesfile($excl)

### Parameters

#### $excl

The file to fetch the exclude patterns from.

### Exceptions

`\BE` |

## Sets whether to expand/dereference symbolic links, default is false

    setExpandSymbolicLinks($expandSymbolicLinks)

var |

### Parameters

#### $expandSymbolicLinks

## Sets the set of include patterns.

    setIncludes($includes)

Patterns may be separated by a comma or a space.

### Parameters

#### $includes

## Sets the name of the file containing the includes patterns.

    setIncludesfile($incl)

### Parameters

#### $incl

The file to fetch the include patterns from.

### Exceptions

`\BE` |

## References the project to the current component.

    setProject(\Project $project)

Inherited

inherited_from | \ProjectComponent::setProject()
inherited_from | \DataType::setProject()

### Parameters

#### $project

`\Project`

The reference to the current project

## Makes this instance in effect a reference to another PatternSet instance.

    setRefid(\Reference $r) : void

You must not set another attribute or nest elements inside this element if you make it a reference.

### Parameters

#### $r

`\Reference`

## Creates an exception that indicates that refid has to be the only attribute if it is set.

    tooManyAttributes()

Inherited

inherited_from | \DataType::tooManyAttributes()

## feed dirscanner with infos defined by this fileset

    setupDirectoryScanner(\DirectoryScanner $ds, \Project $p)

### Parameters

#### $ds

#### $p

### Properties

##

    $additionalPatterns

##

    $defaultPatterns : \PatternSet

##

    $description

Inherited

inherited_from | \DataType::$$description

##

    $dir

##

    $isCaseSensitive

##

    $ref

Inherited

Type of Reference

inherited_from | \DataType::$$ref

##

    $selectors

##

    $useDefaultExcludes : boolean

##

    $checked : boolean

Inherited

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).

inherited_from | \DataType::$$checked

##

    $expandSymbolicLinks : boolean

##

    $project : \Project

Inherited

inherited_from | \ProjectComponent::$$project
inherited_from | \DataType::$$project