Phing is a cross-platform PHP build tool, similar to Apache Ant.
A build tool helps you automate repetitive tasks.
Otherwise you will f*** up.
You should automate everything you can.
Automating your processes will save you time.
Automating your processes will save you from your future self.
Maybe not today, maybe not tomorrow, but at some point you will make a mistake if it's not automated.
It's written in PHP, so if the rest of your project is PHP, you can run Phing.
Besides PHP, no other external dependencies are needed (such as Ruby or Java).
Great community support, with hundreds of different tasks.
github.com/phingofficial/phing
$> git clone https://github.com/phingofficial/phing.git
$> php phing\bin\phing
www.phing.info/trac/wiki/Users/Download
$> wget http://www.phing.info/get/phing-latest.phar -O phing.phar
$> php phing.phar
$> pear channel-discover pear.phing.info
$> pear install phing/phing
$> phing
composer.json:
{
"require": {
"phing/phing": "2.6.1"
}
}
$> php composer.phar install
Loading composer repositories with package information
Installing dependencies (including require-dev)
- Installing phing/phing (2.6.1)
Downloading: 100%
Writing lock file
Generating autoload files
$> php vendor\phing\phing\bin\phing
Phing is driven by XML files that define your projects, build targets, and individual tasks.
The XML format is very similar to Apache Ant.
A project is the root element of your XML.
The <project> defines of all of your build targets and the tasks that will execute for the targets.
Only the default attribut is required, which specifies the default target to run.
<?xml version="1.0" encoding="UTF-8"?>
A <target> is a logical set of actions you want to take.
A <target> can have tasks.
A <target> can also have a list of other targets it depends on.
<?xml version="1.0" encoding="UTF-8"?>
<target name="build" depends="clean,lint,minify" />
<target name="clean">
<echo msg="I'm cleaning your build" />
</target>
<!-- ... -->
A task will take an action.
Tasks can be a core task that Phing ships with, or an external plug-in that you write.
<?xml version="1.0" encoding="UTF-8"?>
<echo msg="I'm cleaning your build" />
<delete dir="build" />
Some of the most useful:
append, copy, delete, mkdircondition, foreach, if, failecho, inputexec, tstamp, taskdefgit*, svn*, cvs*ftpdeploy, httpget, mail, s3put, scp, sshphpcodesniffer, phpunit, phpdocumentor, jslint, phpmdA property is a variable.
Properties can come from built-in properties (Phing environment variables),
a build.properties file, or created at runtime in your XML file via the <property> element.
Use properties via the ${propertyname} syntax.
<?xml version="1.0" encoding="UTF-8"?>
<property name="builddir" value="./build" />
<echo msg="I'm cleaning ${builddir}" />
<delete dir="${builddir}" />
There are many built-in properties:
application.startdir, env.*, host.arch, host.domain, host.fstype, host.name, host.os, host.os.release,
host.os.version, line.separator, os.name, phing.file, phing.dir, phing.home, phing.version, phing.project.name,
php.classpath, php.version, project.basedir, user.home
Simple key=value format
# This is a comment in the .properties file
key=value
builddir=build
myapp.name=foo
myapp.url=http://foo.com
<?xml version="1.0" encoding="UTF-8"?>
<property file="./build.properties" />
<echo msg="I'm cleaning ${builddir} for ${myapp.name}" />
<delete dir="${builddir}" />
<property>Define new properties in your XML.
<?xml version="1.0" encoding="UTF-8"?>
<property name="builddir" value="./build" />
<property name="cssdir" value="${build}/css" />
<property name="jsdir" value="${build}/js" />
<delete dir="${cssdir}" />
<delete dir="${jsdir}" />
<?xml version="1.0" encoding="UTF-8"?>
<echo msg="Hello" />
>$ phing echo
Buildfile: .\build.xml
my-project > echo:
[echo] Hello
BUILD FINISHED
Total time: 0.1780 seconds
<?xml version="1.0" encoding="UTF-8"?>
<target name="first" depends="second" />
<fail message="You messed up" />
>$ phing first
Buildfile: .\build.xml
my-project > second:
Execution of target "second" failed for the following reason:
.\build.xml:16:22: You messed up
BUILD FAILED
.\build.xml:16:22: You messed up
Total time: 0.1800 seconds
<?xml version="1.0" encoding="UTF-8"?>
<property name="deploy.hostname" value="foo.com" />
<exec
command="rsynz -avz ./ ${deploy.hostname}/"
dir="${project.basedir}"
checkreturn="true" />
<?xml version="1.0" encoding="UTF-8"?>
<taskdef
name="myprojecttask"
classpath="${project.basedir}"
classname="MyTask" /> <!-- ./MyTask.php -->
<myprojecttask message='hi' />
<?php
require_once 'phing/Task.php';
class MyTask extends Task {
protected $message;
// set from the task's attribute in the XML
public function setMessage($message) {
$this->message = $message;
}
// executed when task is called
public function main() {
echo $this->message;
}
}
$>phing externaltask
Buildfile: .\build.xml
[property] Loading .\build.properties
my-project > externaltask:
hi
BUILD FINISHED
Total time: 0.2930 seconds
<?xml version="1.0" encoding="UTF-8"?>
<target name="build" depends="clean,checkout,lint,
sniff,phpmd,test,doc,package" />
<target name="deploy" depends="build,pre-deploy,rsync,release" />
<target name="lint" depends="phplint,jslint,csslint" />
Phing is a great way to automate repetitive tasks.
Phing can be as simple or complex (and powerful) as you make it.
Phing can save time and reduce human error.
More Info: