tasks/ext/UntarTask.php
Extracts one or several tar archives using PEAR Archive_Tar
- Author
- Joakim Bodin
- Package
- phing.tasks.ext
- Since
- 2.2.0
- Version
- $Id: f77612833e0415725e7b816a0515db4a4f0f4c93 $
\UntarTask
Extracts one or several tar archives using PEAR Archive_Tar
This is very closely based on the ANT class of the same name.
- Parent(s)
- \ExtractBaseTask < \MatchingTask < \SelectorContainer < \ProjectComponent
- Author
- Joakim Bodin
- Copyright
- 2001,2002 THYRELL. All rights reserved
- Since
- 2.2.0
- Version
- $Id: f77612833e0415725e7b816a0515db4a4f0f4c93 $
Properties


string
$description= ''
Description of the task
Inherited from: \Task::$$description\MatchingTask::$$description\ExtractBaseTask::$$description- Type
- string
- Inherited_from
- \Task::$$description
- Inherited_from
- \MatchingTask::$$description
- Inherited_from
- \ExtractBaseTask::$$description


\PhingFile
$file= ''
- Type
- \PhingFile
- Inherited_from
- \ExtractBaseTask::$$file


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


$filesets= 'array()'
array()
Details- Type
- n/a
- Inherited_from
- \ExtractBaseTask::$$filesets


boolean
$forceExtract= 'false'
Set to true to always extract (and possibly overwrite) all files from the archive
Inherited from: \ExtractBaseTask::$$forceExtractfalse
Details- Type
- boolean
- Inherited_from
- \ExtractBaseTask::$$forceExtract


\Location
$location= ''
Stored buildfile location
Inherited from: \Task::$$location\MatchingTask::$$location\ExtractBaseTask::$$location- Type
- \Location
- Inherited_from
- \Task::$$location
- Inherited_from
- \MatchingTask::$$location
- Inherited_from
- \ExtractBaseTask::$$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::$$project\ExtractBaseTask::$$projectnull
Details- Type
- \Project
- Inherited_from
- \ProjectComponent::$$project
- Inherited_from
- \Task::$$project
- Inherited_from
- \MatchingTask::$$project
- Inherited_from
- \ExtractBaseTask::$$project


$removepath= ''
- Type
- n/a
- Inherited_from
- \ExtractBaseTask::$$removepath


\Target
$target= ''
Owning Target object
Inherited from: \Task::$$target\MatchingTask::$$target\ExtractBaseTask::$$target- Type
- \Target
- Inherited_from
- \Task::$$target
- Inherited_from
- \MatchingTask::$$target
- Inherited_from
- \ExtractBaseTask::$$target


string
$taskName= ''
Taskname for logger
Inherited from: \Task::$$taskName\MatchingTask::$$taskName\ExtractBaseTask::$$taskName- Type
- string
- Inherited_from
- \Task::$$taskName
- Inherited_from
- \MatchingTask::$$taskName
- Inherited_from
- \ExtractBaseTask::$$taskName


string
$taskType= ''
Internal taskname (req)
Inherited from: \Task::$$taskType\MatchingTask::$$taskType\ExtractBaseTask::$$taskType- Type
- string
- Inherited_from
- \Task::$$taskType
- Inherited_from
- \MatchingTask::$$taskType
- Inherited_from
- \ExtractBaseTask::$$taskType


\PhingFile
$todir= ''
- Type
- \PhingFile
- Inherited_from
- \ExtractBaseTask::$$todir


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


\RuntimeConfigurable
$wrapper= ''
Wrapper of the task
Inherited from: \Task::$$wrapper\MatchingTask::$$wrapper\ExtractBaseTask::$$wrapper- Type
- \RuntimeConfigurable
- Inherited_from
- \Task::$$wrapper
- Inherited_from
- \MatchingTask::$$wrapper
- Inherited_from
- \ExtractBaseTask::$$wrapper
Methods


__construct(
)
:
void
Create instance; set fileset to new FileSet.
Inherited from: \MatchingTask::__construct()\ExtractBaseTask::__construct()

appendSelector(
\FileSelector $selector
)
:
void
Add a new selector into this container.
Inherited from: \MatchingTask::appendSelector()\ExtractBaseTask::appendSelector()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()\ExtractBaseTask::createAnd()Type | Description |
---|---|
\AndSelector |


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


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


createDate(
)
:
\DateSelector
add a selector date entry on the selector list
Inherited from: \MatchingTask::createDate()\ExtractBaseTask::createDate()Type | Description |
---|---|
\DateSelector |


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


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


createExclude(
)
:
\PatternSetNameEntry
add a name entry on the exclude list
Inherited from: \MatchingTask::createExclude()\ExtractBaseTask::createExclude()Type | Description |
---|---|
\PatternSetNameEntry |


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


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


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


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


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


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


createNot(
)
:
\NotSelector
add a "Not" selector entry on the selector list
Inherited from: \MatchingTask::createNot()\ExtractBaseTask::createNot()Type | Description |
---|---|
\NotSelector |


createOr(
)
:
void
add an "Or" selector entry on the selector list
Inherited from: \MatchingTask::createOr()\ExtractBaseTask::createOr()

