types/AbstractFileSet.php

Show:

inherited

Classes
- \AbstractFileSet

Table of Contents

\AbstractFileSet
jump to top

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


                 $additionalPatterns= 'array()'

Default valuearray()Details

Type: n/a

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 valuetrueDetails

Type: boolean
Inherited_from: \DataType::$$checked

\PatternSet
                 $defaultPatterns= ''

Details

Type: \PatternSet


                 $description= 'null'

inherited

The descriptin the user has set.

Inherited from: \DataType::$$description

Default valuenullDetails

Type: n/a
Inherited_from: \DataType::$$description


                 $dir= ''

Details

Type: n/a

boolean
                 $expandSymbolicLinks= 'false'

Whether to expand/dereference symbolic links, default is false

Default valuefalseDetails

Type: boolean


                 $isCaseSensitive= 'true'

Default valuetrueDetails

Type: n/a

\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


                 $ref= 'null'

inherited

Value to the refid attribute. Type of Reference

Inherited from: \DataType::$$ref

Default valuenullDetails

Type: n/a
Inherited_from: \DataType::$$ref


                 $selectors= 'array()'

Default valuearray()Details

Type: n/a

boolean
                 $useDefaultExcludes= 'true'

Default valuetrueDetails

Type: boolean

Methods

__construct(
           $fileset
              =
              null
          )
        
        :
          void

Parameters

Name	Type	Description
$fileset

appendSelector(
          \selector $selector
          )
        
        :
          void

Add a new selector into this container.

Parameters

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

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

add an "And" selector entry on the selector list

createContains(
          
          )
        
        :
          void

add a contains selector entry on the selector list

createContainsRegexp(
          
          )
        
        :
          void

add a contains selector entry on the selector list

createCustom(
          
          )
        
        :
          void

add an extended selector entry on the selector list

createDate(
          
          )
        
        :
          void

add a selector date entry on the selector list

createDepend(
          
          )
        
        :
          void

add a depends selector entry on the selector list

createDepth(
          
          )
        
        :
          void

add a depth selector entry on the selector list

createExclude(
          
          )
        
        :
          void

add a name entry on the exclude list

createExcludesFile(
          
          )
        
        :
          void

add a name entry on the include files list

createFilename(
          
          )
        
        :
          void

add a selector filename entry on the selector list

createInclude(
          
          )
        
        :
          void

add a name entry on the include list

createIncludesFile(
          
          )
        
        :
          void

add a name entry on the include files list

createMajority(
          
          )
        
        :
          void

add a majority selector entry on the selector list

createNone(
          
          )
        
        :
          void

add a "None" selector entry on the selector list

createNot(
          
          )
        
        :
          void

add a "Not" selector entry on the selector list

createOr(
          
          )
        
        :
          void

add an "Or" selector entry on the selector list

createPatternSet(
          
          )
        
        :
          void

createPresent(
          
          )
        
        :
          void

add a present selector entry on the selector list

createSelector(
          
          )
        
        :
          void

add a "Select" selector entry on the selector list

createSize(
          
          )
        
        :
          void

add a selector size entry on the selector list

createType(
          
          )
        
        :
          void

add a type selector entry on the selector list

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

Parameters

Name	Type	Description
$p

getDirectoryScanner(
           $p
          )
        
        :
          void

returns a reference to the dirscanner object belonging to this fileset

Parameters

Name	Type	Description
$p

getProject(
          
          )
        
        :
          \Project

inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()\DataType::getProject()

Returns

Type	Description
\Project	Reference to current porject object

getRef(
           $p
          )
        
        :
          void

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

Parameters

Name	Type	Description
$p

getSelectors(
           $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

hasPatterns(
          
          )
        
        :
          boolean

Indicates whether there are any patterns here.

Returns

Type	Description
boolean	Whether any patterns are in this container.

hasSelectors(
          
          )
        
        :
          boolean

Indicates whether there are any selectors here.

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(
          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

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

Gives the count of the number of selectors in this container

Returns

Type	Description
int	The number of selectors in this container

selectorElements(
          
          )
        
        :
          array

Returns an array for accessing the set of selectors.

Returns

Type	Description
array	The array of selectors

setCaseSensitive(
           $isCaseSensitive
          )
        
        :
          void

Sets case sensitivity of the file system

Parameters

Name	Type	Description
$isCaseSensitive

setDefaultexcludes(
          \$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.

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

Parameters

Name	Type	Description
$dir

setExcludes(
           $excludes
          )
        
        :
          void

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

Parameters

Name	Type	Description
$excludes

setExcludesfile(
          \$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

setExpandSymbolicLinks(
           $expandSymbolicLinks
          )
        
        :
          void

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

Parameters

Name	Type	Description
$expandSymbolicLinks

Details

: boolean

setIncludes(
           $includes
          )
        
        :
          void

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

Parameters

Name	Type	Description
$includes

setIncludesfile(
          \$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

setProject(
          \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

setRefid(
          \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

setupDirectoryScanner(
           $ds,  $p
          )
        
        :
          void

feed dirscanner with infos defined by this fileset

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

types/AbstractFileSet.php

\AbstractFileSetjump to top

Properties

Methods

\AbstractFileSet
jump to top