tasks/ext/UntarTask.php

Show:

inherited

Classes
- \UntarTask

Table of Contents

Extracts one or several tar archives using PEAR Archive_Tar

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

\UntarTask
jump to top

Package: phing\tasks\ext

Extracts one or several tar archives using PEAR Archive_Tar

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

Parent(s): \ExtractBaseTask < \MatchingTask < \SelectorContainer < \ProjectComponent
Author: Joakim Bodin
Copyright: 2001,2002 THYRELL. All rights reserved
Since: 2.2.0
Version: $Id: f77612833e0415725e7b816a0515db4a4f0f4c93 $

Properties

string
                 $description= ''

inherited

Description of the task

Inherited from: \Task::$$description \MatchingTask::$$description \ExtractBaseTask::$$description

Details

Type: string
Inherited_from: \Task::$$description
Inherited_from: \MatchingTask::$$description
Inherited_from: \ExtractBaseTask::$$description

\PhingFile
                 $file= ''

inherited

Inherited from: \ExtractBaseTask::$$file

Details

Type: \PhingFile
Inherited_from: \ExtractBaseTask::$$file

\FileSet
                 $fileset= ''

inherited

Inherited from: \MatchingTask::$$fileset \ExtractBaseTask::$$fileset

Details

Type: \FileSet
Inherited_from: \MatchingTask::$$fileset
Inherited_from: \ExtractBaseTask::$$fileset


                 $filesets= 'array()'

inheritedInherited from: \ExtractBaseTask::$$filesets

Default valuearray()Details

Type: n/a
Inherited_from: \ExtractBaseTask::$$filesets

boolean
                 $forceExtract= 'false'

inherited

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

Inherited from: \ExtractBaseTask::$$forceExtract

Default valuefalseDetails

Type: boolean
Inherited_from: \ExtractBaseTask::$$forceExtract

\Location
                 $location= ''

inherited

Stored buildfile location

Inherited from: \Task::$$location \MatchingTask::$$location \ExtractBaseTask::$$location

Details

Type: \Location
Inherited_from: \Task::$$location
Inherited_from: \MatchingTask::$$location
Inherited_from: \ExtractBaseTask::$$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 \Task::$$project \MatchingTask::$$project \ExtractBaseTask::$$project

Default valuenullDetails

Type: \Project
Inherited_from: \ProjectComponent::$$project
Inherited_from: \Task::$$project
Inherited_from: \MatchingTask::$$project
Inherited_from: \ExtractBaseTask::$$project


                 $removepath= ''

inheritedInherited from: \ExtractBaseTask::$$removepath

Details

Type: n/a
Inherited_from: \ExtractBaseTask::$$removepath

\Target
                 $target= ''

inherited

Owning Target object

Inherited from: \Task::$$target \MatchingTask::$$target \ExtractBaseTask::$$target

Details

Type: \Target
Inherited_from: \Task::$$target
Inherited_from: \MatchingTask::$$target
Inherited_from: \ExtractBaseTask::$$target

string
                 $taskName= ''

inherited

Taskname for logger

Inherited from: \Task::$$taskName \MatchingTask::$$taskName \ExtractBaseTask::$$taskName

Details

Type: string
Inherited_from: \Task::$$taskName
Inherited_from: \MatchingTask::$$taskName
Inherited_from: \ExtractBaseTask::$$taskName

string
                 $taskType= ''

inherited

Internal taskname (req)

Inherited from: \Task::$$taskType \MatchingTask::$$taskType \ExtractBaseTask::$$taskType

Details

Type: string
Inherited_from: \Task::$$taskType
Inherited_from: \MatchingTask::$$taskType
Inherited_from: \ExtractBaseTask::$$taskType

\PhingFile
                 $todir= ''

inherited

Inherited from: \ExtractBaseTask::$$todir

Details

Type: \PhingFile
Inherited_from: \ExtractBaseTask::$$todir

boolean
                 $useDefaultExcludes= 'true'

inherited

Inherited from: \MatchingTask::$$useDefaultExcludes \ExtractBaseTask::$$useDefaultExcludes

Default valuetrueDetails

Type: boolean
Inherited_from: \MatchingTask::$$useDefaultExcludes
Inherited_from: \ExtractBaseTask::$$useDefaultExcludes

\RuntimeConfigurable
                 $wrapper= ''

inherited

Wrapper of the task

Inherited from: \Task::$$wrapper \MatchingTask::$$wrapper \ExtractBaseTask::$$wrapper

Details

