Extracts one or several zip archives using ZipArchive class.

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

author Joakim Bodin <joakim.bodin+phing@gmail.com>
author George Miroshnikov
version $Id: 9c4afd9af5e81250ca6c7afbc6e646c2a0f0148c $
package phing.tasks.ext
copyright 2001,2002 THYRELL. All rights reserved

 Methods

Create instance; set fileset to new FileSet.

__construct() 
Inherited
inherited_from \MatchingTask::__construct()
inherited_from \ExtractBaseTask::__construct()

Add a new selector into this container.

appendSelector(\FileSelector $selector) : void
Inherited
inherited_from \MatchingTask::appendSelector()
inherited_from \ExtractBaseTask::appendSelector()

Parameters

$selector

\FileSelector

the new selector to add

add an "And" selector entry on the selector list

createAnd() : \AndSelector
Inherited
inherited_from \MatchingTask::createAnd()
inherited_from \ExtractBaseTask::createAnd()

Returns

add a contains selector entry on the selector list

createContains() : \ContainsSelector
Inherited
inherited_from \MatchingTask::createContains()
inherited_from \ExtractBaseTask::createContains()

Returns

add an extended selector entry on the selector list

createCustom() : \ExtendSelector
Inherited
inherited_from \MatchingTask::createCustom()
inherited_from \ExtractBaseTask::createCustom()

Returns

add a selector date entry on the selector list

createDate() : \DateSelector
Inherited
inherited_from \MatchingTask::createDate()
inherited_from \ExtractBaseTask::createDate()

Returns

add a depends selector entry on the selector list

createDepend() : \DependSelector
Inherited
inherited_from \MatchingTask::createDepend()
inherited_from \ExtractBaseTask::createDepend()

Returns

add a depth selector entry on the selector list

createDepth() : \DepthSelector
Inherited
inherited_from \MatchingTask::createDepth()
inherited_from \ExtractBaseTask::createDepth()

Returns

add a name entry on the exclude list

createExclude() : \PatternSetNameEntry
Inherited
inherited_from \MatchingTask::createExclude()
inherited_from \ExtractBaseTask::createExclude()

Returns

add a name entry on the include files list

createExcludesFile() : \PatternSetNameEntry
Inherited
inherited_from \MatchingTask::createExcludesFile()
inherited_from \ExtractBaseTask::createExcludesFile()

Returns

Add a new fileset.

createFileSet() : \FileSet
Inherited
inherited_from \ExtractBaseTask::createFileSet()

Returns

add a selector filename entry on the selector list

createFilename() : \FilenameSelector
Inherited
inherited_from \MatchingTask::createFilename()
inherited_from \ExtractBaseTask::createFilename()

Returns

add a name entry on the include list

createInclude() : \PatternSetNameEntry
Inherited
inherited_from \MatchingTask::createInclude()
inherited_from \ExtractBaseTask::createInclude()

Returns

add a name entry on the include files list

createIncludesFile() : \PatternSetNameEntry
Inherited
inherited_from \MatchingTask::createIncludesFile()
inherited_from \ExtractBaseTask::createIncludesFile()

Returns

add a majority selector entry on the selector list

createMajority() : \MajoritySelector
Inherited
inherited_from \MatchingTask::createMajority()
inherited_from \ExtractBaseTask::createMajority()

Returns

add a "None" selector entry on the selector list

createNone() : \NoneSelector
Inherited
inherited_from \MatchingTask::createNone()
inherited_from \ExtractBaseTask::createNone()

Returns

add a "Not" selector entry on the selector list

createNot() : \NotSelector
Inherited
inherited_from \MatchingTask::createNot()
inherited_from \ExtractBaseTask::createNot()

Returns

add an "Or" selector entry on the selector list

createOr() : void
Inherited
inherited_from \MatchingTask::createOr()
inherited_from \ExtractBaseTask::createOr()

add a set of patterns

createPatternSet() : \PatternSet
Inherited
inherited_from \MatchingTask::createPatternSet()
inherited_from \ExtractBaseTask::createPatternSet()

Returns

add a present selector entry on the selector list

createPresent() : \PresentSelector
Inherited
inherited_from \MatchingTask::createPresent()
inherited_from \ExtractBaseTask::createPresent()

Returns

add a "Select" selector entry on the selector list

