types/PearPackageFileSet.php
Part of phing, the PHP build tool
PHP version 5
- Author
- Christian Weiske
- Category
- Types
- License
- LGPL v3 or later http://www.gnu.org/licenses/lgpl.html
- Link
- http://www.phing.info/
- Package
- phing.types
- Version
- SVN: $Id: 5ba010b83645d0ea709761a3d8260fc013239458 $
\PearPackageFileSet
Fileset that contains files of an installed PEAR package.
It can be used to package up PEAR package dependencies in own release files (zip, tgz, phar).
- Parent(s)
- \FileSet < \AbstractFileSet < \DataType < \ProjectComponent
- Author
- Christian Weiske
- Category
- Types
- Internal
- A normal fileset is used that way in CopyTask, rSTTask:
$ds = $fs->getDirectoryScanner($project); $fromDir = $fs->getDir($project); $srcFiles = $ds->getIncludedFiles(); $srcDirs = $ds->getIncludedDirectories();
The scanner is used as follows:$ds->getBaseDir() $ds->scan()
- License
- LGPL v3 or later http://www.gnu.org/licenses/lgpl.html
- Link
- http://www.phing.info/
- Version
- $Id$
Properties


$additionalPatterns= 'array()'
array()
Details- Type
- n/a
- Inherited_from
- \AbstractFileSet::$$additionalPatterns
- Inherited_from
- \FileSet::$$additionalPatterns


boolean
$checked= 'true'
Are we sure we don't hold circular references?
Inherited from: \DataType::$$checked\AbstractFileSet::$$checked\FileSet::$$checkedSubclasses 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).
true
Details- Type
- boolean
- Inherited_from
- \DataType::$$checked
- Inherited_from
- \AbstractFileSet::$$checked
- Inherited_from
- \FileSet::$$checked


$config= ''
Full path to a PEAR config file.
If none provided, default one is used.
- Type
- n/a


\PatternSet
$defaultPatterns= ''
- Type
- \PatternSet
- Inherited_from
- \AbstractFileSet::$$defaultPatterns
- Inherited_from
- \FileSet::$$defaultPatterns


$description= 'null'
The descriptin the user has set.
Inherited from: \DataType::$$description\AbstractFileSet::$$description\FileSet::$$descriptionnull
Details- Type
- n/a
- Inherited_from
- \DataType::$$description
- Inherited_from
- \AbstractFileSet::$$description
- Inherited_from
- \FileSet::$$description


boolean
$expandSymbolicLinks= 'false'
Whether to expand/dereference symbolic links, default is false
Inherited from: \AbstractFileSet::$$expandSymbolicLinks\FileSet::$$expandSymbolicLinksfalse
Details- Type
- boolean
- Inherited_from
- \AbstractFileSet::$$expandSymbolicLinks
- Inherited_from
- \FileSet::$$expandSymbolicLinks


$isCaseSensitive= 'true'
true
Details- Type
- n/a
- Inherited_from
- \AbstractFileSet::$$isCaseSensitive
- Inherited_from
- \FileSet::$$isCaseSensitive


\Project
$project= 'null'
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\AbstractFileSet::$$project\FileSet::$$projectnull
Details- Type
- \Project
- Inherited_from
- \ProjectComponent::$$project
- Inherited_from
- \DataType::$$project
- Inherited_from
- \AbstractFileSet::$$project
- Inherited_from
- \FileSet::$$project


$ref= 'null'
Value to the refid attribute. Type of Reference
Inherited from: \DataType::$$ref\AbstractFileSet::$$ref\FileSet::$$refnull
Details- Type
- n/a
- Inherited_from
- \DataType::$$ref
- Inherited_from
- \AbstractFileSet::$$ref
- Inherited_from
- \FileSet::$$ref


string
$role= ''php''
Use files of that role only.
Multiple roles are not supported, and you always have to specify one.
'php'
Details- Type
- string


