tasks/ext/PearPackageTask.php
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.
- Author
- Hans Lellelid
- Package
- phing.tasks.ext
- Version
- $Id: 2078fd5bab3dd6dcea0345a12fce86a24586c765 $
\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 < \SelectorContainer < \ProjectComponent
- Children
- \PearPackage2Task
- Author
- Hans Lellelid
- Copyright
- 2001,2002 THYRELL. All rights reserved
- Version
- $Id: 2078fd5bab3dd6dcea0345a12fce86a24586c765 $
Properties


string
$description= ''
- Type
- string
- Inherited_from
- \Task::$$description
- Inherited_from
- \MatchingTask::$$description


\FileSet
$fileset= ''
- Type
- \FileSet
- Inherited_from
- \MatchingTask::$$fileset


\Location
$location= ''
- Type
- \Location
- Inherited_from
- \Task::$$location
- Inherited_from
- \MatchingTask::$$location


\Project
$project= 'null'
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\Task::$$project\MatchingTask::$$projectnull
Details- Type
- \Project
- Inherited_from
- \ProjectComponent::$$project
- Inherited_from
- \Task::$$project
- Inherited_from
- \MatchingTask::$$project


\PearPkgRole[]
$roles= 'array()'
Nested <role> elements
array()
Details- Type
- \PearPkgRole[]


\Target
$target= ''
- Type
- \Target
- Inherited_from
- \Task::$$target
- Inherited_from
- \MatchingTask::$$target


string
$taskName= ''
- Type
- string
- Inherited_from
- \Task::$$taskName
- Inherited_from
- \MatchingTask::$$taskName


string
$taskType= ''
- Type
- string
- Inherited_from
- \Task::$$taskType
- Inherited_from
- \MatchingTask::$$taskType


boolean
$useDefaultExcludes= 'true'
true
Details- Type
- boolean
- Inherited_from
- \MatchingTask::$$useDefaultExcludes


\RuntimeConfigurable
$wrapper= ''
- Type
- \RuntimeConfigurable
- Inherited_from
- \Task::$$wrapper
- Inherited_from
- \MatchingTask::$$wrapper
Methods


addFileSet(
$fs
)
:
void
Nested creator, creates a FileSet for this task
Name | Type | Description |
---|---|---|
$fs |


appendSelector(
\FileSelector $selector
)
:
void
Name | Type | Description |
---|---|---|
$selector | \FileSelector | the new selector to add |


createAnd(
)
:
\AndSelector
add an "And" selector entry on the selector list
Inherited from: \MatchingTask::createAnd()Type | Description |
---|---|
\AndSelector |


createContains(
)
:
\ContainsSelector
add a contains selector entry on the selector list
Inherited from: \MatchingTask::createContains()Type | Description |
---|---|
\ContainsSelector |


createCustom(
)
:
\ExtendSelector
add an extended selector entry on the selector list
Inherited from: \MatchingTask::createCustom()Type | Description |
---|---|
\ExtendSelector |


createDepend(
)
:
\DependSelector
add a depends selector entry on the selector list
Inherited from: \MatchingTask::createDepend()Type | Description |
---|---|
\DependSelector |


createDepth(
)
:
\DepthSelector
add a depth selector entry on the selector list
Inherited from: \MatchingTask::createDepth()Type | Description |
---|---|
\DepthSelector |


createExcludesFile(
)
:
\PatternSetNameEntry
add a name entry on the include files list
Inherited from: \MatchingTask::createExcludesFile()Type | Description |
---|---|
\PatternSetNameEntry |


createFilename(
)
:
\FilenameSelector
add a selector filename entry on the selector list
Inherited from: \MatchingTask::createFilename()Type | Description |
---|---|
\FilenameSelector |


createIncludesFile(
)
:
\PatternSetNameEntry
add a name entry on the include files list
Inherited from: \MatchingTask::createIncludesFile()Type | Description |
---|---|
\PatternSetNameEntry |


createMajority(
)
:
\MajoritySelector
add a majority selector entry on the selector list
Inherited from: \MatchingTask::createMajority()Type | Description |
---|---|
\MajoritySelector |


createNone(
)
:
\NoneSelector
add a "None" selector entry on the selector list
Inherited from: \MatchingTask::createNone()Type | Description |
---|---|
\NoneSelector |


