# 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
  https://gitorious.org/phing/pearPackageFileSet
Package
  phing.types
Version
  SVN: $Id: PearPackageFileSet.php 1358 2011-11-01 21:37:49Z mrook $

## \PearPackageFileSet
jump to top

Package: phing\types

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".

Details

Type
  string

`$config= ''`

Full path to a PEAR config file.

If none provided, default one is used.

Details

Type
  n/a

`string $package= ''`

Package name to get files from, e.g. "Console_CommandLine"

Details

Type
  string

`\PearPackageScanner $pps= ''`

instance
Details

Type
  \PearPackageScanner

`$prefix= ''`

Prefix to prepend to the file paths in the zip

Details

Type
  n/a

`string $role= ''php''`

Use files of that role only.

Multiple roles are not supported, and you always have to specify one.

Default value`'php'`Details

Type
  string

### Methods

`__clone( ) : void`
inherited

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

Inherited from: \FileSet::__clone()
`__construct( $fileset = null ) : void`
inherited

Inherited from: \FileSet::__construct()
Parameters

Name | Type | Description
--- | --- | ---
$fileset |  |

`appendSelector( ) : void`
inherited

Inherited from: AbstractFileSet::appendSelector()\FileSet::appendSelector()
`circularReference( ) : void`
inherited

Inherited from: DataType::circularReference()\FileSet::circularReference()
`createAnd( ) : void`
inherited

Inherited from: AbstractFileSet::createAnd()\FileSet::createAnd()
`createContains( ) : void`
inherited

Inherited from: AbstractFileSet::createContains()\FileSet::createContains()
`createContainsRegexp( ) : void`
inherited

Inherited from: AbstractFileSet::createContainsRegexp()\FileSet::createContainsRegexp()
`createCustom( ) : void`
inherited

Inherited from: AbstractFileSet::createCustom()\FileSet::createCustom()
`createDate( ) : void`
inherited

Inherited from: AbstractFileSet::createDate()\FileSet::createDate()
`createDepend( ) : void`
inherited

Inherited from: AbstractFileSet::createDepend()\FileSet::createDepend()
`createDepth( ) : void`
inherited

Inherited from: AbstractFileSet::createDepth()\FileSet::createDepth()
`createExclude( ) : void`
inherited

Inherited from: AbstractFileSet::createExclude()\FileSet::createExclude()
`createExcludesFile( ) : void`
inherited

Inherited from: AbstractFileSet::createExcludesFile()\FileSet::createExcludesFile()
`createFilename( ) : void`
inherited

Inherited from: AbstractFileSet::createFilename()\FileSet::createFilename()
`createInclude( ) : void`
inherited

Inherited from: AbstractFileSet::createInclude()\FileSet::createInclude()
`createIncludesFile( ) : void`
inherited

Inherited from: AbstractFileSet::createIncludesFile()\FileSet::createIncludesFile()
`createMajority( ) : void`
inherited

Inherited from: AbstractFileSet::createMajority()\FileSet::createMajority()
`createNone( ) : void`
inherited

Inherited from: AbstractFileSet::createNone()\FileSet::createNone()
`createNot( ) : void`
inherited

Inherited from: AbstractFileSet::createNot()\FileSet::createNot()
`createOr( ) : void`
inherited

Inherited from: AbstractFileSet::createOr()\FileSet::createOr()
`createPatternSet( ) : void`
inherited

Inherited from: AbstractFileSet::createPatternSet()\FileSet::createPatternSet()
`createPresent( ) : void`
inherited

Inherited from: AbstractFileSet::createPresent()\FileSet::createPresent()
`createSelector( ) : void`
inherited

Inherited from: AbstractFileSet::createSelector()\FileSet::createSelector()
`createSize( ) : void`
inherited

Inherited from: AbstractFileSet::createSize()\FileSet::createSize()
`createType( ) : void`
inherited

Inherited from: AbstractFileSet::createType()\FileSet::createType()
`dieOnCircularReference( ) : void`
inherited

Inherited from: DataType::dieOnCircularReference()\FileSet::dieOnCircularReference()
`getCheckedRef( ) : void`
inherited

Inherited from: DataType::getCheckedRef()\FileSet::getCheckedRef()
`getDescription( ) : void`
inherited

Inherited from: DataType::getDescription()\FileSet::getDescription()
`getDir( ) : \PhingFile`

