classes/phing/tasks/ext/ExtractBaseTask.php
Classes
Base class for extracting tasks such as Unzip and Untar.
- author
- Joakim Bodin
- package
- phing.tasks.ext
- since
- 2.2.0
- version
- $Id: ExtractBaseTask.php 552 2009-08-29 12:18:13Z mrook $
\ExtractBaseTask
Base class for extracting tasks such as Unzip and Untar.
This is very closely based on the ANT class of the same name.
- Extends from
- \MatchingTask
- author
- Joakim Bodin
- copyright
- 2001,2002 THYRELL. All rights reserved
- package
- phing.tasks.ext
- since
- 2.2.0
- version
- $Id: ExtractBaseTask.php 552 2009-08-29 12:18:13Z mrook $
Properties
\PhingFile
$file= ''
- Type
- \PhingFile
$filesets= 'array'
Default value
arrayDetails- Type
$removepath= ''
Details
- Type
\PhingFile
$todir= ''
- Type
- \PhingFile
Methods
createFileSet(
)
:
\FileSetAdd a new fileset.
| Type | Description |
|---|---|
| \FileSet |
extractArchive(
$compressedArchiveFile
)
:
abstract
Parameters
| Name | Type | Description |
|---|---|---|
| $compressedArchiveFile |
isDestinationUpToDate(
$compressedArchiveFile
)
:
boolean
| Name | Type | Description |
|---|---|---|
| $compressedArchiveFile |
| Type | Description |
|---|---|
| boolean |
listArchiveContent(
$compressedArchiveFile
)
:
abstract
Parameters
| Name | Type | Description |
|---|---|---|
| $compressedArchiveFile |
main(
)
:
do the work
- throws
setFile(
\PhingFile $file
)
:
Set the name of the zip file to extract.
| Name | Type | Description |
|---|---|---|
| $file | \PhingFile | zip file to extract |
setRemovePath(
$removepath
)
:
Parameters
| Name | Type | Description |
|---|---|---|
| $removepath |
setToDir(
$todir
)
:
This is the base directory to look in for things to zip.
| Name | Type | Description |
|---|---|---|
| $todir |
validateAttributes(
)
:
voidValidates attributes coming in from XML
- access
- private
- throws