# 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: UntarTask.php 526 2009-08-11 12:11:17Z mrook $

## \UntarTask
jump to top

Package: phing\tasks\ext

Extracts one or several tar archives using PEAR Archive_Tar

Parent(s)
  \ExtractBaseTask < \MatchingTask < \Task < \ProjectComponent
Author
  Joakim Bodin
Since
  2.2.0
Version
  $Id: UntarTask.php 526 2009-08-11 12:11:17Z mrook $

### Properties

`\PhingFile $file= ''`
inherited

Inherited from: \ExtractBaseTask::$$file
Details

Type
  \PhingFile
Inherited_from
  \ExtractBaseTask::$$file

`$filesets= 'array()'`
inherited Inherited from: \ExtractBaseTask::$$filesets
Default value `array()`Details

Type
  n/a
Inherited_from
  \ExtractBaseTask::$$filesets

`boolean $forceExtract= 'false'`
inherited

Set to true to always extract (and possibly overwrite) all files from the archive

Inherited from: \ExtractBaseTask::$$forceExtract
Default value `false` Details

Type
  boolean
Inherited_from
  \ExtractBaseTask::$$forceExtract

`$removepath= ''`
inherited Inherited from: \ExtractBaseTask::$$removepath
Details

Type
  n/a
Inherited_from
  \ExtractBaseTask::$$removepath

`\PhingFile $todir= ''`
inherited

Inherited from: \ExtractBaseTask::$$todir
Details

Type
  \PhingFile
Inherited_from
  \ExtractBaseTask::$$todir

### Methods

`__construct( ) : void`
inherited

Inherited from: MatchingTask::__construct()\ExtractBaseTask::__construct()
`appendSelector( ) : void`
inherited

Inherited from: MatchingTask::appendSelector()\ExtractBaseTask::appendSelector()
`createAnd( ) : void`
inherited

Inherited from: MatchingTask::createAnd()\ExtractBaseTask::createAnd()
`createContains( ) : void`
inherited

Inherited from: MatchingTask::createContains()\ExtractBaseTask::createContains()
`createCustom( ) : void`
inherited

Inherited from: MatchingTask::createCustom()\ExtractBaseTask::createCustom()
`createDate( ) : void`
inherited

Inherited from: MatchingTask::createDate()\ExtractBaseTask::createDate()
`createDepend( ) : void`
inherited

Inherited from: MatchingTask::createDepend()\ExtractBaseTask::createDepend()
`createDepth( ) : void`
inherited

Inherited from: MatchingTask::createDepth()\ExtractBaseTask::createDepth()
`createExclude( ) : void`
inherited

Inherited from: MatchingTask::createExclude()\ExtractBaseTask::createExclude()
`createExcludesFile( ) : void`
inherited

Inherited from: MatchingTask::createExcludesFile()\ExtractBaseTask::createExcludesFile()
`createFileSet( ) : \FileSet`
inherited

Add a new fileset.

Inherited from: \ExtractBaseTask::createFileSet()
Returns

Type | Description
--- | ---
\FileSet |

`createFilename( ) : void`
inherited

Inherited from: MatchingTask::createFilename()\ExtractBaseTask::createFilename()
`createInclude( ) : void`
inherited

Inherited from: MatchingTask::createInclude()\ExtractBaseTask::createInclude()
`createIncludesFile( ) : void`
inherited

Inherited from: MatchingTask::createIncludesFile()\ExtractBaseTask::createIncludesFile()
`createMajority( ) : void`
inherited

Inherited from: MatchingTask::createMajority()\ExtractBaseTask::createMajority()
`createNone( ) : void`
inherited

Inherited from: MatchingTask::createNone()\ExtractBaseTask::createNone()
`createNot( ) : void`
inherited

Inherited from: MatchingTask::createNot()\ExtractBaseTask::createNot()
`createOr( ) : void`
inherited

Inherited from: MatchingTask::createOr()\ExtractBaseTask::createOr()
`createPatternSet( ) : void`
inherited

Inherited from: MatchingTask::createPatternSet()\ExtractBaseTask::createPatternSet()
`createPresent( ) : void`
inherited

Inherited from: MatchingTask::createPresent()\ExtractBaseTask::createPresent()
`createSelector( ) : void`
inherited

Inherited from: MatchingTask::createSelector()\ExtractBaseTask::createSelector()
`createSize( ) : void`
inherited

