tasks/ext/ExtractBaseTask.php

Base class for extracting tasks such as Unzip and Untar.

Parent(s)

\MatchingTask < \Task < \ProjectComponent

Children

\UnzipTask

\UntarTask

Author

Joakim Bodin  

Since

2.2.0  

Version

$Id: ExtractBaseTask.php 1397 2011-12-27 14:33:17Z mrook $  

Properties

\PhingFile  $file= ''

Details

Type

\PhingFile

 $filesets= 'array()'

Default valuearray()Details

Type

n/a

boolean  $forceExtract= 'false'

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

Default valuefalseDetails

Type

boolean

 $removepath= ''

Details

Type

n/a

\PhingFile  $todir= ''

Details

Type

\PhingFile

Methods

__construct( ) : void

appendSelector( ) : void

createAnd( ) : void

createContains( ) : void

createCustom( ) : void

createDate( ) : void

createDepend( ) : void

createDepth( ) : void

createExclude( ) : void

createExcludesFile( ) : void

createFileSet( ) : \FileSet

Add a new fileset.

Returns

Type	Description
\FileSet

createFilename( ) : void

createInclude( ) : void

createIncludesFile( ) : void

createMajority( ) : void

createNone( ) : void

createNot( ) : void

createOr( ) : void

createPatternSet( ) : void

createPresent( ) : void

createSelector( ) : void

createSize( ) : void

extractArchive(  $compressedArchiveFile ) : void

abstract

Parameters

Name	Type	Description
$compressedArchiveFile

getDescription( ) : void

getDirectoryScanner( ) : void

getImplicitFileSet( ) : void

final

getLocation( ) : void

getOwningTarget( ) : void

getProject( ) : void

getRegisterSlot( ) : void

getRuntimeConfigurableWrapper( ) : void

getSelectors( ) : void

getTaskName( ) : void

getTaskType( ) : void

hasSelectors( ) : void

init( ) : void

isDestinationUpToDate(  $compressedArchiveFile ) : boolean

Parameters

Name	Type	Description
$compressedArchiveFile

Returns

Type	Description
boolean

listArchiveContent(  $compressedArchiveFile ) : void

abstract

Parameters

Name	Type	Description
$compressedArchiveFile

log( ) : void

main( ) : void

do the work

Throws

Exception	Description
\BuildException

maybeConfigure( ) : void

perform( ) : void

selectorCount( ) : void

selectorElements( ) : void

setCaseSensitive( ) : void

setDefaultexcludes( ) : void

setDescription( ) : void

setExcludes( ) : void

setExcludesfile( ) : void

setFile( \PhingFile $file ) : void

Set the name of the zip file to extract.

Parameters

Name	Type	Description
$file	\PhingFile	zip file to extract

setFollowSymlinks( ) : void

setForceExtract( boolean $forceExtract ) : void

Sets the forceExtract attribute

Parameters

Name	Type	Description
$forceExtract	boolean

setIncludes( ) : void

setIncludesfile( ) : void

setLocation( ) : void

setOwningTarget( ) : void

setProject( ) : void

setRemovePath(  $removepath ) : void

Parameters

Name	Type	Description
$removepath

setRuntimeConfigurableWrapper( ) : void

setTaskName( ) : void

setTaskType( ) : void

setToDir(  $todir ) : void

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

Parameters

Name	Type	Description
$todir

validateAttributes( ) : void

Validates attributes coming in from XML

Throws

Exception	Description
\BuildException

Details

Access

private