$selectors= 'array()'
array()
Details- Type
- n/a
- Inherited_from
- \AbstractFileSet::$$selectors
- Inherited_from
- \FileSet::$$selectors


boolean
$useDefaultExcludes= 'true'
true
Details- Type
- boolean
- Inherited_from
- \AbstractFileSet::$$useDefaultExcludes
- Inherited_from
- \FileSet::$$useDefaultExcludes
Methods


__clone(
)
:
void
Return a FileSet that has the same basedir and same patternsets as this one.
Inherited from: \FileSet::__clone()

__construct(
$fileset
=
null
)
:
void
Name | Type | Description |
---|---|---|
$fileset |


appendSelector(
\selector $selector
)
:
void
Add a new selector into this container.
Inherited from: \AbstractFileSet::appendSelector()\FileSet::appendSelector()Name | Type | Description |
---|---|---|
$selector | \selector | the new selector to add |


circularReference(
)
:
void
Creates an exception that indicates the user has generated a loop of data types referencing each other.
Inherited from: \DataType::circularReference()\AbstractFileSet::circularReference()\FileSet::circularReference()

createAnd(
)
:
void
add an "And" selector entry on the selector list
Inherited from: \AbstractFileSet::createAnd()\FileSet::createAnd()

createContains(
)
:
void
add a contains selector entry on the selector list
Inherited from: \AbstractFileSet::createContains()\FileSet::createContains()

createContainsRegexp(
)
:
void
add a contains selector entry on the selector list
Inherited from: \AbstractFileSet::createContainsRegexp()\FileSet::createContainsRegexp()

createCustom(
)
:
void
add an extended selector entry on the selector list
Inherited from: \AbstractFileSet::createCustom()\FileSet::createCustom()

createDate(
)
:
void
add a selector date entry on the selector list
Inherited from: \AbstractFileSet::createDate()\FileSet::createDate()

createDepend(
)
:
void
add a depends selector entry on the selector list
Inherited from: \AbstractFileSet::createDepend()\FileSet::createDepend()

createDepth(
)
:
void
add a depth selector entry on the selector list
Inherited from: \AbstractFileSet::createDepth()\FileSet::createDepth()

createExclude(
)
:
void
add a name entry on the exclude list
Inherited from: \AbstractFileSet::createExclude()\FileSet::createExclude()

createExcludesFile(
)
:
void
add a name entry on the include files list
Inherited from: \AbstractFileSet::createExcludesFile()\FileSet::createExcludesFile()

createFilename(
)
:
void
add a selector filename entry on the selector list
Inherited from: \AbstractFileSet::createFilename()\FileSet::createFilename()

createInclude(
)
:
void
add a name entry on the include list
Inherited from: \AbstractFileSet::createInclude()\FileSet::createInclude()

createIncludesFile(
)
:
void
add a name entry on the include files list
Inherited from: \AbstractFileSet::createIncludesFile()\FileSet::createIncludesFile()

createMajority(
)
:
void
add a majority selector entry on the selector list
Inherited from: \AbstractFileSet::createMajority()\FileSet::createMajority()

createNone(
)
:
void
add a "None" selector entry on the selector list
Inherited from: \AbstractFileSet::createNone()\FileSet::createNone()

createNot(
)
:
void
add a "Not" selector entry on the selector list
Inherited from: \AbstractFileSet::createNot()\FileSet::createNot()

createOr(
)
:
void
add an "Or" selector entry on the selector list
Inherited from: \AbstractFileSet::createOr()\FileSet::createOr()

createPresent(
)
:
void
add a present selector entry on the selector list
Inherited from: \AbstractFileSet::createPresent()\FileSet::createPresent()

createSelector(
)
:
void
add a "Select" selector entry on the selector list
Inherited from: \AbstractFileSet::createSelector()\FileSet::createSelector()

createSize(
)
:
void
add a selector size entry on the selector list
Inherited from: \AbstractFileSet::createSize()\FileSet::createSize()

