util/PearPackageScanner.php

Show: inherited

• Classes
  • \PearPackageScanner

Table of Contents

Author

Christian Weiske  

Category

Util  

License

LGPL v3 or later http://www.gnu.org/licenses/lgpl.html  

Link

https://gitorious.org/phing/pearPackageFileSet  

Package

phing.util  

Version

SVN: $Id: PearPackageScanner.php 1359 2011-11-01 21:52:28Z mrook $  

\PearPackageScanner

jump to top

Package: phing\util

Scans for files in a PEAR package.

Parent(s)

\DirectoryScanner

Author

Christian Weiske  

Category

Util  

License

LGPL v3 or later http://www.gnu.org/licenses/lgpl.html  

Link

https://gitorious.org/phing/pearPackageFileSet  

Properties

 $channel= ''pear.php.net''

Default value'pear.php.net'Details

Type

n/a

 $config= ''

Details

Type

n/a

 $package= ''

Details

Type

n/a

 $packageInfo= ''

Details

Type

n/a

 $role= ''php''

Default value'php'Details

Type

n/a

Methods

addDefaultExcludes( ) : void

couldHoldIncluded( ) : void

getBasedir( ) : void

getDeselectedDirectories( ) : void

getDeselectedFiles( ) : void

getExcludedDirectories( ) : void

getExcludedFiles( ) : void

getIncludedDirectories( ) : void

getIncludedFiles( ) : void

getNotIncludedDirectories( ) : void

getNotIncludedFiles( ) : void

init( ) : void

Loads the package information.

Details

Uses

\$packageInfo  

isEverythingIncluded( ) : void

isExcluded( ) : void

isIncluded( ) : void

isSelected( ) : void

listDir( ) : void

loadPackageInfo( ) : \PEAR_PackageFile_v2

Loads and returns the PEAR package information.

Returns

Type	Description
\PEAR_PackageFile_v2	Package information object

Throws

Exception	Description
\BuildException	When the package does not exist

match( ) : void

matchPath( ) : void

matchPatternStart( ) : void

scan( ) : boolean

Generates the list of included files and directories

Returns

Type	Description
boolean	True if all went well, false if something was wrong

Details

Uses

\$filesIncluded  

Uses

\$filesDeselected  

Uses

\$filesNotIncluded  

Uses

\$filesExcluded  

Uses

\$everythingIncluded  

Uses

\$dirsIncluded  

Uses

\$dirsDeselected  

Uses

\$dirsNotIncluded  

Uses

\$dirsExcluded  

setBasedir( ) : void

setCaseSensitive( ) : void

setChannel( string $channel ) : void

Sets the name of the package channel name

Parameters

Name	Type	Description
$channel	string	package channel name or alias

setConfig( string $config ) : void

Sets the full path to the PEAR configuration file

Parameters

Name	Type	Description
$config	string	Configuration file

setExcludes( ) : void

setExpandSymbolicLinks( ) : void

setIncludes( ) : void

setPackage( string $package ) : void

Sets the name of the PEAR package to get the files from

Parameters

Name	Type	Description
$package	string	Package name without channel

setSelectors( ) : void

slowScan( ) : void