createPresent(
)
:
\PresentSelector
add a present selector entry on the selector list
Inherited from: \MatchingTask::createPresent()Type | Description |
---|---|
\PresentSelector |


createSelector(
)
:
\SelectSelector
add a "Select" selector entry on the selector list
Inherited from: \MatchingTask::createSelector()Type | Description |
---|---|
\SelectSelector |


fixDeps(
$deps
)
:
void
Fixes the boolean in optional dependencies
Name | Type | Description |
---|---|---|
$deps |


getDescription(
)
:
string
Returns the textual description of the task
Inherited from: \Task::getDescription()\MatchingTask::getDescription()Type | Description |
---|---|
string | The text description of the task |


getDirectoryScanner(
$baseDir
)
:
\DirectoryScanner
Returns the directory scanner needed to access the files to process.
Inherited from: \MatchingTask::getDirectoryScanner()Name | Type | Description |
---|---|---|
$baseDir |
Type | Description |
---|---|
\DirectoryScanner |


getFileSets(
)
:
array
Used by the PEAR_PackageFileManager_PhingFileSet lister.
Type | Description |
---|---|
array | FileSet[] |


getLocation(
)
:
\Location
Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.
Inherited from: \Task::getLocation()\MatchingTask::getLocation()Type | Description |
---|---|
\Location | The location object describing the position of this task within the buildfile. |


getOwningTarget(
)
:
\Target
Returns the owning target of this task.
Inherited from: \Task::getOwningTarget()\MatchingTask::getOwningTarget()Type | Description |
---|---|
\Target | The target object that owns this task |


getProject(
)
:
\Project
Returns a reference to current project
Inherited from: \ProjectComponent::getProject()\Task::getProject()\MatchingTask::getProject()Type | Description |
---|---|
\Project | Reference to current porject object |


getRuntimeConfigurableWrapper(
)
:
\RuntimeConfigurable
Returns the wrapper object for runtime configuration
Inherited from: \Task::getRuntimeConfigurableWrapper()\MatchingTask::getRuntimeConfigurableWrapper()Type | Description |
---|---|
\RuntimeConfigurable | The wrapper object used by this task |


getSelectors(
$p
)
:
array
Name | Type | Description |
---|---|---|
$p |
Type | Description |
---|---|
array | FileSelector[] An array of selectors in this container |


getTaskName(
)
:
string
Returns the name of task, used only for log messages
Inherited from: \Task::getTaskName()\MatchingTask::getTaskName()Type | Description |
---|---|
string | Name of this task |


getTaskType(
)
:
string
Returns the name of the task under which it was invoked, usually the XML tagname
Inherited from: \Task::getTaskType()\MatchingTask::getTaskType()Type | Description |
---|---|
string | The type of this task (XML Tag) |


hasSelectors(
)
:
boolean
Indicates whether there are any selectors here.
Inherited from: \MatchingTask::hasSelectors()Type | Description |
---|---|
boolean | Whether any selectors are in this container |


init(
)
:
void
Called by the parser to let the task initialize properly.
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
Exception | Description |
---|---|
\BuildException |


log(
string $msg, integer $level
=
Project::MSG_INFO
)
:
void
Provides a project level log event to the task.
Inherited from: \Task::log()\MatchingTask::log()Name | Type | Description |
---|---|---|
$msg | string | The message to log |
$level | integer | The priority of the message |
- See
- \BuildEvent
- See
- \BuildListener


main(
)
:
void
Main entry point.
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.


maybeConfigure(
)
:
void
Configure this task if it hasn't been done already.
Inherited from: \Task::maybeConfigure()\MatchingTask::maybeConfigure()

populateOptions(
)
:
void
Adds the options that are set via attributes and the nested tags to the options array.


selectorCount(
)
:
int
Gives the count of the number of selectors in this container
Inherited from: \MatchingTask::selectorCount()Type | Description |
---|---|
int | The number of selectors in this container |


selectorElements(
)
:
\an
Returns an enumerator for accessing the set of selectors.
Inherited from: \MatchingTask::selectorElements()Type | Description |
---|---|
\an | enumerator that goes through each of the selectors |


setCaseSensitive(
boolean $isCaseSensitive
)
:
void
Name | Type | Description |
---|---|---|
$isCaseSensitive | boolean | "true"|"on"|"yes" if file system is case sensitive, "false"|"off"|"no" when not. |


