types/PearPackageFileSet.php
inherited
Classes
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
- https://gitorious.org/phing/pearPackageFileSet
- Package
- phing.types
- Version
- SVN: $Id: PearPackageFileSet.php 1358 2011-11-01 21:37:49Z mrook $
\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
- https://gitorious.org/phing/pearPackageFileSet
Properties
string
$channel= ''
Name of channel the package is from, e.g. "pear.php.net".
- Type
- string
$config= ''
Full path to a PEAR config file.
If none provided, default one is used.
- Type
- n/a
string
$package= ''
Package name to get files from, e.g. "Console_CommandLine"
- Type
- string
$prefix= ''
Prefix to prepend to the file paths in the zip
- Type
- n/a
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
Methods
__clone(
)
:
voidReturn 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(
)
:
void
circularReference(
)
:
void
createContains(
)
:
void
createContainsRegexp(
)
:
void
createCustom(
)
:
void
createDepend(
)
:
void
createDepth(
)
:
void
createExclude(
)
:
void
createExcludesFile(
)
:
void
createFilename(
)
:
void
createInclude(
)
:
void
createIncludesFile(
)
:
void
createMajority(
)
:
void
createPatternSet(
)
:
void
createPresent(
)
:
void
createSelector(
)
:
void
dieOnCircularReference(
)
:
void
getCheckedRef(
)
:
void
getDescription(
)
:
void
getDir(
)
:
\PhingFileReturns the base directory all package files are relative to
| Type | Description |
|---|---|
| \PhingFile | Base directory |
getDirectoryScanner(
\Project $project
)
:
\PearPackageScannerCreates and returns the pear package scanner.
Scanner already has scan() called.
| Name | Type | Description |
|---|---|---|
| $project | \Project | Current phing project |
| Type | Description |
|---|---|
| \PearPackageScanner |
getSelectors(
)
:
void
hasPatterns(
)
:
void
hasSelectors(
)
:
void
loadPearPackageScanner(
)
:
voidLoads the package scanner instance into $this->pps
noChildrenAllowed(
)
:
void
parsingComplete(
)
:
void
selectorCount(
)
:
void
selectorElements(
)
:
void
setCaseSensitive(
)
:
void
setConfig(
string $config
)
:
voidSets the full path to the PEAR configuration file
| Name | Type | Description |
|---|---|---|
| $config | string | Configuration file |
setDefaultexcludes(
)
:
void
setDescription(
)
:
void
setExcludes(
)
:
void
setExcludesfile(
)
:
void
setExpandSymbolicLinks(
)
:
voidsetIncludes(
)
:
void
setIncludesfile(
)
:
void
setPackage(
string $package
)
:
voidSets 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 |
setRole(
string $role
)
:
voidSets the role of files that should be included.
Examples are php,doc,script
| Name | Type | Description |
|---|---|---|
| $role | string | PEAR file role |
setupDirectoryScanner(
)
:
void
tooManyAttributes(
)
:
void