createPatternSet(
)
:
\PatternSet
add a set of patterns
Inherited from: \MatchingTask::createPatternSet()\ExtractBaseTask::createPatternSet()Type | Description |
---|---|
\PatternSet |


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


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


createSize(
)
:
\SizeSelector
add a selector size entry on the selector list
Inherited from: \MatchingTask::createSize()\ExtractBaseTask::createSize()Type | Description |
---|---|
\SizeSelector |


getDescription(
)
:
string
Returns the textual description of the task
Inherited from: \Task::getDescription()\MatchingTask::getDescription()\ExtractBaseTask::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()\ExtractBaseTask::getDirectoryScanner()Name | Type | Description |
---|---|---|
$baseDir |
Type | Description |
---|---|
\DirectoryScanner |


getImplicitFileSet(
)
:
\FileSet
Accessor for the implict fileset.
Inherited from: \MatchingTask::getImplicitFileSet()\ExtractBaseTask::getImplicitFileSet()Type | Description |
---|---|
\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()\ExtractBaseTask::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()\ExtractBaseTask::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()\ExtractBaseTask::getProject()Type | Description |
---|---|
\Project | Reference to current porject object |


getRegisterSlot(
string $slotName
)
:
void
Returns a name
Inherited from: \Task::getRegisterSlot()\MatchingTask::getRegisterSlot()\ExtractBaseTask::getRegisterSlot()Name | Type | Description |
---|---|---|
$slotName | string |


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


getSelectors(
$p
)
:
array
Returns the set of selectors as an array.
Inherited from: \MatchingTask::getSelectors()\ExtractBaseTask::getSelectors()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()\ExtractBaseTask::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()\ExtractBaseTask::getTaskType()Type | Description |
---|---|
string | The type of this task (XML Tag) |


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


init(
)
:
void
Ensures that PEAR lib exists.
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 |


initTar(
\PhingFile $tarfile
)
:
\Archive_Tar
Init a Archive_Tar class with correct compression for the given file.
Name | Type | Description |
---|---|---|
$tarfile | \PhingFile |
Type | Description |
---|---|
\Archive_Tar | the tar class instance |


isDestinationUpToDate(
$compressedArchiveFile
)
:
boolean
Name | Type | Description |
---|---|---|
$compressedArchiveFile |
Type | Description |
---|---|
boolean |


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


main(
)
:
void
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.
Exception | Description |
---|---|
\BuildException |


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

perform(
)
:
void
Perfrom this task
Inherited from: \Task::perform()\MatchingTask::perform()\ExtractBaseTask::perform()

selectorCount(
)
:
int
Gives the count of the number of selectors in this container
Inherited from: \MatchingTask::selectorCount()\ExtractBaseTask::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()\ExtractBaseTask::selectorElements()Type | Description |
---|---|
\an | enumerator that goes through each of the selectors |


setCaseSensitive(
boolean $isCaseSensitive
)
:
void
Sets case sensitivity of the file system
Inherited from: \MatchingTask::setCaseSensitive()\ExtractBaseTask::setCaseSensitive()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()\ExtractBaseTask::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()\ExtractBaseTask::setDescription()Name | Type | Description |
---|---|---|
$desc | string | The text describing the task |


setExcludes(
string $excludes
)
:
void
Sets the set of exclude patterns. Patterns may be separated by a comma or a space.
Inherited from: \MatchingTask::setExcludes()\ExtractBaseTask::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()\ExtractBaseTask::setExcludesfile()Name | Type | Description |
---|---|---|
$excludesfile | \PhingFile | A string containing the filename to fetch the include patterns from. |


setFile(
\PhingFile $file
)
:
void
Name | Type | Description |
---|---|---|
$file | \PhingFile | zip file to extract |


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


setForceExtract(
boolean $forceExtract
)
:
void
Name | Type | Description |
---|---|---|
$forceExtract | boolean |


setIncludes(
string $includes
)
:
void
Sets the set of include patterns. Patterns may be separated by a comma or a space.
Inherited from: \MatchingTask::setIncludes()\ExtractBaseTask::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()\ExtractBaseTask::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()\ExtractBaseTask::setLocation()Name | Type | Description |
---|---|---|
$location | \Location | The location object describing the position of this task within the buildfile. |


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


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


setRemovePath(
$removepath
)
:
void
Name | Type | Description |
---|---|---|
$removepath |


setRuntimeConfigurableWrapper(
\RuntimeConfigurable $wrapper
)
:
void
Sets the wrapper object this task should use for runtime configurable elements.
Inherited from: \Task::setRuntimeConfigurableWrapper()\MatchingTask::setRuntimeConfigurableWrapper()\ExtractBaseTask::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()\ExtractBaseTask::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()\ExtractBaseTask::setTaskType()Name | Type | Description |
---|---|---|
$name | string | The type of this task (XML Tag) |


setToDir(
$todir
)
:
void
This is the base directory to look in for things to zip.
Inherited from: \ExtractBaseTask::setToDir()Name | Type | Description |
---|---|---|
$todir |


validateAttributes(
)
:
void
Validates attributes coming in from XML
Inherited from: \ExtractBaseTask::validateAttributes()Exception | Description |
---|---|
\BuildException |
- Access
- private