This is a FileSet with the option to specify permissions.

Permissions are currently not implemented by PEAR Archive_Tar, but hopefully they will be in the future.

package phing.tasks.ext
author Hans Lellelid <hans@xmpl.org> (Phing)
author Arnout J. Kuiper <ajkuiper@wxs.nl> (Ant)
author Stefano Mazzocchi <stefano@apache.org> (Ant)
author Sam Ruby <rubys@us.ibm.com> (Ant)
author Jon S. Stevens <jon@clearink.com> (Ant)
author Stefan Bodewig <stefan.bodewig@epost.de> (Ant)
author Magesh Umasankar (Ant)
version $Id$

 Methods

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

__clone() 
Inherited
inherited_from \FileSet::__clone()

__construct()

__construct($fileset) 
Inherited
inherited_from \FileSet::__construct()

Parameters

$fileset

Add a new selector into this container.

appendSelector(\FileSelector $selector) : \the
Inherited
inherited_from \AbstractFileSet::appendSelector()
inherited_from \FileSet::appendSelector()

Parameters

$selector

\selector

the new selector to add

Returns

\theselector 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()
inherited_from \AbstractFileSet::circularReference()
inherited_from \FileSet::circularReference()

add an "And" selector entry on the selector list

createAnd() 
Inherited
inherited_from \AbstractFileSet::createAnd()
inherited_from \FileSet::createAnd()

add a contains selector entry on the selector list

createContains() 
Inherited
inherited_from \AbstractFileSet::createContains()
inherited_from \FileSet::createContains()

add a contains selector entry on the selector list

createContainsRegexp() 
Inherited
inherited_from \AbstractFileSet::createContainsRegexp()
inherited_from \FileSet::createContainsRegexp()

add an extended selector entry on the selector list

createCustom() 
Inherited
inherited_from \AbstractFileSet::createCustom()
inherited_from \FileSet::createCustom()

add a selector date entry on the selector list

createDate() 
Inherited
inherited_from \AbstractFileSet::createDate()
inherited_from \FileSet::createDate()

add a depends selector entry on the selector list

createDepend() 
Inherited
inherited_from \AbstractFileSet::createDepend()
inherited_from \FileSet::createDepend()

add a depth selector entry on the selector list

createDepth() 
Inherited
inherited_from \AbstractFileSet::createDepth()
inherited_from \FileSet::createDepth()

add a name entry on the exclude list

createExclude() 
Inherited
inherited_from \AbstractFileSet::createExclude()
inherited_from \FileSet::createExclude()

add a name entry on the include files list

createExcludesFile() 
Inherited
inherited_from \AbstractFileSet::createExcludesFile()
inherited_from \FileSet::createExcludesFile()

add a selector filename entry on the selector list

createFilename() 
Inherited
inherited_from \AbstractFileSet::createFilename()
inherited_from \FileSet::createFilename()

add a name entry on the include list

createInclude() 
Inherited
inherited_from \AbstractFileSet::createInclude()
inherited_from \FileSet::createInclude()

add a name entry on the include files list

createIncludesFile() 
Inherited
inherited_from \AbstractFileSet::createIncludesFile()
inherited_from \FileSet::createIncludesFile()

add a majority selector entry on the selector list

createMajority() 
Inherited
inherited_from \AbstractFileSet::createMajority()
inherited_from \FileSet::createMajority()

add a "None" selector entry on the selector list

createNone() 
Inherited
inherited_from \AbstractFileSet::createNone()
inherited_from \FileSet::createNone()

add a "Not" selector entry on the selector list

createNot() 
Inherited
inherited_from \AbstractFileSet::createNot()
inherited_from \FileSet::createNot()

add an "Or" selector entry on the selector list

createOr() 
Inherited
inherited_from \AbstractFileSet::createOr()
inherited_from \FileSet::createOr()

createPatternSet()

createPatternSet() 
Inherited
inherited_from \AbstractFileSet::createPatternSet()
inherited_from \FileSet::createPatternSet()

add a present selector entry on the selector list

createPresent() 
Inherited
inherited_from \AbstractFileSet::createPresent()
inherited_from \FileSet::createPresent()

add a "Select" selector entry on the selector list

createSelector() 
Inherited
inherited_from \AbstractFileSet::createSelector()
inherited_from \FileSet::createSelector()

add a selector size entry on the selector list

createSize() 
Inherited
inherited_from \AbstractFileSet::createSize()
inherited_from \FileSet::createSize()

add a type selector entry on the selector list

