A phing copy task. Copies a file or directory to a new file or directory. Files are only copied if the source file is newer than the destination file, or when the destination file does not exist. It is possible to explicitly overwrite existing files.
Use \Project#createTask to register a new Task.
author |
Andreas Aderhold, andi@binarycloud.com |
---|---|
package |
phing.tasks.system |
__construct()
i.e. the Fileutils instance and default mode.
_scan( &$fromDir, &$toDir, &$files, &$dirs) : void
addFileSet(\FileSet $fs) : void
buildMap( &$fromDir, &$toDir, &$names, &$mapper, &$map) : void
copyToSingleDestination( $from, $to, $fromSlot, $fromBasenameSlot, $toSlot, $toBasenameSlot, &$count, &$total)
createFileList() : \FileList
createFilterChain() : \FilterChain
createMapper() : \Mapper
doWork() : void
throws | |
---|---|
getDescription() : string
string
The text description of the task
getLocation() : \Location
getMapper()
getOwningTarget() : \Target
getProject() : \Project
getRegisterSlot(string $slotName) : \RegisterSlot
getRuntimeConfigurableWrapper() : \RuntimeConfigurable
getTaskName() : string
string
Name of this task
getTaskType() : string
string
The type of this task (XML Tag)
init()
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
throws | |
---|---|
isEnabledMultipleMappings()
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
logError(string $message, null $location = null)
throws | |
---|---|
string
null
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 | |
---|---|
setDescription(string $desc)
string
The text describing the task
setEnableMultipleMappings( $enableMultipleMappings)
setFile(\PhingFile $file) : void
setHaltonerror(boolean $haltonerror) : void
boolean
Flag if the build should be stopped on errors
setIncludeEmptyDirs(boolean $bool) : void
boolean
Flag if empty dirs should be cpoied too
setLocation(\Location $location)
setMode(integer $mode) : void
Default mode is taken from umask()
integer
Octal mode
setOverwrite(boolean $bool) : void
boolean
Overwrite the destination file(s) if it/they already exist
setOwningTarget(\Target $target)
setPreserveLastModified( $bool) : void
setPreservemode( $bool)
setProject(\Project $project) : void
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
setTaskName(string $name) : string
string
string
A string representing the name of this task for log
setTaskType( $name)
setTodir(\PhingFile $dir) : void
setTofile(\PhingFile $file) : void
setTstamp( $bool)
see | \CopyTask::setPreserveLastModified |
---|---|
setVerbose(boolean $verbosity)
boolean
validateAttributes() : void
throws | |
---|---|
file :
destFile :
destDir :
overwrite :
preserveLMT :
preservePermissions :
includeEmpty :
flatten :
mapperElement :
fileCopyMap :
dirCopyMap :
completeDirMap :
fileUtils :
filesets :
filelists :
filterChains :
verbosity :
mode : integer
var |
---|
integer
haltonerror : boolean
var |
---|
boolean
enableMultipleMappings :
description : string
var |
---|
string
taskType : string
var |
---|
string
taskName : string
var |
---|
string
project : \Project