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).
internal |
A normal fileset is used that way in CopyTask, rSTTask:
|
---|---|
category |
Types |
package |
phing.types |
author |
Christian Weiske cweiske@cweiske.de |
license |
LGPL v3 or later http://www.gnu.org/licenses/lgpl.html |
link |
__clone()
__construct(null $fileset = null)
null
appendSelector(\FileSelector $selector) : void
circularReference() : \BuildException
createAnd() : \AndSelector
createContains()
createContainsRegexp()
createCustom()
createDate()
createDepend()
createDepth()
createDifferent()
createExclude()
createExcludesFile()
createFilename()
createInclude()
createIncludesFile()
createMajority()
createNone()
createNot()
createOr() : \OrSelector
createPatternSet() : mixed
throws | |
---|---|
mixed
createPresent()
createReadable()
createSelector() : \SelectSelector
createSize()
createType()
createWritable()
dieOnCircularReference( &$stk, \Project $p) : void
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.
throws |
---|
\Project
getCheckedRef( $requiredClass, $dataTypeName) : mixed
throws |
---|
mixed
getDescription()
retujrn |
string |
---|---|
getDirectoryScanner(\Project $p) : \DirectoryScanner
getProject() : \Project
getRef(\Project $p) : \FileSet
getSelectors(\Project $p) : array
hasPatterns() : boolean
boolean
Whether any patterns are in this container.
hasSelectors() : boolean
boolean
Whether any selectors are in this container
isReference() : boolean
boolean
loadPearPackageScanner(\Project $p) : void
log(string $msg, integer $level = \Project::MSG_INFO) : void
string
The message to be logged.
integer
The message's priority at this message should have
noChildrenAllowed() : \BuildException
parsingComplete() : void
{@inheritdoc}
pushAndInvokeCircularReferenceCheck(\DataType $dt, &$stk, \Project $p)
selectorCount() : integer
throws | |
---|---|
integer
The number of selectors in this container
selectorElements() : array
array
The array of selectors
setCaseSensitive( $isCaseSensitive)
setConfig(string $config) : void
string
Configuration file
setDefaultexcludes( $useDefaultExcludes) : void
throws |
---|
"true"|"on"|"yes" when default exclusions should be used, "false"|"off"|"no" when they shouldn't be used.
setDescFile( $descFile) : void
If it is not set, the local pear installation is queried for the package.
setDescription(string $desc) : void
string
setDir( $dir)
throws | |
---|---|
setExcludes( $excludes)
throws | |
---|---|
setExcludesfile( $excl)
throws | |
---|---|
The file to fetch the exclude patterns from.
setExpandSymbolicLinks( $expandSymbolicLinks)
var | |
---|---|
setIncludes( $includes)
throws | |
---|---|
setIncludesfile(\PhingFile $incl)
setPackage(string $package) : void
If no channel is given, "pear.php.net" is used.
throws |
---|
string
Single package name, or "channel/name" combination
setProject(\Project $project) : void
setRefid(\Reference $r) : void
Subclasses may need to check whether any other attributes have been set as well or child elements have been created and thus override this method. if they do they must call parent::setRefid()
\Reference
setRole(string $role) : void
Examples are php,doc,script
string
PEAR file role
setupDirectoryScanner(\DirectoryScanner $ds, \Project $p)
tooManyAttributes() : \BuildException
channel : string
var |
---|
string
package : string
var |
---|
string
packageFile : string
var |
---|
string
role : string
Multiple roles are not supported, and you always have to specify one.
var |
---|
string
config : string
If none provided, default one is used.
var |
---|
string
useDefaultExcludes : boolean
var |
---|
boolean
additionalPatterns :
dir :
isCaseSensitive :
selectors :
description : string
var |
---|
string
checked : boolean
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).
var |
---|
boolean
project : \Project