createType(
)
:
void
add a type selector entry on the selector list
Inherited from: \AbstractFileSet::createType()\FileSet::createType()

dieOnCircularReference(
$stk, $p
)
:
void
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()\AbstractFileSet::dieOnCircularReference()\FileSet::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.
Name | Type | Description |
---|---|---|
$stk | ||
$p |


getCheckedRef(
$requiredClass, $dataTypeName
)
:
void
Performs the check for circular references and returns the referenced object.
Inherited from: \DataType::getCheckedRef()\AbstractFileSet::getCheckedRef()\FileSet::getCheckedRef()Name | Type | Description |
---|---|---|
$requiredClass | ||
$dataTypeName |


getDescription(
)
:
void
Return the description for the current data type.
Inherited from: \DataType::getDescription()\AbstractFileSet::getDescription()\FileSet::getDescription()

getDir(
)
:
\PhingFile
Returns the base directory all package files are relative to
Type | Description |
---|---|
\PhingFile | Base directory |


getDirectoryScanner(
\Project $project
)
:
\PearPackageScanner
Creates and returns the pear package scanner.
Scanner already has scan() called.
Name | Type | Description |
---|---|---|
$project | \Project | Current phing project |
Type | Description |
---|---|
\PearPackageScanner |


getProject(
)
:
\Project
Returns a reference to current project
Inherited from: \ProjectComponent::getProject()\DataType::getProject()\AbstractFileSet::getProject()\FileSet::getProject()Type | Description |
---|---|
\Project | Reference to current porject object |


getRef(
$p
)
:
void
Performs the check for circular references and returns the referenced FileSet.
Inherited from: \AbstractFileSet::getRef()\FileSet::getRef()Name | Type | Description |
---|---|---|
$p |


getSelectors(
$p
)
:
\an
Returns the set of selectors as an array.
Inherited from: \AbstractFileSet::getSelectors()\FileSet::getSelectors()Name | Type | Description |
---|---|---|
$p |
Type | Description |
---|---|
\an | array of selectors in this container |


hasPatterns(
)
:
boolean
Indicates whether there are any patterns here.
Inherited from: \AbstractFileSet::hasPatterns()\FileSet::hasPatterns()Type | Description |
---|---|
boolean | Whether any patterns are in this container. |


hasSelectors(
)
:
boolean
Indicates whether there are any selectors here.
Inherited from: \AbstractFileSet::hasSelectors()\FileSet::hasSelectors()Type | Description |
---|---|
boolean | Whether any selectors are in this container |


isReference(
)
:
void
Has the refid attribute of this element been set?
Inherited from: \DataType::isReference()\AbstractFileSet::isReference()\FileSet::isReference()

log(
string $msg, integer $level
=
Project::MSG_INFO
)
:
void
Logs a message with the given priority.
Inherited from: \ProjectComponent::log()\DataType::log()\AbstractFileSet::log()\FileSet::log()Name | Type | Description |
---|---|---|
$msg | string | The message to be logged. |
$level | integer | The message's priority at this message should have |


noChildrenAllowed(
)
:
void
Creates an exception that indicates that this XML element must not have child elements if the refid attribute is set.
Inherited from: \DataType::noChildrenAllowed()\AbstractFileSet::noChildrenAllowed()\FileSet::noChildrenAllowed()

parsingComplete(
)
:
void
Template method being called when the data type has been parsed completely.
Inherited from: \DataType::parsingComplete()\AbstractFileSet::parsingComplete()\FileSet::parsingComplete()

selectorCount(
)
:
int
Gives the count of the number of selectors in this container
Inherited from: \AbstractFileSet::selectorCount()\FileSet::selectorCount()Type | Description |
---|---|
int | The number of selectors in this container |


selectorElements(
)
:
array
Returns an array for accessing the set of selectors.
Inherited from: \AbstractFileSet::selectorElements()\FileSet::selectorElements()Type | Description |
---|---|
array | The array of selectors |


