types/PearPackageFileSet.php

Show: inherited
Table of Contents

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

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
http://www.phing.info/  
Version
$Id$  

Properties

Propertypublic  $additionalPatterns= 'array()'
Default valuearray()Details
Type
n/a
Inherited_from
\AbstractFileSet::$$additionalPatterns  
Inherited_from
\FileSet::$$additionalPatterns  
Propertyprotectedstring  $channel= ''

Name of channel the package is from, e.g. "pear.php.net".

Details
Type
string
Propertyprotectedboolean  $checked= 'true'
inherited

Are we sure we don't hold circular references?

Inherited from: \DataType::$$checked\AbstractFileSet::$$checked\FileSet::$$checked

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

Default valuetrueDetails
Type
boolean
Inherited_from
\DataType::$$checked  
Inherited_from
\AbstractFileSet::$$checked  
Inherited_from
\FileSet::$$checked  
Propertyprotected  $config= ''

Full path to a PEAR config file.

If none provided, default one is used.

Details
Type
n/a
Propertypublic\PatternSet  $defaultPatterns= ''
Details
Type
\PatternSet
Inherited_from
\AbstractFileSet::$$defaultPatterns  
Inherited_from
\FileSet::$$defaultPatterns  
Propertypublic  $description= 'null'
inherited

The descriptin the user has set.

Inherited from: \DataType::$$description\AbstractFileSet::$$description\FileSet::$$description
Default valuenullDetails
Type
n/a
Inherited_from
\DataType::$$description  
Inherited_from
\AbstractFileSet::$$description  
Inherited_from
\FileSet::$$description  
Propertypublic  $dir= ''
inheritedInherited from: \AbstractFileSet::$$dir\FileSet::$$dir
Details
Type
n/a
Inherited_from
\AbstractFileSet::$$dir  
Inherited_from
\FileSet::$$dir  
Propertyprotectedboolean  $expandSymbolicLinks= 'false'
inherited

Whether to expand/dereference symbolic links, default is false

Inherited from: \AbstractFileSet::$$expandSymbolicLinks\FileSet::$$expandSymbolicLinks
Default valuefalseDetails
Type
boolean
Inherited_from
\AbstractFileSet::$$expandSymbolicLinks  
Inherited_from
\FileSet::$$expandSymbolicLinks  
Propertypublic  $isCaseSensitive= 'true'
Default valuetrueDetails
Type
n/a
Inherited_from
\AbstractFileSet::$$isCaseSensitive  
Inherited_from
\FileSet::$$isCaseSensitive  
Propertyprotectedstring  $package= ''

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

Details
Type
string
Propertyprotected\PearPackageScanner  $pps= ''

instance
Details
Type
\PearPackageScanner
Propertyprotected  $prefix= ''

Prefix to prepend to the file paths in the zip

Details
Type
n/a
Propertyprotected\Project  $project= 'null'
inherited

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::$$project
Default valuenullDetails
Type
\Project
Inherited_from
\ProjectComponent::$$project  
Inherited_from
\DataType::$$project  
Inherited_from
\AbstractFileSet::$$project  
Inherited_from
\FileSet::$$project  
Propertypublic  $ref= 'null'
inherited

Value to the refid attribute. Type of Reference

Inherited from: \DataType::$$ref\AbstractFileSet::$$ref\FileSet::$$ref
Default valuenullDetails
Type
n/a
Inherited_from
\DataType::$$ref  
Inherited_from
\AbstractFileSet::$$ref  
Inherited_from
\FileSet::$$ref  
Propertyprotectedstring  $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
Propertypublic  $selectors= 'array()'
Default valuearray()Details
Type
n/a
Inherited_from
\AbstractFileSet::$$selectors  
Inherited_from
\FileSet::$$selectors  
Propertypublicboolean  $useDefaultExcludes= 'true'
Default valuetrueDetails
Type
boolean
Inherited_from
\AbstractFileSet::$$useDefaultExcludes  
Inherited_from
\FileSet::$$useDefaultExcludes  

Methods

methodpublic__clone( ) : void
inherited

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

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

Inherited from: \FileSet::__construct()
Parameters
Name Type Description
$fileset
methodpublicappendSelector( \selector $selector ) : void
inherited

Add a new selector into this container.

Inherited from: \AbstractFileSet::appendSelector()\FileSet::appendSelector()
Parameters
Name Type Description
$selector \selector

the new selector to add

methodpubliccircularReference( ) : void
inherited

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()
methodpubliccreateAnd( ) : void
inherited

add an "And" selector entry on the selector list

Inherited from: \AbstractFileSet::createAnd()\FileSet::createAnd()
methodpubliccreateContains( ) : void
inherited

add a contains selector entry on the selector list

Inherited from: \AbstractFileSet::createContains()\FileSet::createContains()
methodpubliccreateContainsRegexp( ) : void
inherited

add a contains selector entry on the selector list