Type: \RuntimeConfigurable
Inherited_from: \Task::$$wrapper
Inherited_from: \MatchingTask::$$wrapper
Inherited_from: \ExtractBaseTask::$$wrapper

Methods

__construct(
          
          )
        
        :
          void

inherited

Create instance; set fileset to new FileSet.

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

appendSelector(
          \FileSelector $selector
          )
        
        :
          void

inherited

Add a new selector into this container.

Inherited from: \MatchingTask::appendSelector()\ExtractBaseTask::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()\ExtractBaseTask::createAnd()

Returns

Type	Description
\AndSelector

createContains(
          
          )
        
        :
          \ContainsSelector

inherited

add a contains selector entry on the selector list

Inherited from: \MatchingTask::createContains()\ExtractBaseTask::createContains()

Returns

Type	Description
\ContainsSelector

createCustom(
          
          )
        
        :
          \ExtendSelector

inherited

add an extended selector entry on the selector list

Inherited from: \MatchingTask::createCustom()\ExtractBaseTask::createCustom()

Returns

Type	Description
\ExtendSelector

createDate(
          
          )
        
        :
          \DateSelector

inherited

add a selector date entry on the selector list

Inherited from: \MatchingTask::createDate()\ExtractBaseTask::createDate()

Returns

Type	Description
\DateSelector

createDepend(
          
          )
        
        :
          \DependSelector

inherited

add a depends selector entry on the selector list

Inherited from: \MatchingTask::createDepend()\ExtractBaseTask::createDepend()

Returns

Type	Description
\DependSelector

createDepth(
          
          )
        
        :
          \DepthSelector

inherited

add a depth selector entry on the selector list

Inherited from: \MatchingTask::createDepth()\ExtractBaseTask::createDepth()

Returns

Type	Description
\DepthSelector

createExclude(
          
          )
        
        :
          \PatternSetNameEntry

inherited

add a name entry on the exclude list

Inherited from: \MatchingTask::createExclude()\ExtractBaseTask::createExclude()

Returns

Type	Description
\PatternSetNameEntry

createExcludesFile(
          
          )
        
        :
          \PatternSetNameEntry

inherited

add a name entry on the include files list

Inherited from: \MatchingTask::createExcludesFile()\ExtractBaseTask::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()\ExtractBaseTask::createFilename()

Returns

Type	Description
\FilenameSelector

createInclude(
          
          )
        
        :
          \PatternSetNameEntry

inherited

add a name entry on the include list

Inherited from: \MatchingTask::createInclude()\ExtractBaseTask::createInclude()

Returns

Type	Description
\PatternSetNameEntry

createIncludesFile(
          
          )
        
        :
          \PatternSetNameEntry

inherited

add a name entry on the include files list

Inherited from: \MatchingTask::createIncludesFile()\ExtractBaseTask::createIncludesFile()

Returns

Type	Description
\PatternSetNameEntry

createMajority(
          
          )
        
        :
          \MajoritySelector

inherited

add a majority selector entry on the selector list

Inherited from: \MatchingTask::createMajority()\ExtractBaseTask::createMajority()

Returns

Type	Description
\MajoritySelector

createNone(
          
          )
        
        :
          \NoneSelector

inherited

add a "None" selector entry on the selector list

Inherited from: \MatchingTask::createNone()\ExtractBaseTask::createNone()

Returns

Type	Description
\NoneSelector

createNot(
          
          )
        
        :
          \NotSelector

inherited

add a "Not" selector entry on the selector list

Inherited from: \MatchingTask::createNot()\ExtractBaseTask::createNot()

Returns

Type	Description
\NotSelector

createOr(
          
          )
        
        :
          void

inherited

add an "Or" selector entry on the selector list

Inherited from: \MatchingTask::createOr()\ExtractBaseTask::createOr()

createPatternSet(
          
          )
        
        :
          \PatternSet

inherited

add a set of patterns

Inherited from: \MatchingTask::createPatternSet()\ExtractBaseTask::createPatternSet()

Returns

Type	Description
\PatternSet

createPresent(
          
          )
        
        :
          \PresentSelector

inherited

add a present selector entry on the selector list

Inherited from: \MatchingTask::createPresent()\ExtractBaseTask::createPresent()

Returns

Type	Description
\PresentSelector

createSelector(
          
          )
        
        :
          \SelectSelector

inherited

add a "Select" selector entry on the selector list

Inherited from: \MatchingTask::createSelector()\ExtractBaseTask::createSelector()

Returns

Type	Description
\SelectSelector

createSize(
          
          )
        
        :
          \SizeSelector

inherited

add a selector size entry on the selector list

