tasks/system/CopyTask.php

Show: inherited
Table of Contents

\CopyTask

Package: phing\tasks\system

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

Propertyprotected  $completeDirMap= 'array()'
Default valuearray()Details
Type
n/a
Propertyprotectedstring  $description= ''
inherited

Description of the task

Inherited from: \Task::$$description
Details
Type
string
Inherited_from
\Task::$$description  
Propertyprotected  $destDir= 'null'
Default valuenullDetails
Type
n/a
Propertyprotected  $destFile= 'null'
Default valuenullDetails
Type
n/a
Propertyprotected  $dirCopyMap= 'array()'
Default valuearray()Details
Type
n/a
Propertyprotected  $file= 'null'
Default valuenullDetails
Type
n/a
Propertyprotected  $fileCopyMap= 'array()'
Default valuearray()Details
Type
n/a
Propertyprotected  $fileUtils= 'null'
Default valuenullDetails
Type
n/a
Propertyprotected  $filelists= 'array()'
Default valuearray()Details
Type
n/a
Propertyprotected  $filesets= 'array()'
Default valuearray()Details
Type
n/a
Propertyprotected  $filterChains= 'array()'
Default valuearray()Details
Type
n/a
Propertyprotected  $flatten= 'false'
Default valuefalseDetails
Type
n/a
Propertyprotected  $haltonerror= 'true'
Default valuetrueDetails
Type
n/a
Propertyprotected  $includeEmpty= 'true'
Default valuetrueDetails
Type
n/a
Propertyprotected\Location  $location= ''
inherited

Stored buildfile location

Inherited from: \Task::$$location
Details
Type
\Location
Inherited_from
\Task::$$location  
Propertyprotected  $mapperElement= 'null'
Default valuenullDetails
Type
n/a
Propertyprotected  $mode= '0755'
Default value0755Details
Type
n/a
Propertyprotected  $overwrite= 'false'
Default valuefalseDetails
Type
n/a
Propertyprotected  $preserveLMT= 'false'
Default valuefalseDetails
Type
n/a
Propertyprotected\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
Default valuenullDetails
Type
\Project
Inherited_from
\ProjectComponent::$$project  
Inherited_from
\Task::$$project  
Propertyprotected\Target  $target= ''
inherited

Owning Target object

Inherited from: \Task::$$target
Details
Type
\Target
Inherited_from
\Task::$$target  
Propertyprotectedstring  $taskName= ''
inherited

Taskname for logger

Inherited from: \Task::$$taskName
Details
Type
string
Inherited_from
\Task::$$taskName  
Propertyprotectedstring  $taskType= ''
inherited

Internal taskname (req)

Inherited from: \Task::$$taskType
Details
Type
string
Inherited_from
\Task::$$taskType  
Propertyprotected  $verbosity= 'Project::MSG_VERBOSE'
Default valueProject::MSG_VERBOSEDetails
Type
n/a
Propertyprotected\RuntimeConfigurable  $wrapper= ''
inherited

Wrapper of the task

Inherited from: \Task::$$wrapper
Details
Type
\RuntimeConfigurable
Inherited_from
\Task::$$wrapper  

Methods

methodpublic__construct( ) : object

Sets up this object internal stuff. i.e. the Fileutils instance

Returns
Type Description
object The CopyTask instnace
Details
Access
public  
methodprivate_scan(  $fromDir,  $toDir,  $files,  $dirs ) : void

Compares source files to destination files to see if they should be copied.

Parameters
Name Type Description
$fromDir
$toDir
$files
$dirs
Details
Access
private  
methodpublicaddFileSet(  $fs ) : void

Nested creator, creates a FileSet for this task

Parameters
Name Type Description
$fs
methodprivatebuildMap(  $fromDir,  $toDir,  $names,  $mapper,  $map ) : void

Builds a map of filenames (from->to) that should be copied

Parameters
Name Type Description
$fromDir
$toDir
$names
$mapper
$map
Details
Access
private  
methodpubliccreateFileList( ) : object

Nested creator, adds a set of files (nested fileset attribute).

Returns
Type Description
object The created filelist object
Details
Access
public  
methodpubliccreateFilterChain( ) : object

Creates a filterchain

Returns
Type Description
object The created filterchain object
Details
Access
public  
methodpubliccreateMapper( ) : object

Nested creator, creates one Mapper for this task

Returns
Type Description
object The created Mapper type object
Throws
Exception Description
\BuildException
Details
Access
public  
methodprotecteddoWork( ) : void

Actually copies the files

Throws
Exception Description
\BuildException
Details
Access
private  
methodpublicgetDescription( ) : string
inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()
Returns
Type Description
string The text description of the task
methodpublicgetLocation( ) : \Location
inherited

Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.

Inherited from: \Task::getLocation()
Returns
Type Description
\Location The location object describing the position of this task within the buildfile.
methodpublicgetOwningTarget( ) : \Target
inherited

Returns the owning target of this task.

Inherited from: \Task::getOwningTarget()
Returns
Type Description
\Target The target object that owns this task
methodpublicgetProject( ) : \Project
inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()\Task::getProject()
Returns
Type Description
\Project Reference to current porject object
methodprotectedgetRegisterSlot( string $slotName ) : void
inherited

