vasek-purchart/phing-copy-files-task

Copy files with better control over copying than the default Phing CopyTask

2.0 2018-12-31 11:40 UTC

Requires

• php: ~7.2
• phing/phing: ~2.16

Requires (Dev)

• consistence/coding-standard: 3.7
• jakub-onderka/php-console-highlighter: 0.4
• jakub-onderka/php-parallel-lint: 1.0
• phpunit/phpunit: 7.5.1
• vasek-purchart/phing-tester: 2.0

MIT

• Vašek Purchart

• file
• task
• phing
• copy

README

Copy files with better control over copying than the default Phing CopyTask.

The main disadvantage of the default task is that it ignores the overwrite="false" setting (which is also default) and if the source file is newer, it always rewrites the target file (see phingofficial/phing#538). This is unexpected and potentially very dangerous behaviour especially when copying configuration files etc.

CopyFilesTask has much narrower use-cases, but offers you more control about the copied files. It works only with files (not directories or filesets) and you can specify how exactly each of the files should be copied and what to do when the target already exists.

Usage

To copy a file you can just write:

<target name="copy-configs">
	<copy-files>
		<file source="parameters.local.yml.dist" target="parameters.local.yml"/>
	</copy-files>
</target>

The paths are relative to the location of the buildfile. If you want to use absolute paths, you can write paths using ${project.basedir}, which contains the location of the buildfile.

You can also copy multiple files within one task definition:

<target name="copy-configs">
	<copy-files>
		<file source="parameters.local.yml.dist" target="parameters.local.yml"/>
		<file source="${environment}/parameters.yml" target="parameters.yml"/>
	</copy-files>
</target>

Target file exists mode

If the target file already exists, there are three modes how you can choose that the situation will be handled:

1. skip (default) - copying of the file is skipped (and logged to output)
2. replace - always replace target file, even if it exists
3. fail - do not overwrite the target file and fail the build

You can set the mode for all files at once with existsmode parameter on <copy-files>:

<target name="copy-configs">
	<copy-files existsmode="skip">
		<file source="parameters.local.yml.dist" target="parameters.local.yml"/>
		<file source="${environment}/parameters.yml" target="parameters.yml"/>
	</copy-files>
</target>

And also for each <file>, meaning it will override the <copy-files> setting:

<target name="copy-configs">
	<copy-files existsmode="skip">
		<file source="parameters.local.yml.dist" target="parameters.local.yml"/>
		<file source="${environment}/parameters.yml" target="parameters.yml" existsmode="replace"/>
	</copy-files>
</target>

Installation

1. Install package vasek-purchart/phing-copy-files-task with Composer:

composer require vasek-purchart/phing-copy-files-task

1. Register this task under a name of your choosing.

There are several ways how to register a task, see the TaskDefTask documentation. The recommended way is putting this in your build.xml:

<taskdef name="copy-files" classname="VasekPurchart\Phing\CopyFiles\CopyFilesTask"/>

You can pick any other name for the command if you would like to.