setDefaultexcludes(
boolean $useDefaultExcludes
)
:
void
Sets whether default exclusions should be used or not.
Inherited from: \MatchingTask::setDefaultexcludes()Name | Type | Description |
---|---|---|
$useDefaultExcludes | boolean | "true"|"on"|"yes" when default exclusions should be used, "false"|"off"|"no" when they shouldn't be used. |


setDescription(
string $desc
)
:
void
Sets a textual description of the task
Inherited from: \Task::setDescription()\MatchingTask::setDescription()Name | Type | Description |
---|---|---|
$desc | string | The text describing the task |


setDestFile(
$f
)
:
void
Sets the file to use for generated package.xml
Name | Type | Description |
---|---|---|
$f |


setDir(
\PhingFile $f
)
:
void
Sets "dir" property from XML.
Name | Type | Description |
---|---|---|
$f | \PhingFile |


setExcludes(
string $excludes
)
:
void
Sets the set of exclude patterns. Patterns may be separated by a comma or a space.
Inherited from: \MatchingTask::setExcludes()Name | Type | Description |
---|---|---|
$excludes | string | the string containing the exclude patterns |


setExcludesfile(
\PhingFile $excludesfile
)
:
void
Sets the name of the file containing the includes patterns.
Inherited from: \MatchingTask::setExcludesfile()Name | Type | Description |
---|---|---|
$excludesfile | \PhingFile | A string containing the filename to fetch the include patterns from. |


setFollowSymlinks(
boolean $followSymlinks
)
:
void
Sets whether or not symbolic links should be followed.
Inherited from: \MatchingTask::setFollowSymlinks()Name | Type | Description |
---|---|---|
$followSymlinks | boolean | whether or not symbolic links should be followed |


setIncludes(
string $includes
)
:
void
Sets the set of include patterns. Patterns may be separated by a comma or a space.
Inherited from: \MatchingTask::setIncludes()Name | Type | Description |
---|---|---|
$includes | string | the string containing the include patterns |


setIncludesfile(
\PhingFile $includesfile
)
:
void
Sets the name of the file containing the includes patterns.
Inherited from: \MatchingTask::setIncludesfile()Name | Type | Description |
---|---|---|
$includesfile | \PhingFile | A string containing the filename to fetch the include patterns from. |


setLocation(
\Location $location
)
:
void
Sets the location within the buildfile this task occurs. Called by the parser to set location information.
Inherited from: \Task::setLocation()\MatchingTask::setLocation()Name | Type | Description |
---|---|---|
$location | \Location | The location object describing the position of this task within the buildfile. |


setName(
string $v
)
:
void
Sets "name" property from XML.
Name | Type | Description |
---|---|---|
$v | string |


setOwningTarget(
\Target $target
)
:
void
Sets the owning target this task belongs to.
Inherited from: \Task::setOwningTarget()\MatchingTask::setOwningTarget()Name | Type | Description |
---|---|---|
$target | \Target | Reference to owning target |


setPackage(
string $v
)
:
void
Set "package" property from XML.
Name | Type | Description |
---|---|---|
$v | string |
- See
- \setName()


setProject(
\Project $project
)
:
void
References the project to the current component.
Inherited from: \MatchingTask::setProject()Name | Type | Description |
---|---|---|
$project | \Project | The reference to the current project |


setRuntimeConfigurableWrapper(
\RuntimeConfigurable $wrapper
)
:
void
Sets the wrapper object this task should use for runtime configurable elements.
Inherited from: \Task::setRuntimeConfigurableWrapper()\MatchingTask::setRuntimeConfigurableWrapper()Name | Type | Description |
---|---|---|
$wrapper | \RuntimeConfigurable | The wrapper object this task should use |


setTaskName(
string $name
)
:
string
Sets the name of this task for log messages
Inherited from: \Task::setTaskName()\MatchingTask::setTaskName()Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
string | A string representing the name of this task for log |


setTaskType(
string $name
)
:
void
Sets the type of the task. Usually this is the name of the XML tag
Inherited from: \Task::setTaskType()\MatchingTask::setTaskType()Name | Type | Description |
---|---|---|
$name | string | The type of this task (XML Tag) |
\PearPkgMapping
Handles complex options <mapping> elements which are hashes (assoc arrays).
Properties
Methods
\PearPkgMappingElement
Sub-element of <mapping>.
Properties
Methods
\PearPkgOption
Generic option class is used for non-complex options.