Phing - A PHP Build Tool (An Introduction)

Phing – A PHP Build Tool An Introduction Michiel Rook DPC 2011 - Uncon

About me Michiel Rook
Freelance PHP/Java consultant
Phing project lead
http://nl.linkedin.com/in/michieltcs
@michieltcs

About Phing
“PHing Is Not GNU make; it's a PHP project build system or build tool based on Apache Ant.”
Originally developed by Binarycloud
Ported to PHP5 by Hans Lellelid
I joined in 2005

Features
Scripting using XML build files
Mostly cross platform
Interface to various popular (PHP) tools

Features

Installation
PEAR installation $ pear channel-discover pear.phing.info $ pear install [--alldeps] phing/phing
Optionally install the documentation $ pear install phing/phingdocs

Why A Build Tool?

Why A Build Tool
Repetitive tasks
Version control
(Unit) Testing
Configuring
Packaging
Uploading
DB changes
...

Why A Build Tool
For developers and deployments
Automate!
Easier handover to new team members
Improves quality
Reduces errors
Saves time

Why Phing
Rich set of tasks
Integration with PHP specific tools
Allows you to stay in the PHP infrastructure
Easy to extend
Embed PHP code directly in the build file

Why Phing
Rich set of tasks
Integration with PHP specific tools
Allows you to stay in the PHP infrastructure
Easy to extend
Embed PHP code directly in the build file
… in the end, the choice is yours

The Basics
Phing uses XML build files
Standard elements
Task : code that performs a specific function (svn checkout, mkdir, etc.)
Target : groups of tasks, can optionally depend on other targets
Project : root node, contains multiple targets

Example Build File < project name = "Example" default = "world" > < target name = "hello" > < echo > Hello </ echo > </ target > < target name = "world" depends = "hello" > < echo > World! </ echo > </ target > </ project >

Properties < project name = "Example" default = "default" > < property file = "build.properties" / > < target name = "default" > < echo > ${version} </ echo > </ target > </ project > ## build.properties version=1.0

FileSet
Constructs a group of files to process
Supported by most tasks
< fileset dir = "./application" > <include name = "**/*.php" / > <exclude name = "**/*.php" / > </ fileset > < fileset dir = "./application" includes = "**" / > < fileset dir = "./application" id = "files" > <include name = "**/*.php" / > <exclude name = "**/*Test.php" / > </ fileset > < fileset refid = "files" / >

FileSet
Selectors allow fine-grained matching on certain attributes
< fileset dir = "${dist}" > <and> <filename name = "**" /> <date datetime = "01/01/2011" when = "before" /> </and> </ fileset >

Mappers & Filters
Transform files during copy/move/...
Mappers
Change filename
Filters
Strip comments
Replace values
Perform XSLT transformation
Translation (i18n)

Mappers & Filters < copy todir = "${build}" > <fileset refid = "files" / > <mapper type = "glob" from = "*.txt" type = "*.new.txt" / > <filterchain> <replaceregexp> <regexp pattern = "rn" replace = "n" /> </replaceregexp> </filterchain> </ copy >

Testing
Built-in support for PHPUnit / SimpleTest / Xdebug
Various output formats

Testing < target name = "test" > < coverage-setup database = "reports/coverage.db" > < fileset dir = "src" > < include name = "**/*.php" /> < exclude name = "**/*Test.php" /> </ fileset > </ coverage-setup > < phpunit codecoverage = "true" > < formatter type = "xml" todir = "reports" /> < formatter type = "clover" todir = "." /> < batchtest > < fileset dir = "src" > < include name = "**/*Test.php" /> </ fileset > </ batchtest > </ phpunit >

Testing < phpunitreport infile = "reports/testsuites.xml" format = "frames" todir = "reports/tests" styledir = "../../etc" /> < coverage-report outfile = "reports/coverage.xml" > < report todir = "reports/coverage" styledir = "../../etc" title = "Demo" /> </ coverage-report > </ target >

Extending Phing
Numerous possibilities
Tasks
Types
Selectors
Filters
Mappers
Loggers
...

Sample Task class SampleTask extends Task { private $var ; public function setVar($v) { $this-> var = $v; } public function main() { $this->log( "value: " . $this-> var ); } }

Sample Task < project name = "Example" default = "default" > < taskdef name = "sample" classname = "phing.tasks.my.SampleTask" /> < target name = "default" > < sample var = "Hello World" /> </ target > </ project >

Ad Hoc Extension < target name = "main" > <adhoc-task name = "foo" > <![CDATA[ class FooTest extends Task { private $bar; function setBar($bar) { $this->bar = $bar; } function main() { $this->log("In FooTest: " . $this->bar); } } ]]> </ adhoc-task > <foo bar = "TEST" / > </ target >

More Uses For Phing
Installation
Bootstrap dev. environments
DB migrations
Analyze code
Run (unit) tests
Upgrade server

What's Next For Phing
Improvements
More tasks (DocBlox), bug fixes
Test coverage
Cross-platform compatibility
Pain-free installation of dependencies
IDE support
We would love more contributions!

Questions? http://www.phing.info http://joind.in/3475 #phing (freenode) @phingofficial

http://www.touchdownconsulting.nl	692
http://twitter.com	2
http://us-w1.rockmelt.com	1
http://www.google.it	1

Phing - A PHP Build Tool (An Introduction)

by Michiel Rook on May 22, 2011

Accessibility

Categories

Tags

Upload Details

Usage Rights

4 Embeds 696

Statistics

Phing - A PHP Build Tool (An Introduction) — Presentation Transcript