Inherited from: \AbstractFileSet::createContainsRegexp()\FileSet::createContainsRegexp()
methodpubliccreateCustom( ) : void
inherited

add an extended selector entry on the selector list

Inherited from: \AbstractFileSet::createCustom()\FileSet::createCustom()
methodpubliccreateDate( ) : void
inherited

add a selector date entry on the selector list

Inherited from: \AbstractFileSet::createDate()\FileSet::createDate()
methodpubliccreateDepend( ) : void
inherited

add a depends selector entry on the selector list

Inherited from: \AbstractFileSet::createDepend()\FileSet::createDepend()
methodpubliccreateDepth( ) : void
inherited

add a depth selector entry on the selector list

Inherited from: \AbstractFileSet::createDepth()\FileSet::createDepth()
methodpubliccreateExclude( ) : void
inherited

add a name entry on the exclude list

Inherited from: \AbstractFileSet::createExclude()\FileSet::createExclude()
methodpubliccreateExcludesFile( ) : void
inherited

add a name entry on the include files list

Inherited from: \AbstractFileSet::createExcludesFile()\FileSet::createExcludesFile()
methodpubliccreateFilename( ) : void
inherited

add a selector filename entry on the selector list

Inherited from: \AbstractFileSet::createFilename()\FileSet::createFilename()
methodpubliccreateInclude( ) : void
inherited

add a name entry on the include list

Inherited from: \AbstractFileSet::createInclude()\FileSet::createInclude()
methodpubliccreateIncludesFile( ) : void
inherited

add a name entry on the include files list

Inherited from: \AbstractFileSet::createIncludesFile()\FileSet::createIncludesFile()
methodpubliccreateMajority( ) : void
inherited

add a majority selector entry on the selector list

Inherited from: \AbstractFileSet::createMajority()\FileSet::createMajority()
methodpubliccreateNone( ) : void
inherited

add a "None" selector entry on the selector list

Inherited from: \AbstractFileSet::createNone()\FileSet::createNone()
methodpubliccreateNot( ) : void
inherited

add a "Not" selector entry on the selector list

Inherited from: \AbstractFileSet::createNot()\FileSet::createNot()
methodpubliccreateOr( ) : void
inherited

add an "Or" selector entry on the selector list

Inherited from: \AbstractFileSet::createOr()\FileSet::createOr()
methodpubliccreatePatternSet( ) : void
methodpubliccreatePresent( ) : void
inherited

add a present selector entry on the selector list

Inherited from: \AbstractFileSet::createPresent()\FileSet::createPresent()
methodpubliccreateSelector( ) : void
inherited

add a "Select" selector entry on the selector list

Inherited from: \AbstractFileSet::createSelector()\FileSet::createSelector()
methodpubliccreateSize( ) : void
inherited

add a selector size entry on the selector list

Inherited from: \AbstractFileSet::createSize()\FileSet::createSize()
methodpubliccreateType( ) : void
inherited

add a type selector entry on the selector list

Inherited from: \AbstractFileSet::createType()\FileSet::createType()
methodpublicdieOnCircularReference(  $stk,  $p ) : void
inherited

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.

Parameters
Name Type Description
$stk
$p
methodpublicgetCheckedRef(  $requiredClass,  $dataTypeName ) : void
inherited

Performs the check for circular references and returns the referenced object.

Inherited from: \DataType::getCheckedRef()\AbstractFileSet::getCheckedRef()\FileSet::getCheckedRef()
Parameters
Name Type Description
$requiredClass
$dataTypeName
methodpublicgetDescription( ) : void
inherited

Return the description for the current data type.

Inherited from: \DataType::getDescription()\AbstractFileSet::getDescription()\FileSet::getDescription()
methodpublicgetDir( ) : \PhingFile

Returns the base directory all package files are relative to