Returns the base directory all package files are relative to

Returns

Type | Description
--- | ---
\PhingFile | Base directory

`getDirectoryScanner( \Project $project ) : \PearPackageScanner`

Creates and returns the pear package scanner.

Scanner already has scan() called.

Parameters

Name | Type | Description
--- | --- | ---
$project | \Project | Current phing project

Returns

Type | Description
--- | ---
\PearPackageScanner |

`getProject( ) : void`
inherited

Inherited from: ProjectComponent::getProject()\FileSet::getProject()
`getRef( ) : void`
inherited

Inherited from: AbstractFileSet::getRef()\FileSet::getRef()
`getSelectors( ) : void`
inherited

Inherited from: AbstractFileSet::getSelectors()\FileSet::getSelectors()
`hasPatterns( ) : void`
inherited

Inherited from: AbstractFileSet::hasPatterns()\FileSet::hasPatterns()
`hasSelectors( ) : void`
inherited

Inherited from: AbstractFileSet::hasSelectors()\FileSet::hasSelectors()
`isReference( ) : void`
inherited

Inherited from: DataType::isReference()\FileSet::isReference()
`loadPearPackageScanner( ) : void`

Loads the package scanner instance into $this->pps

`log( ) : void`
inherited

Inherited from: ProjectComponent::log()\FileSet::log()
`noChildrenAllowed( ) : void`
inherited

Inherited from: DataType::noChildrenAllowed()\FileSet::noChildrenAllowed()
`parsingComplete( ) : void`
inherited

Inherited from: DataType::parsingComplete()\FileSet::parsingComplete()
`selectorCount( ) : void`
inherited

Inherited from: AbstractFileSet::selectorCount()\FileSet::selectorCount()
`selectorElements( ) : void`
inherited

Inherited from: AbstractFileSet::selectorElements()\FileSet::selectorElements()
`setCaseSensitive( ) : void`
inherited

Inherited from: AbstractFileSet::setCaseSensitive()\FileSet::setCaseSensitive()
`setConfig( string $config ) : void`

Sets the full path to the PEAR configuration file

Parameters

Name | Type | Description
--- | --- | ---
$config | string | Configuration file

`setDefaultexcludes( ) : void`
inherited

Inherited from: AbstractFileSet::setDefaultexcludes()\FileSet::setDefaultexcludes()
`setDescription( ) : void`
inherited

Inherited from: DataType::setDescription()\FileSet::setDescription()
`setDir( ) : void`
inherited

Inherited from: AbstractFileSet::setDir()\FileSet::setDir()
`setExcludes( ) : void`
inherited

Inherited from: AbstractFileSet::setExcludes()\FileSet::setExcludes()
`setExcludesfile( ) : void`
inherited

Inherited from: AbstractFileSet::setExcludesfile()\FileSet::setExcludesfile()
`setExpandSymbolicLinks( ) : void`
inherited

Inherited from: AbstractFileSet::setExpandSymbolicLinks()\FileSet::setExpandSymbolicLinks()
`setIncludes( ) : void`
inherited

Inherited from: AbstractFileSet::setIncludes()\FileSet::setIncludes()
`setIncludesfile( ) : void`
inherited

Inherited from: AbstractFileSet::setIncludesfile()\FileSet::setIncludesfile()
`setPackage( string $package ) : void`

Sets the package name.

If no channel is given, "pear.php.net" is used.

Parameters

Name | Type | Description
--- | --- | ---
$package | string | Single package name, or "channel/name" combination

`setProject( ) : void`
inherited

Inherited from: ProjectComponent::setProject()\FileSet::setProject()
`setRefid( ) : void`
inherited

Inherited from: AbstractFileSet::setRefid()\FileSet::setRefid()
`setRole( string $role ) : void`

Sets the role of files that should be included.

Examples are php,doc,script

Parameters

Name | Type | Description
--- | --- | ---
$role | string | PEAR file role

`setupDirectoryScanner( ) : void`
inherited

Inherited from: AbstractFileSet::setupDirectoryScanner()\FileSet::setupDirectoryScanner()
`tooManyAttributes( ) : void`
inherited

Inherited from: DataType::tooManyAttributes()\FileSet::tooManyAttributes()
Documentation was generated by DocBlox 0.17.1.