createType() 
Inherited
inherited_from \AbstractFileSet::createType()
inherited_from \FileSet::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()
inherited_from \AbstractFileSet::dieOnCircularReference()
inherited_from \FileSet::dieOnCircularReference()

Parameters

$stk

$p

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

getCheckedRef($requiredClass, $dataTypeName) 
Inherited
inherited_from \DataType::getCheckedRef()
inherited_from \AbstractFileSet::getCheckedRef()
inherited_from \FileSet::getCheckedRef()

Parameters

$requiredClass

$dataTypeName

Return the description for the current data type.

getDescription() 
Inherited
inherited_from \DataType::getDescription()
inherited_from \AbstractFileSet::getDescription()
inherited_from \FileSet::getDescription()

getDir()

getDir(\Project $p) 
Inherited
inherited_from \AbstractFileSet::getDir()
inherited_from \FileSet::getDir()

Parameters

$p

returns a reference to the dirscanner object belonging to this fileset

getDirectoryScanner(\Project $p) 
Inherited
inherited_from \AbstractFileSet::getDirectoryScanner()
inherited_from \FileSet::getDirectoryScanner()

Parameters

$p

Get a list of files and directories specified in the fileset.

getFiles(\Project $p, $includeEmpty) 

@return array a list of file and directory names, relative to the baseDir for the project.

Parameters

$p

$includeEmpty

getFullpath()

getFullpath() 

getGroup()

getGroup() 

getMode()

getMode() 

getPrefix()

getPrefix() 

getPreserveLeadingSlashes()

getPreserveLeadingSlashes() 

Returns a reference to current project

getProject() : \Project
Inherited
inherited_from \ProjectComponent::getProject()
inherited_from \DataType::getProject()
inherited_from \AbstractFileSet::getProject()
inherited_from \FileSet::getProject()

Returns

\ProjectReference to current porject object

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

getRef(\Project $p) 
Inherited
inherited_from \AbstractFileSet::getRef()
inherited_from \FileSet::getRef()

Parameters

$p

Returns the set of selectors as an array.

getSelectors(\Project $p) : \an
Inherited
inherited_from \AbstractFileSet::getSelectors()
inherited_from \FileSet::getSelectors()

Parameters

$p

Returns

\anarray of selectors in this container

getUserName()

getUserName() 

Indicates whether there are any patterns here.

hasPatterns() : boolean
Inherited
inherited_from \AbstractFileSet::hasPatterns()
inherited_from \FileSet::hasPatterns()

Returns

booleanWhether any patterns are in this container.

Indicates whether there are any selectors here.

hasSelectors() : boolean
Inherited
inherited_from \AbstractFileSet::hasSelectors()
inherited_from \FileSet::hasSelectors()

Returns

booleanWhether any selectors are in this container

Has the refid attribute of this element been set?

isReference() 
Inherited
inherited_from \DataType::isReference()
inherited_from \AbstractFileSet::isReference()
inherited_from \FileSet::isReference()

Logs a message with the given priority.

log(string $msg, integer $level) 
Inherited
inherited_from \ProjectComponent::log()
inherited_from \DataType::log()
inherited_from \AbstractFileSet::log()
inherited_from \FileSet::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()
inherited_from \AbstractFileSet::noChildrenAllowed()
inherited_from \FileSet::noChildrenAllowed()

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

parsingComplete() : void
Inherited
inherited_from \DataType::parsingComplete()
inherited_from \AbstractFileSet::parsingComplete()
inherited_from \FileSet::parsingComplete()

Gives the count of the number of selectors in this container

selectorCount() : int
Inherited
inherited_from \AbstractFileSet::selectorCount()
inherited_from \FileSet::selectorCount()

Returns

intThe number of selectors in this container

Returns an array for accessing the set of selectors.

selectorElements() : array
Inherited
inherited_from \AbstractFileSet::selectorElements()
inherited_from \FileSet::selectorElements()

Returns

arrayThe array of selectors

Sets case sensitivity of the file system

setCaseSensitive($isCaseSensitive) 
Inherited
inherited_from \AbstractFileSet::setCaseSensitive()
inherited_from \FileSet::setCaseSensitive()

Parameters

$isCaseSensitive

Sets whether default exclusions should be used or not.

setDefaultexcludes($useDefaultExcludes) 
Inherited
inherited_from \AbstractFileSet::setDefaultexcludes()
inherited_from \FileSet::setDefaultexcludes()

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()
inherited_from \AbstractFileSet::setDescription()
inherited_from \FileSet::setDescription()

Parameters

$desc

setDir()

setDir($dir) 
Inherited
inherited_from \AbstractFileSet::setDir()
inherited_from \FileSet::setDir()

Parameters

$dir