Inherited from: \MatchingTask::createSize()\ExtractBaseTask::createSize()

Returns

Type	Description
\SizeSelector

extractArchive(
           $tarfile
          )
        
        :
          void

Parameters

Name	Type	Description
$tarfile

getDescription(
          
          )
        
        :
          string

inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()\MatchingTask::getDescription()\ExtractBaseTask::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()\ExtractBaseTask::getDirectoryScanner()

Parameters

Name	Type	Description
$baseDir

Returns

Type	Description
\DirectoryScanner

getImplicitFileSet(
          
          )
        
        :
          \FileSet

finalinherited

Accessor for the implict fileset.

Inherited from: \MatchingTask::getImplicitFileSet()\ExtractBaseTask::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()\MatchingTask::getLocation()\ExtractBaseTask::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()\MatchingTask::getOwningTarget()\ExtractBaseTask::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()\Task::getProject()\MatchingTask::getProject()\ExtractBaseTask::getProject()

Returns

Type	Description
\Project	Reference to current porject object

getRegisterSlot(
          string $slotName
          )
        
        :
          void

inherited

Returns a name

Inherited from: \Task::getRegisterSlot()\MatchingTask::getRegisterSlot()\ExtractBaseTask::getRegisterSlot()

Parameters

Name	Type	Description
$slotName	string

getRuntimeConfigurableWrapper(
          
          )
        
        :
          \RuntimeConfigurable

inherited

Returns the wrapper object for runtime configuration

Inherited from: \Task::getRuntimeConfigurableWrapper()\MatchingTask::getRuntimeConfigurableWrapper()\ExtractBaseTask::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()\ExtractBaseTask::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()\MatchingTask::getTaskName()\ExtractBaseTask::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()\MatchingTask::getTaskType()\ExtractBaseTask::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()\ExtractBaseTask::hasSelectors()

Returns

Type	Description
boolean	Whether any selectors are in this container

Ensures that PEAR lib exists.

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

initTar(
          \PhingFile $tarfile
          )
        
        :
          \Archive_Tar

Init a Archive_Tar class with correct compression for the given file.

Parameters

Name	Type	Description
$tarfile	\PhingFile

Returns

Type	Description
\Archive_Tar	the tar class instance

isDestinationUpToDate(
           $compressedArchiveFile
          )
        
        :
          boolean

inherited

Inherited from: \ExtractBaseTask::isDestinationUpToDate()

Parameters

Name	Type	Description
$compressedArchiveFile

Returns

Type	Description
boolean

listArchiveContent(
           $tarfile
          )
        
        :
          void

Parameters

Name	Type	Description
$tarfile

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

inherited

Provides a project level log event to the task.

Inherited from: \Task::log()\MatchingTask::log()\ExtractBaseTask::log()

Parameters

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

Details

See: \BuildEvent
See: \BuildListener

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()\MatchingTask::maybeConfigure()\ExtractBaseTask::maybeConfigure()

perform(
          
          )
        
        :
          void

inherited

Perfrom this task

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

selectorCount(
          
          )
        
        :
          int

inherited

Gives the count of the number of selectors in this container

Inherited from: \MatchingTask::selectorCount()\ExtractBaseTask::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()\ExtractBaseTask::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()\ExtractBaseTask::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()\ExtractBaseTask::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()\MatchingTask::setDescription()\ExtractBaseTask::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()\ExtractBaseTask::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()\ExtractBaseTask::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()\ExtractBaseTask::setFollowSymlinks()

Parameters

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

setForceExtract(
          boolean $forceExtract
          )
        
        :
          void

inherited

Sets the forceExtract attribute

Inherited from: \ExtractBaseTask::setForceExtract()

Parameters

Name	Type	Description
$forceExtract	boolean

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()\ExtractBaseTask::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()\ExtractBaseTask::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()\MatchingTask::setLocation()\ExtractBaseTask::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()\MatchingTask::setOwningTarget()\ExtractBaseTask::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()\ExtractBaseTask::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()\MatchingTask::setRuntimeConfigurableWrapper()\ExtractBaseTask::setRuntimeConfigurableWrapper()

Parameters

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

setTaskName(
          string $name
          )
        
        :
          string

inherited

Sets the name of this task for log messages

Inherited from: \Task::setTaskName()\MatchingTask::setTaskName()\ExtractBaseTask::setTaskName()

Parameters

Name	Type	Description
$name	string

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()\MatchingTask::setTaskType()\ExtractBaseTask::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

tasks/ext/UntarTask.php

\UntarTaskjump to top

Properties

Methods

\UntarTask
jump to top