# tasks/ext/UnzipTask.php

## \UnzipTask
jump to top

Package: phing\tasks\ext

Extracts one or several zip archives using ZipArchive class.

This is very closely based on the ANT class of the same name.

Parent(s)
  \ExtractBaseTask < \MatchingTask < \Task < \ProjectComponent
Author
  Joakim Bodin
Author
  George Miroshnikov
Copyright
  2001,2002 THYRELL. All rights reserved
Version
  $Id: UnzipTask.php 526 2009-08-11 12:11:17Z mrook $

### Properties

`string $description= ''`
inherited

description of the taskInherited from: \Task::$description
Details

Type
  string
Inherited_from
  \Task::$description

`\PhingFile $file= ''`
inherited

Inherited from: \ExtractBaseTask::$file
Details

Type
  \PhingFile
Inherited_from
  \ExtractBaseTask::$file

`\FileSet $fileset= ''`
inherited

Inherited from: \MatchingTask::$fileset
Details

Type
  \FileSet
Inherited_from
  \MatchingTask::$fileset

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

Type
Inherited_from
  \ExtractBaseTask::$filesets

`\Location $location= ''`
inherited

stored buildfile locationInherited from: \Task::$location
Details

Type
  \Location
Inherited_from
  \Task::$location

`\Project $project= 'null'`
inherited

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
Default value `null` Details

Type
  \Project
Inherited_from
  \ProjectComponent::$project

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

Type
Inherited_from
  \ExtractBaseTask::$removepath

`\Target $target= ''`
inherited

owning Target objectInherited from: \Task::$target
Details

Type
  \Target
Inherited_from
  \Task::$target

`string $taskName= ''`
inherited

Taskname for loggerInherited from: \Task::$taskName
Details

Type
  string
Inherited_from
  \Task::$taskName

`string $taskType= ''`
inherited

internal taskname (req)Inherited from: \Task::$taskType
Details

Type
  string
Inherited_from
  \Task::$taskType

`\PhingFile $todir= ''`
inherited

Inherited from: \ExtractBaseTask::$todir
Details

Type
  \PhingFile
Inherited_from
  \ExtractBaseTask::$todir

`boolean $useDefaultExcludes= 'true'`
inherited

Inherited from: \MatchingTask::$useDefaultExcludes
Default value `true` Details

Type
  boolean
Inherited_from
  \MatchingTask::$useDefaultExcludes

`\RuntimeConfigurable $wrapper= ''`
inherited

wrapper of the taskInherited from: \Task::$wrapper
Details

Type
  \RuntimeConfigurable
Inherited_from
  \Task::$wrapper

### Methods

`__construct( ) : void`
inherited

Create instance; set fileset to new FileSet.

Inherited from: \MatchingTask::__construct()
`appendSelector( \FileSelector $selector ) : void`
inherited

Add a new selector into this container.

Inherited from: \MatchingTask::appendSelector()
Parameters

Name | Type | Description
--- | --- | ---
$selector | \FileSelector | the new selector to add

`createAnd( ) : \AndSelector`
inherited

add an "And" selector entry on the selector list

Inherited from: \MatchingTask::createAnd()
Returns

Type | Description
--- | ---
\AndSelector |

`createContains( ) : \ContainsSelector`
inherited

add a contains selector entry on the selector list

Inherited from: \MatchingTask::createContains()
Returns

Type | Description
--- | ---
\ContainsSelector |

`createCustom( ) : \ExtendSelector`
inherited

add an extended selector entry on the selector list

Inherited from: \MatchingTask::createCustom()
Returns

Type | Description
--- | ---
\ExtendSelector |

`createDate( ) : \DateSelector`
inherited

add a selector date entry on the selector list

Inherited from: \MatchingTask::createDate()
Returns

Type | Description
--- | ---
\DateSelector |

`createDepend( ) : \DependSelector`
inherited

add a depends selector entry on the selector list