Sets the set of exclude patterns.

setExcludes($excludes) 
Inherited

Patterns may be separated by a comma or a space.

inherited_from \AbstractFileSet::setExcludes()
inherited_from \FileSet::setExcludes()

Parameters

$excludes

Sets the name of the file containing the includes patterns.

setExcludesfile($excl) 
Inherited
inherited_from \AbstractFileSet::setExcludesfile()
inherited_from \FileSet::setExcludesfile()

Parameters

$excl

The file to fetch the exclude patterns from.

Exceptions

\BE

If the fullpath attribute is set, the file in the fileset is written with that path in the archive.

setFullpath($fullpath) 

The prefix attribute, if specified, is ignored. It is an error to have more than one file specified in such a fileset.

Parameters

$fullpath

The groupname for the tar entry; optional, default="" This is not the same as the GID, which is not currently set by the task.

setGroup($groupName) 

Parameters

$groupName

Sets the set of include patterns.

setIncludes($includes) 
Inherited

Patterns may be separated by a comma or a space.

inherited_from \AbstractFileSet::setIncludes()
inherited_from \FileSet::setIncludes()

Parameters

$includes

Sets the name of the file containing the includes patterns.

setIncludesfile($incl) 
Inherited
inherited_from \AbstractFileSet::setIncludesfile()
inherited_from \FileSet::setIncludesfile()

Parameters

$incl

The file to fetch the include patterns from.

Exceptions

\BE

A 3 digit octal string, specify the user, group and other modes in the standard Unix fashion; optional, default=0644

setMode(string $octalString) 

Parameters

$octalString

string

If the prefix attribute is set, all files in the fileset are prefixed with that path in the archive.

setPrefix($prefix) 

optional.

Parameters

$prefix

Flag to indicates whether leading `/'s should be preserved in the file names.

setPreserveLeadingSlashes($b) : void

Optional, default is

false

.

Parameters

$b

References the project to the current component.

setProject(\Project $project) 
Inherited
inherited_from \ProjectComponent::setProject()
inherited_from \DataType::setProject()
inherited_from \AbstractFileSet::setProject()
inherited_from \FileSet::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
Inherited

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

inherited_from \AbstractFileSet::setRefid()
inherited_from \FileSet::setRefid()

Parameters

The username for the tar entry This is not the same as the UID, which is not currently set by the task.

setUserName($userName) 

Parameters

$userName

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

tooManyAttributes() 
Inherited
inherited_from \DataType::tooManyAttributes()
inherited_from \AbstractFileSet::tooManyAttributes()
inherited_from \FileSet::tooManyAttributes()

feed dirscanner with infos defined by this fileset

setupDirectoryScanner(\DirectoryScanner $ds, \Project $p) 
Inherited
inherited_from \AbstractFileSet::setupDirectoryScanner()
inherited_from \FileSet::setupDirectoryScanner()

Parameters

$ds

$p

 Properties

 

$additionalPatterns 
Inherited
inherited_from \AbstractFileSet::$$additionalPatterns
inherited_from \FileSet::$$additionalPatterns
 

$defaultPatterns : \PatternSet
Inherited
inherited_from \AbstractFileSet::$$defaultPatterns
inherited_from \FileSet::$$defaultPatterns
 

$description 
Inherited
inherited_from \DataType::$$description
inherited_from \AbstractFileSet::$$description
inherited_from \FileSet::$$description
 

$dir 
Inherited
inherited_from \AbstractFileSet::$$dir
inherited_from \FileSet::$$dir
 

$isCaseSensitive 
Inherited
inherited_from \AbstractFileSet::$$isCaseSensitive
inherited_from \FileSet::$$isCaseSensitive
 

$ref 
Inherited

Type of Reference

inherited_from \DataType::$$ref
inherited_from \AbstractFileSet::$$ref
inherited_from \FileSet::$$ref
 

$selectors 
Inherited
inherited_from \AbstractFileSet::$$selectors
inherited_from \FileSet::$$selectors
 

$useDefaultExcludes : boolean
Inherited
inherited_from \AbstractFileSet::$$useDefaultExcludes
inherited_from \FileSet::$$useDefaultExcludes
 

$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
inherited_from \AbstractFileSet::$$checked
inherited_from \FileSet::$$checked
   

$project : \Project
Inherited
inherited_from \ProjectComponent::$$project
inherited_from \DataType::$$project
inherited_from \AbstractFileSet::$$project
inherited_from \FileSet::$$project
 

$files 
 

$fullpath 
 

$groupName 
 

$mode 
 

$prefix 
 

$preserveLeadingSlashes 
 

$userName