types/AbstractFileSet.php

Show: inherited
Table of Contents

\AbstractFileSet

Package: phing\types

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

Parent(s)
\DataType < \ProjectComponent
Children
\DirSet
\FileSet
See
\ProjectComponent  
Author
Andreas Aderhold  
Author
Hans Lellelid  
Version
$Id$  

Properties

Propertypublic  $additionalPatterns= 'array()'
Default valuearray()Details
Type
n/a
Propertyprotectedboolean  $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 valuetrueDetails
Type
boolean
Inherited_from
\DataType::$$checked  
Propertypublic\PatternSet  $defaultPatterns= ''

Details
Type
\PatternSet
Propertypublic  $description= 'null'
inherited

The descriptin the user has set.

Inherited from: \DataType::$$description
Default valuenullDetails
Type
n/a
Inherited_from
\DataType::$$description  
Propertypublic  $dir= ''
Details
Type
n/a
Propertyprotectedboolean  $expandSymbolicLinks= 'false'

Whether to expand/dereference symbolic links, default is false

Default valuefalseDetails
Type
boolean
Propertypublic  $isCaseSensitive= 'true'
Default valuetrueDetails
Type
n/a
Propertyprotected\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\DataType::$$project
Default valuenullDetails
Type
\Project
Inherited_from
\ProjectComponent::$$project  
Inherited_from
\DataType::$$project  
Propertypublic  $ref= 'null'
inherited

Value to the refid attribute. Type of Reference

Inherited from: \DataType::$$ref
Default valuenullDetails
Type
n/a
Inherited_from
\DataType::$$ref  
Propertypublic  $selectors= 'array()'
Default valuearray()Details
Type
n/a
Propertypublicboolean  $useDefaultExcludes= 'true'

Default valuetrueDetails
Type
boolean

Methods

methodpublic__construct(  $fileset = null ) : void

Parameters
Name Type Description
$fileset
methodpublicappendSelector( \selector $selector ) : void

Add a new selector into this container.

Parameters
Name Type Description
$selector \selector

the new selector to add

methodpubliccircularReference( ) : void
inherited

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

Inherited from: \DataType::circularReference()
methodpubliccreateAnd( ) : void

add an "And" selector entry on the selector list

methodpubliccreateContains( ) : void

add a contains selector entry on the selector list

methodpubliccreateContainsRegexp( ) : void

add a contains selector entry on the selector list

methodpubliccreateCustom( ) : void

add an extended selector entry on the selector list

methodpubliccreateDate( ) : void

add a selector date entry on the selector list

methodpubliccreateDepend( ) : void

add a depends selector entry on the selector list

methodpubliccreateDepth( ) : void

add a depth selector entry on the selector list

methodpubliccreateExclude( ) : void

add a name entry on the exclude list

methodpubliccreateExcludesFile( ) : void

add a name entry on the include files list

methodpubliccreateFilename( ) : void

add a selector filename entry on the selector list

methodpubliccreateInclude( ) : void

add a name entry on the include list

methodpubliccreateIncludesFile( ) : void

add a name entry on the include files list

methodpubliccreateMajority( ) : void

add a majority selector entry on the selector list

methodpubliccreateNone( ) : void

add a "None" selector entry on the selector list

methodpubliccreateNot( ) : void

add a "Not" selector entry on the selector list

methodpubliccreateOr( ) : void

add an "Or" selector entry on the selector list

methodpubliccreatePatternSet( ) : void

methodpubliccreatePresent( ) : void

add a present selector entry on the selector list

methodpubliccreateSelector( ) : void

add a "Select" selector entry on the selector list

methodpubliccreateSize( ) : void

add a selector size entry on the selector list

methodpubliccreateType( ) : void

add a type selector entry on the selector list

methodpublicdieOnCircularReference(  $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
methodpublicgetCheckedRef(  $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
methodpublicgetDescription( ) : void
inherited

Return the description for the current data type.

Inherited from: \DataType::getDescription()
methodpublicgetDir(  $p ) : void

Parameters
Name Type Description
$p
methodpublicgetDirectoryScanner(  $p ) : void

returns a reference to the dirscanner object belonging to this fileset

Parameters
Name Type Description
$p
methodpublicgetProject( ) : \Project
inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()\DataType::getProject()
Returns
Type Description
\Project Reference to current porject object
methodpublicgetRef(  $p ) : void

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

Parameters
Name Type Description
$p
methodpublicgetSelectors(  $p ) : \an

Returns the set of selectors as an array.

Parameters
Name Type Description
$p
Returns
Type Description
\an array of selectors in this container
methodpublichasPatterns( ) : boolean

Indicates whether there are any patterns here.

Returns
Type Description
boolean Whether any patterns are in this container.
methodpublichasSelectors( ) : boolean

Indicates whether there are any selectors here.

Returns
Type Description
boolean Whether any selectors are in this container
methodpublicisReference( ) : void
inherited

Has the refid attribute of this element been set?

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

Logs a message with the given priority.

Inherited from: \ProjectComponent::log()\DataType::log()
Parameters
Name Type Description
$msg string

The message to be logged.

$level integer

The message's priority at this message should have

methodpublicnoChildrenAllowed( ) : 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()
methodpublicparsingComplete( ) : void
inherited

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

Inherited from: \DataType::parsingComplete()
methodpublicselectorCount( ) : int

Gives the count of the number of selectors in this container

Returns
Type Description
int The number of selectors in this container
methodpublicselectorElements( ) : array

Returns an array for accessing the set of selectors.

Returns
Type Description
array The array of selectors
methodpublicsetCaseSensitive(  $isCaseSensitive ) : void

Sets case sensitivity of the file system

Parameters
Name Type Description
$isCaseSensitive
methodpublicsetDefaultexcludes( \$useDefaultExcludes $useDefaultExcludes ) : void

Sets whether default exclusions should be used or not.

Parameters
Name Type Description
$useDefaultExcludes \$useDefaultExcludes

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

methodpublicsetDescription(  $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
methodpublicsetDir(  $dir ) : void

Parameters
Name Type Description
$dir
methodpublicsetExcludes(  $excludes ) : void

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

Parameters
Name Type Description
$excludes
methodpublicsetExcludesfile( \$excl $excl ) : void

Sets the name of the file containing the includes patterns.

Parameters
Name Type Description
$excl \$excl

The file to fetch the exclude patterns from.

Throws
Exception Description
\BE
methodpublicsetExpandSymbolicLinks(  $expandSymbolicLinks ) : void

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

Parameters
Name Type Description
$expandSymbolicLinks
Details
boolean
methodpublicsetIncludes(  $includes ) : void

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

Parameters
Name Type Description
$includes
methodpublicsetIncludesfile( \$incl $incl ) : void

Sets the name of the file containing the includes patterns.

Parameters
Name Type Description
$incl \$incl

The file to fetch the include patterns from.

Throws
Exception Description
\BE
methodpublicsetProject( \Project $project ) : void
inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()\DataType::setProject()
Parameters
Name Type Description
$project \Project

The reference to the current project

methodpublicsetRefid( \Reference $r ) : void

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.

Parameters
Name Type Description
$r \Reference
methodprotectedsetupDirectoryScanner(  $ds,  $p ) : void

feed dirscanner with infos defined by this fileset

Parameters
Name Type Description
$ds
$p
methodpublictooManyAttributes( ) : 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.18.1.