Inherited from: \MatchingTask::createDepend()
Returns

Type | Description
--- | ---
\DependSelector |

`createDepth( ) : \DepthSelector`
inherited

add a depth selector entry on the selector list

Inherited from: \MatchingTask::createDepth()
Returns

Type | Description
--- | ---
\DepthSelector |

`createExclude( ) : \PatternSetNameEntry`
inherited

add a name entry on the exclude list

Inherited from: \MatchingTask::createExclude()
Returns

Type | Description
--- | ---
\PatternSetNameEntry |

`createExcludesFile( ) : \PatternSetNameEntry`
inherited

add a name entry on the include files list

Inherited from: \MatchingTask::createExcludesFile()
Returns

Type | Description
--- | ---
\PatternSetNameEntry |

`createFileSet( ) : \FileSet`
inherited

Add a new fileset.

Inherited from: \ExtractBaseTask::createFileSet()
Returns

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

`createFilename( ) : \FilenameSelector`
inherited

add a selector filename entry on the selector list

Inherited from: \MatchingTask::createFilename()
Returns

Type | Description
--- | ---
\FilenameSelector |

`createInclude( ) : \PatternSetNameEntry`
inherited

add a name entry on the include list

Inherited from: \MatchingTask::createInclude()
Returns

Type | Description
--- | ---
\PatternSetNameEntry |

`createIncludesFile( ) : \PatternSetNameEntry`
inherited

add a name entry on the include files list

Inherited from: \MatchingTask::createIncludesFile()
Returns

Type | Description
--- | ---
\PatternSetNameEntry |

`createMajority( ) : \MajoritySelector`
inherited

add a majority selector entry on the selector list

Inherited from: \MatchingTask::createMajority()
Returns

Type | Description
--- | ---
\MajoritySelector |

`createNone( ) : \NoneSelector`
inherited

add a "None" selector entry on the selector list

Inherited from: \MatchingTask::createNone()
Returns

Type | Description
--- | ---
\NoneSelector |

`createNot( ) : \NotSelector`
inherited

add a "Not" selector entry on the selector list

Inherited from: \MatchingTask::createNot()
Returns

Type | Description
--- | ---
\NotSelector |

`createOr( ) : void`
inherited

add an "Or" selector entry on the selector list

Inherited from: \MatchingTask::createOr()
`createPatternSet( ) : \PatternSet`
inherited

add a set of patterns

Inherited from: \MatchingTask::createPatternSet()
Returns

Type | Description
--- | ---
\PatternSet |

`createPresent( ) : \PresentSelector`
inherited

add a present selector entry on the selector list

Inherited from: \MatchingTask::createPresent()
Returns

Type | Description
--- | ---
\PresentSelector |

`createSelector( ) : \SelectSelector`
inherited

add a "Select" selector entry on the selector list

Inherited from: \MatchingTask::createSelector()
Returns

Type | Description
--- | ---
\SelectSelector |

`createSize( ) : \SizeSelector`
inherited

add a selector size entry on the selector list

Inherited from: \MatchingTask::createSize()
Returns

Type | Description
--- | ---
\SizeSelector |

`extractArchive( \PhingFile $zipfile ) : boolean`

Extract archive content into $this->todir directory

Parameters

Name | Type | Description
--- | --- | ---
$zipfile | \PhingFile | Zip file to extract

Returns

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

`getDescription( ) : string`
inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()
Returns

Type | Description
--- | ---
string | The text description of the task

`getDirectoryScanner( $baseDir ) : \DirectoryScanner`
inherited

Returns the directory scanner needed to access the files to process.

Inherited from: \MatchingTask::getDirectoryScanner()
Parameters

Name | Type | Description
--- | --- | ---
$baseDir |  |

Returns

Type | Description
--- | ---
\DirectoryScanner |

`getImplicitFileSet( ) : \FileSet`
final inherited

Accessor for the implict fileset.

