Base class for extracting tasks such as Unzip and Untar.
This is very closely based on the ANT class of the same name.
author |
Joakim Bodin joakim.bodin+phing@gmail.com |
---|---|
version |
$Id: 9a02922d4ca2d2a31655411257558307260482b5 $ |
package |
phing.tasks.ext |
since | 2.2.0 |
__construct()
addFileSet(\FileSet $fs) : void
appendSelector(\FileSelector $selector) : void
createAnd() : \AndSelector
createContains() : \ContainsSelector
createCustom() : \ExtendSelector
createDate() : \DateSelector
createDepend() : \DependSelector
createDepth() : \DepthSelector
createExclude() : \PatternSetNameEntry
createExcludesFile() : \PatternSetNameEntry
createFilename() : \FilenameSelector
createInclude() : \PatternSetNameEntry
createIncludesFile() : \PatternSetNameEntry
createMajority() : \MajoritySelector
createNone() : \NoneSelector
createNot() : \NotSelector
createOr() : \OrSelector
createPresent() : \PresentSelector
createSelector() : \SelectSelector
createSize() : \SizeSelector
extractArchive(\PhingFile $compressedArchiveFile) : mixed
getDescription() : string
string
The text description of the task
getDirectoryScanner(\PhingFile $baseDir) : \DirectoryScanner
getLocation() : \Location
getOwningTarget() : \Target
getProject() : \Project
getRegisterSlot(string $slotName) : \RegisterSlot
getRuntimeConfigurableWrapper() : \RuntimeConfigurable
getSelectors(\Project $p) : array
getTaskName() : string
string
Name of this task
getTaskType() : string
string
The type of this task (XML Tag)
hasSelectors() : boolean
boolean
Whether any selectors are in this container
init()
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
throws | |
---|---|
listArchiveContent(\PhingFile $compressedArchiveFile) : mixed
log(string $msg, integer $level = \Project::MSG_INFO) : void
string
The message to be logged.
integer
The message's priority at this message should have
main()
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.
maybeConfigure()
perform()
throws | |
---|---|
selectorCount() : integer
integer
The number of selectors in this container
selectorElements() : \an
\an
enumerator that goes through each of the selectors
setCaseSensitive(boolean $isCaseSensitive) : void
boolean
"true"|"on"|"yes" if file system is case
sensitive, "false"|"off"|"no" when not.
setDefaultexcludes(boolean $useDefaultExcludes)
boolean
"true"|"on"|"yes" when default exclusions
should be used, "false"|"off"|"no" when they
shouldn't be used.
setDescription(string $desc)
string
The text describing the task
setExcludes(string $excludes)
string
the string containing the exclude patterns
setExcludesfile(\PhingFile $excludesfile) : void
setFile(\PhingFile $file) : void
setFollowSymlinks(boolean $followSymlinks) : void
boolean
whether or not symbolic links should be followed
setForceExtract(boolean $forceExtract) : void
boolean
setIncludes(string $includes) : void
string
the string containing the include patterns
setIncludesfile(\PhingFile $includesfile) : void
setLocation(\Location $location)
setOwningTarget(\Target $target)
setProject(\Project $project) : void
setRemovePath( $removepath) : void
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
setTaskName(string $name) : string
string
string
A string representing the name of this task for log
setTaskType( $name)
setToDir(\PhingFile $todir) : void
validateAttributes() : void
throws | |
---|---|
removepath :
filesets :
forceExtract : boolean
var |
---|
boolean
useDefaultExcludes : boolean
var |
---|
boolean
description : string
var |
---|
string
taskType : string
var |
---|
string
taskName : string
var |
---|
string
project : \Project