tasks/ext/ExtractBaseTask.php

Show: inherited
Table of Contents

Base class for extracting tasks such as Unzip and Untar.

Author
Joakim Bodin  
Package
phing.tasks.ext  
Since
2.2.0  
Version
$Id: 8aa7996b72792da30f1ec94174f09b9c612bcc1a $  

\ExtractBaseTask

Package: phing\tasks\ext

Base class for extracting tasks such as Unzip and Untar.

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

Parent(s)
\MatchingTask < \SelectorContainer < \ProjectComponent
Children
\UnzipTask
\UntarTask
Author
Joakim Bodin  
Copyright
2001,2002 THYRELL. All rights reserved  
Since
2.2.0  
Version
$Id: 8aa7996b72792da30f1ec94174f09b9c612bcc1a $  

Properties

Propertyprotectedstring  $description= ''
inherited

Description of the task

Inherited from: \Task::$$description\MatchingTask::$$description
Details
Type
string
Inherited_from
\Task::$$description  
Inherited_from
\MatchingTask::$$description  
Propertyprotected\PhingFile  $file= ''

Details
Type
\PhingFile
Propertyprotected\FileSet  $fileset= ''
inherited

Inherited from: \MatchingTask::$$fileset
Details
Type
\FileSet
Inherited_from
\MatchingTask::$$fileset  
Propertyprotected  $filesets= 'array()'
Default valuearray()Details
Type
n/a
Propertyprotectedboolean  $forceExtract= 'false'

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

Default valuefalseDetails
Type
boolean
Propertyprotected\Location  $location= ''
inherited

Stored buildfile location

Inherited from: \Task::$$location\MatchingTask::$$location
Details
Type
\Location
Inherited_from
\Task::$$location  
Inherited_from
\MatchingTask::$$location  
Propertyprotected\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\Task::$$project\MatchingTask::$$project
Default valuenullDetails
Type
\Project
Inherited_from
\ProjectComponent::$$project  
Inherited_from
\Task::$$project  
Inherited_from
\MatchingTask::$$project  
Propertyprotected  $removepath= ''
Details
Type
n/a
Propertyprotected\Target  $target= ''
inherited

Owning Target object

Inherited from: \Task::$$target\MatchingTask::$$target
Details
Type
\Target
Inherited_from
\Task::$$target  
Inherited_from
\MatchingTask::$$target  
Propertyprotectedstring  $taskName= ''
inherited

Taskname for logger

Inherited from: \Task::$$taskName\MatchingTask::$$taskName
Details
Type
string
Inherited_from
\Task::$$taskName  
Inherited_from
\MatchingTask::$$taskName  
Propertyprotectedstring  $taskType= ''
inherited

Internal taskname (req)

Inherited from: \Task::$$taskType\MatchingTask::$$taskType
Details
Type
string
Inherited_from
\Task::$$taskType  
Inherited_from
\MatchingTask::$$taskType  
Propertyprotected\PhingFile  $todir= ''

Details
Type
\PhingFile
Propertyprotectedboolean  $useDefaultExcludes= 'true'
inherited

Inherited from: \MatchingTask::$$useDefaultExcludes
Default valuetrueDetails
Type
boolean
Inherited_from
\MatchingTask::$$useDefaultExcludes  
Propertyprotected\RuntimeConfigurable  $wrapper= ''
inherited

Wrapper of the task

Inherited from: \Task::$$wrapper\MatchingTask::$$wrapper
Details
Type
\RuntimeConfigurable
Inherited_from
\Task::$$wrapper  
Inherited_from
\MatchingTask::$$wrapper  

Methods

methodpublic__construct( ) : void
inherited

Create instance; set fileset to new FileSet.

