tasks/system/CopyTask.php
\CopyTask
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 explictly overwrite existing files.
Use {@link Project#createTask} to register a new Task.
- Parent(s)
- \Task < \ProjectComponent
- Children
- \XsltTask
- \MoveTask
- Author
- Andreas Aderhold, andi@binarycloud.com
- Copyright
- 2001,2002 THYRELL. All rights reserved
- Version
- $Id: 86322e73609da671413e4c959082958c16a510cc $
Properties


\Project
$project= 'null'
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::$$projectnull
Details- Type
- \Project
- Inherited_from
- \ProjectComponent::$$project
- Inherited_from
- \Task::$$project
Methods


__construct(
)
:
object
Sets up this object internal stuff. i.e. the Fileutils instance
Type | Description |
---|---|
object | The CopyTask instnace |
- Access
- public


_scan(
$fromDir, $toDir, $files, $dirs
)
:
void
Compares source files to destination files to see if they should be copied.
Name | Type | Description |
---|---|---|
$fromDir | ||
$toDir | ||
$files | ||
$dirs |
- Access
- private


addFileSet(
$fs
)
:
void
Nested creator, creates a FileSet for this task
Name | Type | Description |
---|---|---|
$fs |


buildMap(
$fromDir, $toDir, $names, $mapper, $map
)
:
void
Builds a map of filenames (from->to) that should be copied
Name | Type | Description |
---|---|---|
$fromDir | ||
$toDir | ||
$names | ||
$mapper | ||
$map |
- Access
- private


createFileList(
)
:
object
Nested creator, adds a set of files (nested fileset attribute).
Type | Description |
---|---|
object | The created filelist object |
- Access
- public


createFilterChain(
)
:
object
Creates a filterchain
Type | Description |
---|---|
object | The created filterchain object |
- Access
- public


createMapper(
)
:
object
Nested creator, creates one Mapper for this task
Type | Description |
---|---|
object | The created Mapper type object |
Exception | Description |
---|---|
\BuildException |
- Access
- public


doWork(
)
:
void
Actually copies the files
Exception | Description |
---|---|
\BuildException |
- Access
- private


getLocation(
)
:
\Location
Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.
Inherited from: \Task::getLocation()Type | Description |
---|---|
\Location | The location object describing the position of this task within the buildfile. |


getProject(
)
:
\Project
Returns a reference to current project
Inherited from: \ProjectComponent::getProject()\Task::getProject()Type | Description |
---|---|
\Project | Reference to current porject object |


getRuntimeConfigurableWrapper(
)
:
\RuntimeConfigurable
Returns the wrapper object for runtime configuration
Inherited from: \Task::getRuntimeConfigurableWrapper()Type | Description |
---|---|
\RuntimeConfigurable | The wrapper object used by this task |


getTaskType(
)
:
string
Returns the name of the task under which it was invoked, usually the XML tagname
Inherited from: \Task::getTaskType()Type | Description |
---|---|
string | The type of this task (XML Tag) |


init(
)
:
void
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
Exception | Description |
---|---|
\BuildException |


log(
string $msg, integer $level
=
Project::MSG_INFO
)
:
void
Name | Type | Description |
---|---|---|
$msg | string | The message to log |
$level | integer | The priority of the message |
- See
- \BuildEvent
- See
- \BuildListener


main(
)
:
true
The main entry point where everything gets in motion.
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.
Type | Description |
---|---|
true | on success |
Exception | Description |
---|---|
\BuildException |
- Access
- public


maybeConfigure(
)
:
void
Configure this task if it hasn't been done already.
Inherited from: \Task::maybeConfigure()

setDescription(
string $desc
)
:
void
Name | Type | Description |
---|---|---|
$desc | string | The text describing the task |


setFile(
\string/object $file
)
:
void
Set the file. We have to manually take care of the type that is coming due to limited type support in php in and convert it manually if neccessary.
Name | Type | Description |
---|---|---|
$file | \string/object | The source file. Either a string or an PhingFile object |
- Access
- public


setHaltonerror(
boolean $haltonerror
)
:
void
Set the haltonerror attribute - when true, will make the build fail when errors are detected.
Name | Type | Description |
---|---|---|
$haltonerror | boolean | Flag if the build should be stopped on errors |
- Access
- public


setIncludeEmptyDirs(
boolean $bool
)
:
void
Set the include empty dirs flag. IntrospectionHelper takes care of booleans in set* methods so we can assume that the right value (boolean primitive) is coming in here.
Name | Type | Description |
---|---|---|
$bool | boolean | Flag if empty dirs should be cpoied too |
- Access
- public


setLocation(
\Location $location
)
:
void
Sets the location within the buildfile this task occurs. Called by the parser to set location information.
Inherited from: \Task::setLocation()Name | Type | Description |
---|---|---|
$location | \Location | The location object describing the position of this task within the buildfile. |


setMode(
integer $mode
)
:
void
Sets the mode to create destination directories with (ignored on Windows).
Default mode is 0755.
Name | Type | Description |
---|---|---|
$mode | integer | Octal mode |
- Access
- public


setOverwrite(
boolean $bool
)
:
void
Set the overwrite flag. IntrospectionHelper takes care of booleans in set* methods so we can assume that the right value (boolean primitive) is coming in here.
Name | Type | Description |
---|---|---|
$bool | boolean | Overwrite the destination file(s) if it/they already exist |
- Access
- public


setOwningTarget(
\Target $target
)
:
void
Name | Type | Description |
---|---|---|
$target | \Target | Reference to owning target |


setPreserveLastModified(
boolean $bool
)
:
void
Set the preserve timestamp flag. IntrospectionHelper takes care of booleans in set* methods so we can assume that the right value (boolean primitive) is coming in here.
Name | Type | Description |
---|---|---|
$bool | boolean | Preserve the timestamp on the destination file |
- Access
- public


setProject(
\Project $project
)
:
void
References the project to the current component.
Inherited from: \ProjectComponent::setProject()\Task::setProject()Name | Type | Description |
---|---|---|
$project | \Project | The reference to the current project |


setRuntimeConfigurableWrapper(
\RuntimeConfigurable $wrapper
)
:
void
Sets the wrapper object this task should use for runtime configurable elements.
Inherited from: \Task::setRuntimeConfigurableWrapper()Name | Type | Description |
---|---|---|
$wrapper | \RuntimeConfigurable | The wrapper object this task should use |


setTaskName(
string $name
)
:
string
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
string | A string representing the name of this task for log |


setTaskType(
string $name
)
:
void
Sets the type of the task. Usually this is the name of the XML tag
Inherited from: \Task::setTaskType()Name | Type | Description |
---|---|---|
$name | string | The type of this task (XML Tag) |


setTodir(
\string/object $dir
)
:
void
Set the toDir. We have to manually take care of the type that is coming due to limited type support in php in and convert it manually if neccessary.
Name | Type | Description |
---|---|---|
$dir | \string/object | The directory, either a string or an PhingFile object |
- Access
- public


setTofile(
\string/object $file
)
:
void
Set the toFile. We have to manually take care of the type that is coming due to limited type support in php in and convert it manually if neccessary.
Name | Type | Description |
---|---|---|
$file | \string/object | The dest file. Either a string or an PhingFile object |
- Access
- public


setVerbose(
boolean $verbosity
)
:
void
Used to force listing of all names of copied files.
Name | Type | Description |
---|---|---|
$verbosity | boolean |


validateAttributes(
)
:
void
Validates attributes coming in from XML
Exception | Description |
---|---|
\BuildException |
- Access
- private