Inherited from: MatchingTask::createSize()\ExtractBaseTask::createSize()
`extractArchive( $tarfile ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$tarfile |  |

`getDescription( ) : void`
inherited

Inherited from: Task::getDescription()\ExtractBaseTask::getDescription()
`getDirectoryScanner( ) : void`
inherited

Inherited from: MatchingTask::getDirectoryScanner()\ExtractBaseTask::getDirectoryScanner()
`getImplicitFileSet( ) : void`
final inherited

Inherited from: MatchingTask::getImplicitFileSet()\ExtractBaseTask::getImplicitFileSet()
`getLocation( ) : void`
inherited

Inherited from: Task::getLocation()\ExtractBaseTask::getLocation()
`getOwningTarget( ) : void`
inherited

Inherited from: Task::getOwningTarget()\ExtractBaseTask::getOwningTarget()
`getProject( ) : void`
inherited

Inherited from: ProjectComponent::getProject()\ExtractBaseTask::getProject()
`getRegisterSlot( ) : void`
inherited

Inherited from: Task::getRegisterSlot()\ExtractBaseTask::getRegisterSlot()
`getRuntimeConfigurableWrapper( ) : void`
inherited

Inherited from: Task::getRuntimeConfigurableWrapper()\ExtractBaseTask::getRuntimeConfigurableWrapper()
`getSelectors( ) : void`
inherited

Inherited from: MatchingTask::getSelectors()\ExtractBaseTask::getSelectors()
`getTaskName( ) : void`
inherited

Inherited from: Task::getTaskName()\ExtractBaseTask::getTaskName()
`getTaskType( ) : void`
inherited

Inherited from: Task::getTaskType()\ExtractBaseTask::getTaskType()
`hasSelectors( ) : void`
inherited

Inherited from: MatchingTask::hasSelectors()\ExtractBaseTask::hasSelectors()
`init( ) : void`

Ensures that PEAR lib exists.

`initTar( \PhingFile $tarfile ) : \Archive_Tar`

Init a Archive_Tar class with correct compression for the given file.

Parameters

Name | Type | Description
--- | --- | ---
$tarfile | \PhingFile |

Returns

Type | Description
--- | ---
\Archive_Tar | the tar class instance

`isDestinationUpToDate( $compressedArchiveFile ) : boolean`
inherited

Inherited from: \ExtractBaseTask::isDestinationUpToDate()
Parameters

Name | Type | Description
--- | --- | ---
$compressedArchiveFile |  |

Returns

Type | Description
--- | ---
boolean |

`listArchiveContent( $tarfile ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$tarfile |  |

`log( ) : void`
inherited

Inherited from: Task::log()\ExtractBaseTask::log()
`main( ) : void`
inherited

do the work

Inherited from: \ExtractBaseTask::main()
Throws

Exception | Description
--- | ---
\BuildException |

`maybeConfigure( ) : void`
inherited

Inherited from: Task::maybeConfigure()\ExtractBaseTask::maybeConfigure()
`perform( ) : void`
inherited

Inherited from: Task::perform()\ExtractBaseTask::perform()
`selectorCount( ) : void`
inherited

Inherited from: MatchingTask::selectorCount()\ExtractBaseTask::selectorCount()
`selectorElements( ) : void`
inherited

Inherited from: MatchingTask::selectorElements()\ExtractBaseTask::selectorElements()
`setCaseSensitive( ) : void`
inherited

Inherited from: MatchingTask::setCaseSensitive()\ExtractBaseTask::setCaseSensitive()
`setDefaultexcludes( ) : void`
inherited

Inherited from: MatchingTask::setDefaultexcludes()\ExtractBaseTask::setDefaultexcludes()
`setDescription( ) : void`
inherited

Inherited from: Task::setDescription()\ExtractBaseTask::setDescription()
`setExcludes( ) : void`
inherited

Inherited from: MatchingTask::setExcludes()\ExtractBaseTask::setExcludes()
`setExcludesfile( ) : void`
inherited

Inherited from: MatchingTask::setExcludesfile()\ExtractBaseTask::setExcludesfile()
`setFile( \PhingFile $file ) : void`
inherited

Set the name of the zip file to extract.

Inherited from: \ExtractBaseTask::setFile()
Parameters

Name | Type | Description
--- | --- | ---
$file | \PhingFile | zip file to extract

`setFollowSymlinks( ) : void`
inherited

Inherited from: MatchingTask::setFollowSymlinks()\ExtractBaseTask::setFollowSymlinks()
`setForceExtract( boolean $forceExtract ) : void`
inherited

Sets the forceExtract attribute

Inherited from: \ExtractBaseTask::setForceExtract()
Parameters

Name | Type | Description
--- | --- | ---
$forceExtract | boolean |

`setIncludes( ) : void`
inherited

Inherited from: MatchingTask::setIncludes()\ExtractBaseTask::setIncludes()
`setIncludesfile( ) : void`
inherited

Inherited from: MatchingTask::setIncludesfile()\ExtractBaseTask::setIncludesfile()
`setLocation( ) : void`
inherited

Inherited from: Task::setLocation()\ExtractBaseTask::setLocation()
`setOwningTarget( ) : void`
inherited

Inherited from: Task::setOwningTarget()\ExtractBaseTask::setOwningTarget()
`setProject( ) : void`
inherited

Inherited from: MatchingTask::setProject()\ExtractBaseTask::setProject()
`setRemovePath( $removepath ) : void`
inherited

Inherited from: \ExtractBaseTask::setRemovePath()
Parameters

Name | Type | Description
--- | --- | ---
$removepath |  |

`setRuntimeConfigurableWrapper( ) : void`
inherited

Inherited from: Task::setRuntimeConfigurableWrapper()\ExtractBaseTask::setRuntimeConfigurableWrapper()
`setTaskName( ) : void`
inherited

Inherited from: Task::setTaskName()\ExtractBaseTask::setTaskName()
`setTaskType( ) : void`
inherited

Inherited from: Task::setTaskType()\ExtractBaseTask::setTaskType()
`setToDir( $todir ) : void`
inherited

This is the base directory to look in for things to zip.

Inherited from: \ExtractBaseTask::setToDir()
Parameters

Name | Type | Description
--- | --- | ---
$todir |  |

`validateAttributes( ) : void`
inherited

Validates attributes coming in from XML

Inherited from: \ExtractBaseTask::validateAttributes()
Throws

Exception | Description
--- | ---
\BuildException |

Details

Access
  private

Documentation was generated by DocBlox 0.17.1.