Inherited from: \MatchingTask::__construct()
methodpublicappendSelector( \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

methodpubliccreateAnd( ) : \AndSelector
inherited

add an "And" selector entry on the selector list

Inherited from: \MatchingTask::createAnd()
Returns
Type Description
\AndSelector
methodpubliccreateContains( ) : \ContainsSelector
inherited

add a contains selector entry on the selector list

Inherited from: \MatchingTask::createContains()
Returns
Type Description
\ContainsSelector
methodpubliccreateCustom( ) : \ExtendSelector
inherited

add an extended selector entry on the selector list

Inherited from: \MatchingTask::createCustom()
Returns
Type Description
\ExtendSelector
methodpubliccreateDate( ) : \DateSelector
inherited

add a selector date entry on the selector list

Inherited from: \MatchingTask::createDate()
Returns
Type Description
\DateSelector
methodpubliccreateDepend( ) : \DependSelector
inherited

add a depends selector entry on the selector list

Inherited from: \MatchingTask::createDepend()
Returns
Type Description
\DependSelector
methodpubliccreateDepth( ) : \DepthSelector
inherited

add a depth selector entry on the selector list

Inherited from: \MatchingTask::createDepth()
Returns
Type Description
\DepthSelector
methodpubliccreateExclude( ) : \PatternSetNameEntry
inherited

add a name entry on the exclude list

Inherited from: \MatchingTask::createExclude()
Returns
Type Description
\PatternSetNameEntry
methodpubliccreateExcludesFile( ) : \PatternSetNameEntry
inherited

add a name entry on the include files list

Inherited from: \MatchingTask::createExcludesFile()
Returns
Type Description
\PatternSetNameEntry
methodpubliccreateFileSet( ) : \FileSet

Add a new fileset.

Returns
Type Description
\FileSet
methodpubliccreateFilename( ) : \FilenameSelector
inherited

add a selector filename entry on the selector list

Inherited from: \MatchingTask::createFilename()
Returns
Type Description
\FilenameSelector
methodpubliccreateInclude( ) : \PatternSetNameEntry
inherited

add a name entry on the include list

Inherited from: \MatchingTask::createInclude()
Returns
Type Description
\PatternSetNameEntry
methodpubliccreateIncludesFile( ) : \PatternSetNameEntry
inherited

add a name entry on the include files list

Inherited from: \MatchingTask::createIncludesFile()
Returns
Type Description
\PatternSetNameEntry
methodpubliccreateMajority( ) : \MajoritySelector
inherited

add a majority selector entry on the selector list

Inherited from: \MatchingTask::createMajority()
Returns
Type Description
\MajoritySelector
methodpubliccreateNone( ) : \NoneSelector
inherited

add a "None" selector entry on the selector list

Inherited from: \MatchingTask::createNone()
Returns
Type Description
\NoneSelector
methodpubliccreateNot( ) : \NotSelector
inherited

add a "Not" selector entry on the selector list

Inherited from: \MatchingTask::createNot()
Returns
Type Description
\NotSelector
methodpubliccreateOr( ) : void
inherited

add an "Or" selector entry on the selector list

Inherited from: \MatchingTask::createOr()
methodpubliccreatePatternSet( ) : \PatternSet
inherited

add a set of patterns

Inherited from: \MatchingTask::createPatternSet()
Returns
Type Description
\PatternSet
methodpubliccreatePresent( ) : \PresentSelector
inherited

add a present selector entry on the selector list

Inherited from: \MatchingTask::createPresent()
Returns
Type Description
\PresentSelector
methodpubliccreateSelector( ) : \SelectSelector
inherited

add a "Select" selector entry on the selector list

Inherited from: \MatchingTask::createSelector()
Returns
Type Description
\SelectSelector
methodpubliccreateSize( ) : \SizeSelector
inherited

add a selector size entry on the selector list

Inherited from: \MatchingTask::createSize()
Returns
Type Description
\SizeSelector
methodprotectedextractArchive(  $compressedArchiveFile ) : void
abstract

Parameters
Name Type Description
$compressedArchiveFile
methodpublicgetDescription( ) : string
inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()\MatchingTask::getDescription()
Returns
Type Description
string The text description of the task
methodprotectedgetDirectoryScanner(  $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
methodprotectedgetImplicitFileSet( ) : \FileSet
finalinherited

Accessor for the implict fileset.

Inherited from: \MatchingTask::getImplicitFileSet()
Returns
Type Description
\FileSet
methodpublicgetLocation( ) : \Location
inherited

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

Inherited from: \Task::getLocation()\MatchingTask::getLocation()
Returns
Type Description
\Location The location object describing the position of this task within the buildfile.
methodpublicgetOwningTarget( ) : \Target
inherited

Returns the owning target of this task.

Inherited from: \Task::getOwningTarget()\MatchingTask::getOwningTarget()
Returns
Type Description
\Target The target object that owns this task
methodpublicgetProject( ) : \Project
inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()\Task::getProject()\MatchingTask::getProject()
Returns
Type Description
\Project Reference to current porject object
methodprotectedgetRegisterSlot( string $slotName ) : void
inherited

Returns a name

Inherited from: \Task::getRegisterSlot()\MatchingTask::getRegisterSlot()
Parameters
Name Type Description
$slotName string
methodpublicgetRuntimeConfigurableWrapper( ) : \RuntimeConfigurable
inherited

Returns the wrapper object for runtime configuration

Inherited from: \Task::getRuntimeConfigurableWrapper()\MatchingTask::getRuntimeConfigurableWrapper()
Returns
Type Description
\RuntimeConfigurable The wrapper object used by this task
methodpublicgetSelectors(  $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
methodpublicgetTaskName( ) : string
inherited

Returns the name of task, used only for log messages

Inherited from: \Task::getTaskName()\MatchingTask::getTaskName()
Returns
Type Description
string Name of this task
methodpublicgetTaskType( ) : string
inherited

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

Inherited from: \Task::getTaskType()\MatchingTask::getTaskType()
Returns
Type Description
string The type of this task (XML Tag)
methodpublichasSelectors( ) : boolean
inherited

Indicates whether there are any selectors here.

Inherited from: \MatchingTask::hasSelectors()
Returns
Type Description
boolean Whether any selectors are in this container
methodpublicinit( ) : void
inherited

Called by the parser to let the task initialize properly.

Inherited from: \Task::init()\MatchingTask::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
methodprotectedisDestinationUpToDate(  $compressedArchiveFile ) : boolean

Parameters
Name Type Description
$compressedArchiveFile
Returns
Type Description
boolean
methodprotectedlistArchiveContent(  $compressedArchiveFile ) : void
abstract

Parameters
Name Type Description
$compressedArchiveFile
methodpubliclog( string $msg, integer $level = Project::MSG_INFO ) : void
inherited

Provides a project level log event to the task.

Inherited from: \Task::log()\MatchingTask::log()
Parameters
Name Type Description
$msg string

The message to log

$level integer

The priority of the message

Details
See
\BuildEvent  
See
\BuildListener  
methodpublicmain( ) : void

do the work

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
methodpublicmaybeConfigure( ) : void
inherited

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

Inherited from: \Task::maybeConfigure()\MatchingTask::maybeConfigure()
methodpublicperform( ) : void
inherited

Perfrom this task

Inherited from: \Task::perform()\MatchingTask::perform()
methodpublicselectorCount( ) : 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
methodpublicselectorElements( ) : \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
methodpublicsetCaseSensitive( 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.

methodpublicsetDefaultexcludes( 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.

methodpublicsetDescription( string $desc ) : void
inherited

Sets a textual description of the task

Inherited from: \Task::setDescription()\MatchingTask::setDescription()
Parameters
Name Type Description
$desc string

The text describing the task

methodpublicsetExcludes( 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

methodpublicsetExcludesfile( \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.

methodpublicsetFile( \PhingFile $file ) : void

Set the name of the zip file to extract.

Parameters
Name Type Description
$file \PhingFile

zip file to extract

methodpublicsetFollowSymlinks( 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

methodpublicsetForceExtract( boolean $forceExtract ) : void

Sets the forceExtract attribute

Parameters
Name Type Description
$forceExtract boolean
methodpublicsetIncludes( 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

methodpublicsetIncludesfile( \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.

methodpublicsetLocation( \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()\MatchingTask::setLocation()
Parameters
Name Type Description
$location \Location

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

methodpublicsetOwningTarget( \Target $target ) : void
inherited

Sets the owning target this task belongs to.

Inherited from: \Task::setOwningTarget()\MatchingTask::setOwningTarget()
Parameters
Name Type Description
$target \Target

Reference to owning target

methodpublicsetProject( \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()  
methodpublicsetRemovePath(  $removepath ) : void

Parameters
Name Type Description
$removepath
methodpublicsetRuntimeConfigurableWrapper( \RuntimeConfigurable $wrapper ) : void
inherited

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

Inherited from: \Task::setRuntimeConfigurableWrapper()\MatchingTask::setRuntimeConfigurableWrapper()
Parameters
Name Type Description
$wrapper \RuntimeConfigurable

The wrapper object this task should use

methodpublicsetTaskName( string $name ) : string
inherited

Sets the name of this task for log messages

Inherited from: \Task::setTaskName()\MatchingTask::setTaskName()
Parameters
Name Type Description
$name string
Returns
Type Description
string A string representing the name of this task for log
methodpublicsetTaskType( string $name ) : void
inherited

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

Inherited from: \Task::setTaskType()\MatchingTask::setTaskType()
Parameters
Name Type Description
$name string

The type of this task (XML Tag)

methodpublicsetToDir(  $todir ) : void

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

Parameters
Name Type Description
$todir
methodprotectedvalidateAttributes( ) : void

Validates attributes coming in from XML

Throws
Exception Description
\BuildException
Details
Access
private  
Documentation was generated by DocBlox 0.18.1.