createSelector() : \SelectSelector
Inherited
inherited_from \MatchingTask::createSelector()
inherited_from \ExtractBaseTask::createSelector()

Returns

add a selector size entry on the selector list

createSize() : \SizeSelector
Inherited
inherited_from \MatchingTask::createSize()
inherited_from \ExtractBaseTask::createSize()

Returns

Returns the textual description of the task

getDescription() : string
Inherited
inherited_from \Task::getDescription()
inherited_from \MatchingTask::getDescription()
inherited_from \ExtractBaseTask::getDescription()

Returns

stringThe text description of the task

Returns the location within the buildfile this task occurs.

getLocation() : \Location
Inherited

Used by BuildException to give detailed error messages.

inherited_from \Task::getLocation()
inherited_from \MatchingTask::getLocation()
inherited_from \ExtractBaseTask::getLocation()

Returns

\LocationThe location object describing the position of this task within the buildfile.

Returns the owning target of this task.

getOwningTarget() : \Target
Inherited
inherited_from \Task::getOwningTarget()
inherited_from \MatchingTask::getOwningTarget()
inherited_from \ExtractBaseTask::getOwningTarget()

Returns

\TargetThe target object that owns this task

Returns a reference to current project

getProject() : \Project
Inherited
inherited_from \ProjectComponent::getProject()
inherited_from \Task::getProject()
inherited_from \MatchingTask::getProject()
inherited_from \ExtractBaseTask::getProject()

Returns

\ProjectReference to current porject object

Returns the wrapper object for runtime configuration

getRuntimeConfigurableWrapper() : \RuntimeConfigurable
Inherited
inherited_from \Task::getRuntimeConfigurableWrapper()
inherited_from \MatchingTask::getRuntimeConfigurableWrapper()
inherited_from \ExtractBaseTask::getRuntimeConfigurableWrapper()

Returns

\RuntimeConfigurableThe wrapper object used by this task

Returns the set of selectors as an array.

getSelectors(\Project $p) : array
Inherited
inherited_from \MatchingTask::getSelectors()
inherited_from \ExtractBaseTask::getSelectors()

Parameters

$p

Returns

arrayFileSelector[] An array of selectors in this container

Returns the name of task, used only for log messages

getTaskName() : string
Inherited
inherited_from \Task::getTaskName()
inherited_from \MatchingTask::getTaskName()
inherited_from \ExtractBaseTask::getTaskName()

Returns

stringName of this task

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

getTaskType() : string
Inherited
inherited_from \Task::getTaskType()
inherited_from \MatchingTask::getTaskType()
inherited_from \ExtractBaseTask::getTaskType()

Returns

stringThe type of this task (XML Tag)

Indicates whether there are any selectors here.

hasSelectors() : boolean
Inherited
inherited_from \MatchingTask::hasSelectors()
inherited_from \ExtractBaseTask::hasSelectors()

Returns

booleanWhether any selectors are in this container

Called by the parser to let the task initialize properly.

init() 
Inherited

Should throw a BuildException if something goes wrong with the build

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

inherited_from \Task::init()
inherited_from \MatchingTask::init()
inherited_from \ExtractBaseTask::init()

Exceptions

\BuildException

Provides a project level log event to the task.

log(string $msg, integer $level) 
Inherited
see \global\BuildEvent
see \global\BuildListener
inherited_from \Task::log()
inherited_from \MatchingTask::log()
inherited_from \ExtractBaseTask::log()

Parameters

$msg

string

The message to log

$level

integer

The priority of the message

do the work

main() 
Inherited

This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running phing target1 target2 will run all tasks in target3 twice.

Should throw a BuildException if someting goes wrong with the build

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

inherited_from \ExtractBaseTask::main()

Exceptions

\BuildException

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

maybeConfigure() 
Inherited
inherited_from \Task::maybeConfigure()
inherited_from \MatchingTask::maybeConfigure()
inherited_from \ExtractBaseTask::maybeConfigure()

Perfrom this task

perform() 
Inherited
inherited_from \Task::perform()
inherited_from \MatchingTask::perform()
inherited_from \ExtractBaseTask::perform()

Gives the count of the number of selectors in this container

selectorCount() : int
Inherited
inherited_from \MatchingTask::selectorCount()
inherited_from \ExtractBaseTask::selectorCount()

Returns

intThe number of selectors in this container