Returns a name

Inherited from: \Task::getRegisterSlot()
Parameters
Name Type Description
$slotName string
methodpublicgetRuntimeConfigurableWrapper( ) : \RuntimeConfigurable
inherited

Returns the wrapper object for runtime configuration

Inherited from: \Task::getRuntimeConfigurableWrapper()
Returns
Type Description
\RuntimeConfigurable The wrapper object used by this task
methodpublicgetTaskName( ) : string
inherited

Returns the name of task, used only for log messages

Inherited from: \Task::getTaskName()
Returns
Type Description
string Name of this task
methodpublicgetTaskType( ) : string
inherited

Returns the name of the task under which it was invoked, usually the XML tagname

Inherited from: \Task::getTaskType()
Returns
Type Description
string The type of this task (XML Tag)
methodpublicinit( ) : void
inherited

Called by the parser to let the task initialize properly.

Inherited from: \Task::init()

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
methodpubliclog( string $msg, integer $level = Project::MSG_INFO ) : void
inherited

Provides a project level log event to the task.

Inherited from: \Task::log()
Parameters
Name Type Description
$msg string

The message to log

$level integer

The priority of the message

Details
See
\BuildEvent  
See
\BuildListener  
methodprotectedlogError(  $message,  $location = NULL ) : void

Parameters
Name Type Description
$message
$location
methodpublicmain( ) : 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.

Returns
Type Description
true on success
Throws
Exception Description
\BuildException
Details
Access
public  
methodpublicmaybeConfigure( ) : void
inherited

Configure this task if it hasn't been done already.

Inherited from: \Task::maybeConfigure()
methodpublicperform( ) : void
inherited

Perfrom this task

Inherited from: \Task::perform()
methodpublicsetDescription( string $desc ) : void
inherited

Sets a textual description of the task

Inherited from: \Task::setDescription()
Parameters
Name Type Description
$desc string

The text describing the task

methodpublicsetFile( \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.

Parameters
Name Type Description
$file \string/object

The source file. Either a string or an PhingFile object

Details
Access
public  
methodpublicsetHaltonerror( boolean $haltonerror ) : void

Set the haltonerror attribute - when true, will make the build fail when errors are detected.

Parameters
Name Type Description
$haltonerror boolean

Flag if the build should be stopped on errors

Details
Access
public  
methodpublicsetIncludeEmptyDirs( 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.

Parameters
Name Type Description
$bool boolean

Flag if empty dirs should be cpoied too

Details
Access
public  
methodpublicsetLocation( \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()
Parameters
Name Type Description
$location \Location

The location object describing the position of this task within the buildfile.

methodpublicsetMode( integer $mode ) : void

Sets the mode to create destination directories with (ignored on Windows).

Default mode is 0755.

Parameters
Name Type Description
$mode integer

Octal mode

Details
Access
public  
methodpublicsetOverwrite( 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.

Parameters
Name Type Description
$bool boolean

Overwrite the destination file(s) if it/they already exist

Details
Access
public  
methodpublicsetOwningTarget( \Target $target ) : void
inherited

Sets the owning target this task belongs to.

Inherited from: \Task::setOwningTarget()
Parameters
Name Type Description
$target \Target

Reference to owning target

methodpublicsetPreserveLastModified( 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.

Parameters
Name Type Description
$bool boolean

Preserve the timestamp on the destination file

Details
Access
public  
methodpublicsetProject( \Project $project ) : void
inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()\Task::setProject()
Parameters
Name Type Description
$project \Project

The reference to the current project

methodpublicsetRuntimeConfigurableWrapper( \RuntimeConfigurable $wrapper ) : void
inherited

Sets the wrapper object this task should use for runtime configurable elements.

Inherited from: \Task::setRuntimeConfigurableWrapper()
Parameters
Name Type Description
$wrapper \RuntimeConfigurable

The wrapper object this task should use

methodpublicsetTaskName( string $name ) : string
inherited

Sets the name of this task for log messages

Inherited from: \Task::setTaskName()
Parameters
Name Type Description
$name string
Returns
Type Description
string A string representing the name of this task for log
methodpublicsetTaskType( string $name ) : void
inherited

Sets the type of the task. Usually this is the name of the XML tag

Inherited from: \Task::setTaskType()
Parameters
Name Type Description
$name string

The type of this task (XML Tag)

methodpublicsetTodir( \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.

Parameters
Name Type Description
$dir \string/object

The directory, either a string or an PhingFile object

Details
Access
public  
methodpublicsetTofile( \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.

Parameters
Name Type Description
$file \string/object

The dest file. Either a string or an PhingFile object

Details
Access
public  
methodpublicsetTstamp(  $bool ) : void

Parameters
Name Type Description
$bool
Details
See
\CopyTask::setPreserveLastModified  
methodpublicsetVerbose( boolean $verbosity ) : void

Used to force listing of all names of copied files.

Parameters
Name Type Description
$verbosity boolean
methodprotectedvalidateAttributes( ) : void

Validates attributes coming in from XML

Throws
Exception Description
\BuildException
Details
Access
private  
Documentation was generated by DocBlox 0.18.1.