setCaseSensitive(
$isCaseSensitive
)
:
void
Sets case sensitivity of the file system
Inherited from: \AbstractFileSet::setCaseSensitive()\FileSet::setCaseSensitive()Name | Type | Description |
---|---|---|
$isCaseSensitive |


setConfig(
string $config
)
:
void
Sets the full path to the PEAR configuration file
Name | Type | Description |
---|---|---|
$config | string | Configuration file |


setDefaultexcludes(
\$useDefaultExcludes $useDefaultExcludes
)
:
void
Sets whether default exclusions should be used or not.
Inherited from: \AbstractFileSet::setDefaultexcludes()\FileSet::setDefaultexcludes()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
Sets a description of the current data type. It will be useful in commenting what we are doing.
Inherited from: \DataType::setDescription()\AbstractFileSet::setDescription()\FileSet::setDescription()Name | Type | Description |
---|---|---|
$desc |


setExcludes(
$excludes
)
:
void
Sets the set of exclude patterns. Patterns may be separated by a comma or a space.
Inherited from: \AbstractFileSet::setExcludes()\FileSet::setExcludes()Name | Type | Description |
---|---|---|
$excludes |


setExcludesfile(
\$excl $excl
)
:
void
Sets the name of the file containing the includes patterns.
Inherited from: \AbstractFileSet::setExcludesfile()\FileSet::setExcludesfile()Name | Type | Description |
---|---|---|
$excl | \$excl | The file to fetch the exclude patterns from. |
Exception | Description |
---|---|
\BE |


setExpandSymbolicLinks(
$expandSymbolicLinks
)
:
void
Sets whether to expand/dereference symbolic links, default is false
Inherited from: \AbstractFileSet::setExpandSymbolicLinks()\FileSet::setExpandSymbolicLinks()Name | Type | Description |
---|---|---|
$expandSymbolicLinks |
- boolean


setIncludes(
$includes
)
:
void
Sets the set of include patterns. Patterns may be separated by a comma or a space.
Inherited from: \AbstractFileSet::setIncludes()\FileSet::setIncludes()Name | Type | Description |
---|---|---|
$includes |


setIncludesfile(
\$incl $incl
)
:
void
Sets the name of the file containing the includes patterns.
Inherited from: \AbstractFileSet::setIncludesfile()\FileSet::setIncludesfile()Name | Type | Description |
---|---|---|
$incl | \$incl | The file to fetch the include patterns from. |
Exception | Description |
---|---|
\BE |


setPackage(
string $package
)
:
void
Sets the package name.
If no channel is given, "pear.php.net" is used.
Name | Type | Description |
---|---|---|
$package | string | Single package name, or "channel/name" combination |


setProject(
\Project $project
)
:
void
References the project to the current component.
Inherited from: \ProjectComponent::setProject()\DataType::setProject()\AbstractFileSet::setProject()\FileSet::setProject()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.
Inherited from: \AbstractFileSet::setRefid()\FileSet::setRefid()You must not set another attribute or nest elements inside this element if you make it a reference.
Name | Type | Description |
---|---|---|
$r | \Reference |


setRole(
string $role
)
:
void
Sets the role of files that should be included.
Examples are php,doc,script
Name | Type | Description |
---|---|---|
$role | string | PEAR file role |


setupDirectoryScanner(
$ds, $p
)
:
void
feed dirscanner with infos defined by this fileset
Inherited from: \AbstractFileSet::setupDirectoryScanner()\FileSet::setupDirectoryScanner()Name | Type | Description |
---|---|---|
$ds | ||
$p |


tooManyAttributes(
)
:
void
Creates an exception that indicates that refid has to be the only attribute if it is set.
Inherited from: \DataType::tooManyAttributes()\AbstractFileSet::tooManyAttributes()\FileSet::tooManyAttributes()