Inherited from: \MatchingTask::getImplicitFileSet()
Returns

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

`getLocation( ) : \Location`
inherited

Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.

Inherited from: \Task::getLocation()
Returns

Type | Description
--- | ---
\Location | The location object describing the position of this task within the buildfile.

`getOwningTarget( ) : \Target`
inherited

Returns the owning target of this task.

Inherited from: \Task::getOwningTarget()
Returns

Type | Description
--- | ---
\Target | The target object that owns this task

`getProject( ) : \Project`
inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()
Returns

Type | Description
--- | ---
\Project | Reference to current porject object

`getRegisterSlot( $slotName ) : void`
inherited

Returns a name

Inherited from: \Task::getRegisterSlot()
Parameters

Name | Type | Description
--- | --- | ---
$slotName |  |

`getRuntimeConfigurableWrapper( ) : \RuntimeConfigurable`
inherited

Returns the wrapper object for runtime configuration

Inherited from: \Task::getRuntimeConfigurableWrapper()
Returns

Type | Description
--- | ---
\RuntimeConfigurable | The wrapper object used by this task

`getSelectors( $p ) : array`
inherited

Returns the set of selectors as an array.

Inherited from: \MatchingTask::getSelectors()
Parameters

Name | Type | Description
--- | --- | ---
$p |  |

Returns

Type | Description
--- | ---
array | FileSelector[] An array of selectors in this container

`getTaskName( ) : string`
inherited

Returns the name of task, used only for log messages

Inherited from: \Task::getTaskName()
Returns

Type | Description
--- | ---
string | Name of this task

`getTaskType( ) : string`
inherited

Returns the name of the task under which it was invoked, usually the XML tagname

Inherited from: \Task::getTaskType()
Returns

Type | Description
--- | ---
string | The type of this task (XML Tag)

`hasSelectors( ) : boolean`
inherited

Indicates whether there are any selectors here.

Inherited from: \MatchingTask::hasSelectors()
Returns

Type | Description
--- | ---
boolean | Whether any selectors are in this container

`init( ) : void`
inherited

Called by the parser to let the task initialize properly.

Inherited from: \Task::init()

Should throw a BuildException if something goes wrong with the build

This is abstract here, but may not be overloaded by subclasses.

Throws

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

`isDestinationUpToDate( $compressedArchiveFile ) : boolean`
inherited

Inherited from: \ExtractBaseTask::isDestinationUpToDate()
Parameters

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

Returns

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

`listArchiveContent( \PhingFile $zipfile ) : array`

List archive content

Parameters

Name | Type | Description
--- | --- | ---
$zipfile | \PhingFile | Zip file to list content

Returns

Type | Description
--- | ---
array | List of files inside $zipfile

`log( string $msg, integer $level = Project::MSG_INFO ) : void`
inherited

Provides a project level log event to the task.

Inherited from: \Task::log()

@param string $msg The message to be logged.

Parameters

Name | Type | Description
--- | --- | ---
$msg | string | The message to log
$level | integer | The priority of the message

Details

See
  \BuildEvent
See
  \BuildListener

`main( ) : void`
inherited

do the work

Inherited from: \ExtractBaseTask::main()

Should throw a BuildException if someting goes wrong with the build

This is abstract here. Must be overloaded by real tasks.

Throws

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

`maybeConfigure( ) : void`
inherited

Configure this task if it hasn't been done already.

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

Perfrom this task

Inherited from: \Task::perform()
`selectorCount( ) : int`
inherited

Gives the count of the number of selectors in this container

Inherited from: \MatchingTask::selectorCount()
Returns

Type | Description
--- | ---
int | The number of selectors in this container

`selectorElements( ) : \an`
inherited

Returns an enumerator for accessing the set of selectors.

Inherited from: \MatchingTask::selectorElements()
Returns

Type | Description
--- | ---
\an | enumerator that goes through each of the selectors

