# types/FileSet.php

Moved out of MatchingTask to make it a standalone object that could be referenced (by scripts for example).

Author
  Hans Lellelid (Phing)
Author
  Arnout J. Kuiper (Ant)
Author
  Stefano Mazzocchi (Ant)
Author
  Sam Ruby (Ant)
Author
  Jon S. Stevens (Ant)
Author
  Stefan Bodewig (Ant)
Author
  Magesh Umasankar (Ant)
Package
  phing.types

## \FileSet
jump to top

Package: phing\types

Moved out of MatchingTask to make it a standalone object that could be referenced (by scripts for example).

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

Parent(s)
  \AbstractFileSet < \DataType < \ProjectComponent
Children
  \ZendGuardFileSet
  \TarFileSet
  \ZipFileSet
  \PearPackageFileSet
Author
  Hans Lellelid (Phing)
Author
  Arnout J. Kuiper (Ant)
Author
  Stefano Mazzocchi (Ant)
Author
  Sam Ruby (Ant)
Author
  Jon S. Stevens (Ant)
Author
  Stefan Bodewig (Ant)
Author
  Magesh Umasankar (Ant)
Version
  $Revision: 744 $ $Date: 2010-03-09 11:08:31 +0100 (Tue, 09 Mar 2010) $

### Properties

`$additionalPatterns= 'array()'`
inherited Inherited from: \AbstractFileSet::$additionalPatterns
Default value `array()`Details

Type
Inherited_from
  \AbstractFileSet::$additionalPatterns

`boolean $checked= 'true'`
inherited

Are we sure we don't hold circular references?

Inherited from: \DataType::$checked

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

Default value `true` Details

Type
  boolean
Inherited_from
  \DataType::$checked

`\PatternSet $defaultPatterns= ''`
inherited

Inherited from: \AbstractFileSet::$defaultPatterns
Details

Type
  \PatternSet
Inherited_from
  \AbstractFileSet::$defaultPatterns

`$description= 'null'`
inherited

The descriptin the user has set.

Inherited from: \DataType::$description
Default value `null` Details

Type
Inherited_from
  \DataType::$description

`$dir= ''`
inherited Inherited from: \AbstractFileSet::$dir
Details

Type
Inherited_from
  \AbstractFileSet::$dir

`boolean $expandSymbolicLinks= 'false'`
inherited

Whether to expand/dereference symbolic links, default is false

Inherited from: \AbstractFileSet::$expandSymbolicLinks
Default value `false` Details

Type
  boolean
Inherited_from
  \AbstractFileSet::$expandSymbolicLinks

`$isCaseSensitive= 'true'`
inherited Inherited from: \AbstractFileSet::$isCaseSensitive
Default value `true` Details

Type
Inherited_from
  \AbstractFileSet::$isCaseSensitive

`\Project $project= 'null'`
inherited

Holds a reference to the project that a project component (a task, a target, etc.) belongs to

A reference to the current project instanceInherited from: \ProjectComponent::$project
Default value `null` Details

Type
  \Project
Inherited_from
  \ProjectComponent::$project

`$ref= 'null'`
inherited

Value to the refid attribute. Type of Reference

Inherited from: \DataType::$ref
Default value `null` Details

Type
Inherited_from
  \DataType::$ref

`$selectors= 'array()'`
inherited Inherited from: \AbstractFileSet::$selectors
Default value `array()`Details

Type
Inherited_from
  \AbstractFileSet::$selectors

`boolean $useDefaultExcludes= 'true'`
inherited

Inherited from: \AbstractFileSet::$useDefaultExcludes
Default value `true` Details

Type
  boolean
Inherited_from
  \AbstractFileSet::$useDefaultExcludes

### Methods

`__clone( ) : void`

Return a FileSet that has the same basedir and same patternsets as this one.