Returns an enumerator for accessing the set of selectors.

selectorElements() : \an
Inherited
inherited_from \MatchingTask::selectorElements()
inherited_from \ExtractBaseTask::selectorElements()

Returns

\anenumerator that goes through each of the selectors

Sets case sensitivity of the file system

setCaseSensitive(boolean $isCaseSensitive) : void
Inherited
inherited_from \MatchingTask::setCaseSensitive()
inherited_from \ExtractBaseTask::setCaseSensitive()

Parameters

$isCaseSensitive

boolean

"true"|"on"|"yes" if file system is case sensitive, "false"|"off"|"no" when not.

Sets whether default exclusions should be used or not.

setDefaultexcludes(boolean $useDefaultExcludes) 
Inherited
inherited_from \MatchingTask::setDefaultexcludes()
inherited_from \ExtractBaseTask::setDefaultexcludes()

Parameters

$useDefaultExcludes

boolean

"true"|"on"|"yes" when default exclusions should be used, "false"|"off"|"no" when they shouldn't be used.

Sets a textual description of the task

setDescription(string $desc) 
Inherited
inherited_from \Task::setDescription()
inherited_from \MatchingTask::setDescription()
inherited_from \ExtractBaseTask::setDescription()

Parameters

$desc

string

The text describing the task

Sets the set of exclude patterns.

setExcludes(string $excludes) 
Inherited

Patterns may be separated by a comma or a space.

inherited_from \MatchingTask::setExcludes()
inherited_from \ExtractBaseTask::setExcludes()

Parameters

$excludes

string

the string containing the exclude patterns

Sets the name of the file containing the includes patterns.

setExcludesfile(\PhingFile $excludesfile) : void
Inherited
inherited_from \MatchingTask::setExcludesfile()
inherited_from \ExtractBaseTask::setExcludesfile()

Parameters

$excludesfile

\PhingFile

A string containing the filename to fetch the include patterns from.

Set the name of the zip file to extract.

setFile(\PhingFile $file) 
Inherited
inherited_from \ExtractBaseTask::setFile()

Parameters

$file

\PhingFile

zip file to extract

Sets the forceExtract attribute

setForceExtract(boolean $forceExtract) 
Inherited
inherited_from \ExtractBaseTask::setForceExtract()

Parameters

$forceExtract

boolean

Sets the set of include patterns.

setIncludes(string $includes) : void
Inherited

Patterns may be separated by a comma or a space.

inherited_from \MatchingTask::setIncludes()
inherited_from \ExtractBaseTask::setIncludes()

Parameters

$includes

string

the string containing the include patterns

Sets the name of the file containing the includes patterns.

setIncludesfile(\PhingFile $includesfile) : void
Inherited
inherited_from \MatchingTask::setIncludesfile()
inherited_from \ExtractBaseTask::setIncludesfile()

Parameters

$includesfile

\PhingFile

A string containing the filename to fetch the include patterns from.

Sets the location within the buildfile this task occurs.

setLocation(\Location $location) 
Inherited

Called by the parser to set location information.

inherited_from \Task::setLocation()
inherited_from \MatchingTask::setLocation()
inherited_from \ExtractBaseTask::setLocation()

Parameters

$location

\Location

The location object describing the position of this task within the buildfile.

Sets the owning target this task belongs to.

setOwningTarget(\Target $target) 
Inherited
inherited_from \Task::setOwningTarget()
inherited_from \MatchingTask::setOwningTarget()
inherited_from \ExtractBaseTask::setOwningTarget()

Parameters

$target

\Target

Reference to owning target

References the project to the current component.

setProject(\Project $project) 
Inherited
see \global\ProjectComponent::setProject()
inherited_from \MatchingTask::setProject()
inherited_from \ExtractBaseTask::setProject()

Parameters

$project

\Project

The reference to the current project

setRemovePath()

setRemovePath($removepath) 
Inherited
inherited_from \ExtractBaseTask::setRemovePath()

Parameters

$removepath

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

setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper) 
Inherited
inherited_from \Task::setRuntimeConfigurableWrapper()
inherited_from \MatchingTask::setRuntimeConfigurableWrapper()
inherited_from \ExtractBaseTask::setRuntimeConfigurableWrapper()

Parameters

$wrapper

\RuntimeConfigurable

The wrapper object this task should use

Sets the name of this task for log messages