Returns
Type Description
\PhingFile Base directory
methodpublicgetDirectoryScanner( \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
methodpublicgetProject( ) : \Project
Returns
Type Description
\Project Reference to current porject object
methodpublicgetRef(  $p ) : void
inherited

Performs the check for circular references and returns the referenced FileSet.

Inherited from: \AbstractFileSet::getRef()\FileSet::getRef()
Parameters
Name Type Description
$p
methodpublicgetSelectors(  $p ) : \an
inherited

Returns the set of selectors as an array.

Inherited from: \AbstractFileSet::getSelectors()\FileSet::getSelectors()
Parameters
Name Type Description
$p
Returns
Type Description
\an array of selectors in this container
methodpublichasPatterns( ) : boolean
inherited

Indicates whether there are any patterns here.

Inherited from: \AbstractFileSet::hasPatterns()\FileSet::hasPatterns()
Returns
Type Description
boolean Whether any patterns are in this container.
methodpublichasSelectors( ) : boolean
inherited

Indicates whether there are any selectors here.

Inherited from: \AbstractFileSet::hasSelectors()\FileSet::hasSelectors()
Returns
Type Description
boolean Whether any selectors are in this container
methodpublicisReference( ) : void
inherited

Has the refid attribute of this element been set?

Inherited from: \DataType::isReference()\AbstractFileSet::isReference()\FileSet::isReference()
methodprotectedloadPearPackageScanner( ) : void

Loads the package scanner instance into $this->pps

methodpubliclog( string $msg, integer $level = Project::MSG_INFO ) : void
inherited

Logs a message with the given priority.

Inherited from: \ProjectComponent::log()\DataType::log()\AbstractFileSet::log()\FileSet::log()
Parameters
Name Type Description
$msg string

The message to be logged.

$level integer

The message's priority at this message should have

methodpublicnoChildrenAllowed( ) : void
inherited

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()
methodpublicparsingComplete( ) : void
inherited

Template method being called when the data type has been parsed completely.

Inherited from: \DataType::parsingComplete()\AbstractFileSet::parsingComplete()\FileSet::parsingComplete()
methodpublicselectorCount( ) : int
inherited

Gives the count of the number of selectors in this container

Inherited from: \AbstractFileSet::selectorCount()\FileSet::selectorCount()
Returns
Type Description
int The number of selectors in this container
methodpublicselectorElements( ) : array
inherited

Returns an array for accessing the set of selectors.

Inherited from: \AbstractFileSet::selectorElements()\FileSet::selectorElements()
Returns
Type Description
array The array of selectors
methodpublicsetCaseSensitive(  $isCaseSensitive ) : void
inherited

Sets case sensitivity of the file system

Inherited from: \AbstractFileSet::setCaseSensitive()\FileSet::setCaseSensitive()
Parameters
Name Type Description
$isCaseSensitive
methodpublicsetConfig( string $config ) : void

Sets the full path to the PEAR configuration file

Parameters
Name Type Description
$config string

Configuration file

methodpublicsetDefaultexcludes( \$useDefaultExcludes $useDefaultExcludes ) : void
inherited

Sets whether default exclusions should be used or not.

Inherited from: \AbstractFileSet::setDefaultexcludes()\FileSet::setDefaultexcludes()
Parameters
Name Type Description
$useDefaultExcludes \$useDefaultExcludes

"true"|"on"|"yes" when default exclusions should be used, "false"|"off"|"no" when they shouldn't be used.

methodpublicsetDescription(  $desc ) : void
inherited

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()
Parameters
Name Type Description
$desc
methodpublicsetDir(  $dir ) : void
Parameters
Name Type Description
$dir
methodpublicsetExcludes(  $excludes ) : void
inherited

Sets the set of exclude patterns. Patterns may be separated by a comma or a space.

Inherited from: \AbstractFileSet::setExcludes()\FileSet::setExcludes()
Parameters
Name Type Description
$excludes
methodpublicsetExcludesfile( \$excl $excl ) : void
inherited

Sets the name of the file containing the includes patterns.

Inherited from: \AbstractFileSet::setExcludesfile()\FileSet::setExcludesfile()
Parameters
Name Type Description
$excl \$excl

The file to fetch the exclude patterns from.

Throws
Exception Description
\BE
methodpublicsetExpandSymbolicLinks(  $expandSymbolicLinks ) : void
inherited

Sets whether to expand/dereference symbolic links, default is false

Inherited from: \AbstractFileSet::setExpandSymbolicLinks()\FileSet::setExpandSymbolicLinks()
Parameters
Name Type Description
$expandSymbolicLinks
Details
boolean
methodpublicsetIncludes(  $includes ) : void
inherited

Sets the set of include patterns. Patterns may be separated by a comma or a space.

Inherited from: \AbstractFileSet::setIncludes()\FileSet::setIncludes()
Parameters
Name Type Description
$includes
methodpublicsetIncludesfile( \$incl $incl ) : void
inherited

Sets the name of the file containing the includes patterns.

Inherited from: \AbstractFileSet::setIncludesfile()\FileSet::setIncludesfile()
Parameters
Name Type Description
$incl \$incl

The file to fetch the include patterns from.

Throws
Exception Description
\BE
methodpublicsetPackage( 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

methodpublicsetProject( \Project $project ) : void
inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()\DataType::setProject()\AbstractFileSet::setProject()\FileSet::setProject()
Parameters
Name Type Description
$project \Project

The reference to the current project

methodpublicsetRefid( \Reference $r ) : void
inherited

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.

Parameters
Name Type Description
$r \Reference
methodpublicsetRole( 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

methodprotectedsetupDirectoryScanner(  $ds,  $p ) : void
inherited

feed dirscanner with infos defined by this fileset

Inherited from: \AbstractFileSet::setupDirectoryScanner()\FileSet::setupDirectoryScanner()
Parameters
Name Type Description
$ds
$p
methodpublictooManyAttributes( ) : void
inherited

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()
Documentation was generated by DocBlox 0.18.1.