`__construct( $fileset = null ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$fileset |  |

`appendSelector( \selector $selector ) : \the`
inherited

Add a new selector into this container.

Inherited from: \AbstractFileSet::appendSelector()
Parameters

Name | Type | Description
--- | --- | ---
$selector | \selector | the new selector to add

Returns

Type | Description
--- | ---
\the | selector that was added

`circularReference( ) : void`
inherited

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

Inherited from: \DataType::circularReference()
`createAnd( ) : void`
inherited

add an "And" selector entry on the selector list

Inherited from: \AbstractFileSet::createAnd()
`createContains( ) : void`
inherited

add a contains selector entry on the selector list

Inherited from: \AbstractFileSet::createContains()
`createContainsRegexp( ) : void`
inherited

add a contains selector entry on the selector list

Inherited from: \AbstractFileSet::createContainsRegexp()
`createCustom( ) : void`
inherited

add an extended selector entry on the selector list

Inherited from: \AbstractFileSet::createCustom()
`createDate( ) : void`
inherited

add a selector date entry on the selector list

Inherited from: \AbstractFileSet::createDate()
`createDepend( ) : void`
inherited

add a depends selector entry on the selector list

Inherited from: \AbstractFileSet::createDepend()
`createDepth( ) : void`
inherited

add a depth selector entry on the selector list

Inherited from: \AbstractFileSet::createDepth()
`createExclude( ) : void`
inherited

add a name entry on the exclude list

Inherited from: \AbstractFileSet::createExclude()
`createExcludesFile( ) : void`
inherited

add a name entry on the include files list

Inherited from: \AbstractFileSet::createExcludesFile()
`createFilename( ) : void`
inherited

add a selector filename entry on the selector list

Inherited from: \AbstractFileSet::createFilename()
`createInclude( ) : void`
inherited

add a name entry on the include list

Inherited from: \AbstractFileSet::createInclude()
`createIncludesFile( ) : void`
inherited

add a name entry on the include files list

Inherited from: \AbstractFileSet::createIncludesFile()
`createMajority( ) : void`
inherited

add a majority selector entry on the selector list

Inherited from: \AbstractFileSet::createMajority()
`createNone( ) : void`
inherited

add a "None" selector entry on the selector list

Inherited from: \AbstractFileSet::createNone()
`createNot( ) : void`
inherited

add a "Not" selector entry on the selector list

Inherited from: \AbstractFileSet::createNot()
`createOr( ) : void`
inherited

add an "Or" selector entry on the selector list

Inherited from: \AbstractFileSet::createOr()
`createPatternSet( ) : void`
inherited

Inherited from: \AbstractFileSet::createPatternSet()
`createPresent( ) : void`
inherited

add a present selector entry on the selector list

Inherited from: \AbstractFileSet::createPresent()
`createSelector( ) : void`
inherited

add a "Select" selector entry on the selector list

Inherited from: \AbstractFileSet::createSelector()
`createSize( ) : void`
inherited

add a selector size entry on the selector list

Inherited from: \AbstractFileSet::createSize()
`createType( ) : void`
inherited

add a type selector entry on the selector list

Inherited from: \AbstractFileSet::createType()
`dieOnCircularReference( $stk, $p ) : void`
inherited

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

Inherited from: \DataType::dieOnCircularReference()

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.

Parameters

Name | Type | Description
--- | --- | ---
$stk |  |
$p |  |

`getCheckedRef( $requiredClass, $dataTypeName ) : void`
inherited

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

Inherited from: \DataType::getCheckedRef()
Parameters

Name | Type | Description
--- | --- | ---
$requiredClass |  |
$dataTypeName |  |

`getDescription( ) : void`
inherited

Return the description for the current data type.

Inherited from: \DataType::getDescription()
`getDir( $p ) : void`
inherited

Inherited from: \AbstractFileSet::getDir()
Parameters

Name | Type | Description
--- | --- | ---
$p |  |

`getDirectoryScanner( $p ) : void`
inherited

returns a reference to the dirscanner object belonging to this fileset

Inherited from: \AbstractFileSet::getDirectoryScanner()
Parameters

Name | Type | Description
--- | --- | ---
$p |  |

`getProject( ) : \Project`
inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()
Returns

Type | Description
--- | ---
\Project | Reference to current porject object

`getRef( $p ) : void`
inherited

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

Inherited from: \AbstractFileSet::getRef()
Parameters

Name | Type | Description
--- | --- | ---
$p |  |

`getSelectors( $p ) : \an`
inherited

Returns the set of selectors as an array.

Inherited from: \AbstractFileSet::getSelectors()
Parameters

Name | Type | Description
--- | --- | ---
$p |  |

Returns

Type | Description
--- | ---
\an | array of selectors in this container

`hasPatterns( ) : boolean`
inherited

Indicates whether there are any patterns here.

Inherited from: \AbstractFileSet::hasPatterns()
Returns

Type | Description
--- | ---
boolean | Whether any patterns are in this container.

`hasSelectors( ) : boolean`
inherited

Indicates whether there are any selectors here.

Inherited from: \AbstractFileSet::hasSelectors()
Returns

Type | Description
--- | ---
boolean | Whether any selectors are in this container

`isReference( ) : void`
inherited

Has the refid attribute of this element been set?

Inherited from: \DataType::isReference()
`log( $msg, integer $level = Project::MSG_INFO ) : void`
inherited

Logs a message with the given priority.

Inherited from: \ProjectComponent::log()

@param string $msg The message to be logged.

Parameters

Name | Type | Description
--- | --- | ---
$msg |  |
$level | integer | The message's priority at this message should have

`noChildrenAllowed( ) : void`
inherited

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

Inherited from: \DataType::noChildrenAllowed()
`parsingComplete( ) : void`
inherited

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

Inherited from: \DataType::parsingComplete()
`selectorCount( ) : int`
inherited

Gives the count of the number of selectors in this container

Inherited from: \AbstractFileSet::selectorCount()
Returns

Type | Description
--- | ---
int | The number of selectors in this container

`selectorElements( ) : array`
inherited

Returns an array for accessing the set of selectors.

Inherited from: \AbstractFileSet::selectorElements()
Returns

Type | Description
--- | ---
array | The array of selectors

`setCaseSensitive( $isCaseSensitive ) : void`
inherited

Sets case sensitivity of the file system

Inherited from: \AbstractFileSet::setCaseSensitive()
Parameters

Name | Type | Description
--- | --- | ---
$isCaseSensitive |  |

`setDefaultexcludes( \$useDefaultExcludes $useDefaultExcludes ) : void`
inherited

Sets whether default exclusions should be used or not.

Inherited from: \AbstractFileSet::setDefaultexcludes()
Parameters

Name | Type | Description
--- | --- | ---
$useDefaultExcludes | \$useDefaultExcludes | "true"|"on"|"yes" when default exclusions should be used, "false"|"off"|"no" when they shouldn't be used.

`setDescription( $desc ) : void`
inherited

Sets a description of the current data type. It will be useful in commenting what we are doing.

Inherited from: \DataType::setDescription()
Parameters

Name | Type | Description
--- | --- | ---
$desc |  |

`setDir( $dir ) : void`
inherited

Inherited from: \AbstractFileSet::setDir()
Parameters

Name | Type | Description
--- | --- | ---
$dir |  |

`setExcludes( $excludes ) : void`
inherited

Sets the set of exclude patterns. Patterns may be separated by a comma or a space.

Inherited from: \AbstractFileSet::setExcludes()
Parameters

Name | Type | Description
--- | --- | ---
$excludes |  |

`setExcludesfile( \$excl $excl ) : void`
inherited

Sets the name of the file containing the includes patterns.

Inherited from: \AbstractFileSet::setExcludesfile()
Parameters

Name | Type | Description
--- | --- | ---
$excl | \$excl | The file to fetch the exclude patterns from.

Throws

Exception | Description
--- | ---
\BE |

`setExpandSymbolicLinks( $expandSymbolicLinks ) : void`
inherited

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

Inherited from: \AbstractFileSet::setExpandSymbolicLinks()
Parameters

Name | Type | Description
--- | --- | ---
$expandSymbolicLinks |  |

Details

  boolean

`setIncludes( $includes ) : void`
inherited

Sets the set of include patterns. Patterns may be separated by a comma or a space.

Inherited from: \AbstractFileSet::setIncludes()
Parameters

Name | Type | Description
--- | --- | ---
$includes |  |

`setIncludesfile( \$incl $incl ) : void`
inherited

Sets the name of the file containing the includes patterns.

Inherited from: \AbstractFileSet::setIncludesfile()
Parameters

Name | Type | Description
--- | --- | ---
$incl | \$incl | The file to fetch the include patterns from.

Throws

Exception | Description
--- | ---
\BE |

`setProject( \Project $project ) : void`
inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()
Parameters

Name | Type | Description
--- | --- | ---
$project | \Project | The reference to the current project

`setRefid( \Reference $r ) : void`
inherited

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

Inherited from: \AbstractFileSet::setRefid()

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

Parameters

Name | Type | Description
--- | --- | ---
$r | \Reference |

`setupDirectoryScanner( $ds, $p ) : void`
inherited

feed dirscanner with infos defined by this fileset

Inherited from: \AbstractFileSet::setupDirectoryScanner()
Parameters

Name | Type | Description
--- | --- | ---
$ds |  |
$p |  |

`tooManyAttributes( ) : void`
inherited

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

Inherited from: \DataType::tooManyAttributes()
Documentation was generated by DocBlox 0.15.1.