setTaskName(string $name) : string
Inherited
inherited_from \Task::setTaskName()
inherited_from \MatchingTask::setTaskName()
inherited_from \ExtractBaseTask::setTaskName()

Parameters

$name

string

Returns

stringA string representing the name of this task for log

Sets the type of the task.

setTaskType(string $name) 
Inherited

Usually this is the name of the XML tag

inherited_from \Task::setTaskType()
inherited_from \MatchingTask::setTaskType()
inherited_from \ExtractBaseTask::setTaskType()

Parameters

$name

string

The type of this task (XML Tag)

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

setToDir(\PhingFile $todir) 
Inherited
inherited_from \ExtractBaseTask::setToDir()

Parameters

$todir

Extract archive content into $this->todir directory

extractArchive(\PhingFile $zipfile) : boolean

Parameters

$zipfile

\PhingFile

Zip file to extract

Returns

boolean

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

getDirectoryScanner(\PhingFile $baseDir) : \DirectoryScanner
Inherited
inherited_from \MatchingTask::getDirectoryScanner()
inherited_from \ExtractBaseTask::getDirectoryScanner()

Parameters

$baseDir

Returns

Accessor for the implict fileset.

getImplicitFileSet() : \FileSet
Inherited
inherited_from \MatchingTask::getImplicitFileSet()
inherited_from \ExtractBaseTask::getImplicitFileSet()

Returns

Returns a name

getRegisterSlot(string $slotName) 
Inherited
inherited_from \Task::getRegisterSlot()
inherited_from \MatchingTask::getRegisterSlot()
inherited_from \ExtractBaseTask::getRegisterSlot()

Parameters

$slotName

string

isDestinationUpToDate()

isDestinationUpToDate(\PhingFile $compressedArchiveFile) : boolean
Inherited
inherited_from \ExtractBaseTask::isDestinationUpToDate()

Parameters

$compressedArchiveFile

Returns

boolean

List archive content

listArchiveContent(\PhingFile $zipfile) : array

Parameters

$zipfile

\PhingFile

Zip file to list content

Returns

arrayList of files inside $zipfile

Validates attributes coming in from XML

validateAttributes() : void
Inherited
access private
inherited_from \ExtractBaseTask::validateAttributes()

Exceptions

\BuildException

 Properties

 

$description : string
Inherited
inherited_from \Task::$$description
inherited_from \MatchingTask::$$description
inherited_from \ExtractBaseTask::$$description
 

$file : \PhingFile
Inherited
inherited_from \ExtractBaseTask::$$file
 

$fileset : \FileSet
Inherited
inherited_from \MatchingTask::$$fileset
inherited_from \ExtractBaseTask::$$fileset
 

$filesets 
Inherited
inherited_from \ExtractBaseTask::$$filesets
 

$forceExtract : boolean
Inherited
inherited_from \ExtractBaseTask::$$forceExtract
 

$location : \Location
Inherited
inherited_from \Task::$$location
inherited_from \MatchingTask::$$location
inherited_from \ExtractBaseTask::$$location
 

$project : \Project
Inherited
inherited_from \ProjectComponent::$$project
inherited_from \Task::$$project
inherited_from \MatchingTask::$$project
inherited_from \ExtractBaseTask::$$project
 

$removepath 
Inherited
inherited_from \ExtractBaseTask::$$removepath
 

$target : \Target
Inherited
inherited_from \Task::$$target
inherited_from \MatchingTask::$$target
inherited_from \ExtractBaseTask::$$target
 

$taskName : string
Inherited
inherited_from \Task::$$taskName
inherited_from \MatchingTask::$$taskName
inherited_from \ExtractBaseTask::$$taskName
 

$taskType : string
Inherited
inherited_from \Task::$$taskType
inherited_from \MatchingTask::$$taskType
inherited_from \ExtractBaseTask::$$taskType
 

$todir : \PhingFile
Inherited
inherited_from \ExtractBaseTask::$$todir
 

$useDefaultExcludes : boolean
Inherited
inherited_from \MatchingTask::$$useDefaultExcludes
inherited_from \ExtractBaseTask::$$useDefaultExcludes
 

$wrapper : \RuntimeConfigurable
Inherited
inherited_from \Task::$$wrapper
inherited_from \MatchingTask::$$wrapper
inherited_from \ExtractBaseTask::$$wrapper