tasks/ext/PearPackageTask.php
inherited
Classes
\PearPackageTask
A task to create PEAR package.xml file.
This class uses the PEAR_PackageFileMaintainer class to perform the work.
This class is designed to be very flexible -- i.e. account for changes to the package.xml w/o requiring changes to this class. We've accomplished this by having generic
The
or
The
Here's an over-simple example of how this could be used:
Look at the build.xml in the Phing base directory (assuming you have the full distro / CVS version of Phing) to see a more complete example of how to call this script.
- Parent(s)
- \MatchingTask < \Task < \ProjectComponent
- Children
- \PearPackage2Task
- Author
- Hans Lellelid
- Version
- $Id: PearPackageTask.php 1162 2011-06-17 21:24:01Z mrook $
Properties
$dir= ''
Base directory for reading files.
- Type
- n/a
array
$filesets= 'array()'
array()Details- Type
- array
$mappings= 'array()'
Nested <mapping> (complex options) types.
array()Details- Type
- n/a
array
$options= 'array()'
array()Details- Type
- array
$package= ''
- Type
- n/a
$packageFile= ''
Package file
- Type
- n/a
\PEAR_PackageFileManager
$pkg= ''
- Type
- \PEAR_PackageFileManager
$preparedOptions= 'array()'
array()Details- Type
- n/a
\PearPkgRole[]
$roles= 'array()'
Nested <role> elements
array()Details- Type
- \PearPkgRole[]
Methods
__construct(
)
:
voidappendSelector(
)
:
voidcreateAnd(
)
:
voidcreateContains(
)
:
voidcreateCustom(
)
:
voidcreateDate(
)
:
voidcreateDepend(
)
:
voidcreateDepth(
)
:
voidcreateExclude(
)
:
voidcreateExcludesFile(
)
:
voidcreateFileSet(
)
:
\FileSetNested creator, creates a FileSet for this task
| Type | Description |
|---|---|
| \FileSet | The created fileset object |
createFilename(
)
:
voidcreateInclude(
)
:
voidcreateIncludesFile(
)
:
voidcreateMajority(
)
:
voidcreateMapping(
)
:
voidHandles nested generic
createNone(
)
:
voidcreateNot(
)
:
voidcreateOption(
)
:
voidHandles nested generic
createOr(
)
:
voidcreatePatternSet(
)
:
voidcreatePresent(
)
:
voidcreateSelector(
)
:
voidcreateSize(
)
:
voidfixDeps(
$deps
)
:
voidFixes the boolean in optional dependencies
| Name | Type | Description |
|---|---|---|
| $deps |
getDescription(
)
:
voidgetDirectoryScanner(
)
:
voidgetFileSets(
)
:
arrayUsed by the PEAR_PackageFileManager_PhingFileSet lister.
| Type | Description |
|---|---|
| array | FileSet[] |
getImplicitFileSet(
)
:
voidgetLocation(
)
:
voidgetOwningTarget(
)
:
voidgetProject(
)
:
voidgetRegisterSlot(
)
:
voidgetRuntimeConfigurableWrapper(
)
:
voidgetSelectors(
)
:
voidgetTaskName(
)
:
voidgetTaskType(
)
:
voidhasSelectors(
)
:
voidinit(
)
:
voidlog(
)
:
voidmain(
)
:
voidMain entry point.
maybeConfigure(
)
:
voidperform(
)
:
voidpopulateOptions(
)
:
voidAdds the options that are set via attributes and the nested tags to the options array.
selectorCount(
)
:
voidselectorElements(
)
:
voidsetCaseSensitive(
)
:
voidsetDefaultexcludes(
)
:
voidsetDescription(
)
:
voidsetDestFile(
$f
)
:
voidSets the file to use for generated package.xml
| Name | Type | Description |
|---|---|---|
| $f |
setDir(
\PhingFile $f
)
:
voidSets "dir" property from XML.
| Name | Type | Description |
|---|---|---|
| $f | \PhingFile |
setExcludes(
)
:
voidsetExcludesfile(
)
:
voidsetFollowSymlinks(
)
:
voidsetIncludes(
)
:
voidsetIncludesfile(
)
:
voidsetLocation(
)
:
voidsetName(
string $v
)
:
voidSets "name" property from XML.
| Name | Type | Description |
|---|---|---|
| $v | string |
setOptions(
)
:
voidSets PEAR package.xml options, based on class properties.
setOwningTarget(
)
:
voidsetPackage(
string $v
)
:
voidSet "package" property from XML.
| Name | Type | Description |
|---|---|---|
| $v | string |
- See
- \setName()
setProject(
)
:
voidsetRuntimeConfigurableWrapper(
)
:
voidsetTaskName(
)
:
voidsetTaskType(
)
:
void\PearPkgMapping
Handles complex options <mapping> elements which are hashes (assoc arrays).
Properties
Methods
\PearPkgMappingElement
Sub-element of <mapping>.
Properties
$elements= 'array()'
array()Details- Type
- n/a
$key= ''
- Type
- n/a
$value= ''
- Type
- n/a
Methods
createElement(
)
:
voidHandles nested
getKey(
)
:
voidgetValue(
)
:
mixedReturns either the simple value or the calculated value (array) of nested elements.
| Type | Description |
|---|---|
| mixed |
setKey(
$v
)
:
void| Name | Type | Description |
|---|---|---|
| $v |
setValue(
$v
)
:
void| Name | Type | Description |
|---|---|---|
| $v |
\PearPkgOption
Generic option class is used for non-complex options.
Properties
Methods
\PearPkgRole
Encapsulates file roles
Properties
Methods
getExtension(
)
:
stringRetrieves the file extension
| Type | Description |
|---|---|
| string |
getRole(
)
:
stringRetrieves the role
| Type | Description |
|---|---|
| string |
setExtension(
string $extension
)
:
voidSets the file extension
| Name | Type | Description |
|---|---|---|
| $extension | string |
setRole(
string $role
)
:
voidSets the role
| Name | Type | Description |
|---|---|---|
| $role | string |