`setCaseSensitive( boolean $isCaseSensitive ) : void`
inherited

Sets case sensitivity of the file system

Inherited from: \MatchingTask::setCaseSensitive()
Parameters

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

`setDefaultexcludes( boolean $useDefaultExcludes ) : void`
inherited

Sets whether default exclusions should be used or not.

Inherited from: \MatchingTask::setDefaultexcludes()
Parameters

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`
inherited

Sets a textual description of the task

Inherited from: \Task::setDescription()
Parameters

Name | Type | Description
--- | --- | ---
$desc | string | The text describing the task

`setExcludes( string $excludes ) : void`
inherited

Sets the set of exclude patterns. Patterns may be separated by a comma or a space.

Inherited from: \MatchingTask::setExcludes()
Parameters

Name | Type | Description
--- | --- | ---
$excludes | string | the string containing the exclude patterns

`setExcludesfile( \PhingFile $excludesfile ) : void`
inherited

Sets the name of the file containing the includes patterns.

Inherited from: \MatchingTask::setExcludesfile()
Parameters

Name | Type | Description
--- | --- | ---
$excludesfile | \PhingFile | A string containing the filename to fetch the include patterns from.

`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( boolean $followSymlinks ) : void`
inherited

Sets whether or not symbolic links should be followed.

Inherited from: \MatchingTask::setFollowSymlinks()
Parameters

Name | Type | Description
--- | --- | ---
$followSymlinks | boolean | whether or not symbolic links should be followed

`setIncludes( string $includes ) : void`
inherited

Sets the set of include patterns. Patterns may be separated by a comma or a space.

Inherited from: \MatchingTask::setIncludes()
Parameters

Name | Type | Description
--- | --- | ---
$includes | string | the string containing the include patterns

`setIncludesfile( \PhingFile $includesfile ) : void`
inherited

Sets the name of the file containing the includes patterns.

Inherited from: \MatchingTask::setIncludesfile()
Parameters

Name | Type | Description
--- | --- | ---
$includesfile | \PhingFile | A string containing the filename to fetch the include patterns from.

`setLocation( \Location $location ) : void`
inherited

Sets the location within the buildfile this task occurs. Called by the parser to set location information.

Inherited from: \Task::setLocation()
Parameters

Name | Type | Description
--- | --- | ---
$location | \Location | The location object describing the position of this task within the buildfile.

`setOwningTarget( \Target $target ) : void`
inherited

Sets the owning target this task belongs to.

Inherited from: \Task::setOwningTarget()
Parameters

Name | Type | Description
--- | --- | ---
$target | \Target | Reference to owning target

`setProject( \Project $project ) : void`
inherited

References the project to the current component.

Inherited from: \MatchingTask::setProject()
Parameters

Name | Type | Description
--- | --- | ---
$project | \Project | The reference to the current project

Details

See
  \ProjectComponent::setProject()

`setRemovePath( $removepath ) : void`
inherited

Inherited from: \ExtractBaseTask::setRemovePath()
Parameters

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

`setRuntimeConfigurableWrapper( \RuntimeConfigurable $wrapper ) : void`
inherited

Sets the wrapper object this task should use for runtime configurable elements.

Inherited from: \Task::setRuntimeConfigurableWrapper()
Parameters

Name | Type | Description
--- | --- | ---
$wrapper | \RuntimeConfigurable | The wrapper object this task should use

`setTaskName( $name ) : string`
inherited

Sets the name of this task for log messages

Inherited from: \Task::setTaskName()
Parameters

Name | Type | Description
--- | --- | ---
$name |  |

Returns

Type | Description
--- | ---
string | A string representing the name of this task for log

`setTaskType( string $name ) : void`
inherited

Sets the type of the task. Usually this is the name of the XML tag

Inherited from: \Task::setTaskType()
Parameters

Name | Type | Description
--- | --- | ---
$name | string | The type of this task (XML Tag)

`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.15.1.