This document discusses various ways to install and configure Phing, the PHP build tool. It recommends installing Phing globally via PEAR or with Composer. It also covers best practices like using imports to structure targets, defining internal targets, creating custom tasks, prompting for input, and integrating Phing with Jenkins. The document emphasizes following conventions like naming the main build file build.xml and properties file build.properties.

1. Phing for power users
Stephan Hochdörfer, bitExpert AG

2. Phing for power users
About me
 Stephan Hochdörfer
 Head of IT at bitExpert AG, Germany
 enjoying PHP since 1999
 S.Hochdoerfer@bitExpert.de
 @shochdoerfer

3. How to install Phing?
Phing for power users

4. $> pear channel­discover pear.phing.info
$> pear install phing/phing
How to install Phing? The PEAR way...
Phing for power users
Installing Phing

5. $> phing ­v
Phing 2.5.0
$> pear channel­discover pear.phing.info
$> pear install phing/phing
How to install Phing? The PEAR way...
Phing for power users
Installing Phing
Running Phing:

6. How to install Phing?
Phing for power users
Installing Phing globally? WTF?!?

7. How to install Phing?
Phing for power users
Remember: Phing is „just another“
dependency for your project.

8. How to install Phing? The Composer way...
Phing for power users

9. {
"require": {
"phing/phing": "2.5.0"
}
}
How to install Phing? The Composer way...
Phing for power users
composer.json:

10. {
"require": {
"phing/phing": "2.5.0"
}
}
$> php composer.phar install
Loading composer repositories with package information
Installing dependencies
­ Installing phing/phing (2.5.0)
Downloading: 100%
Writing lock file
Generating autoload files
How to install Phing? The Composer way...
Phing for power users
composer.json:
Running Composer:

11. How to install Phing? The Composer way...
Phing for power users
/home/shochdoerfer/myproject
|­vendor
|­­­bin
|­­­­­@phing
|­­­composer
|­­­phing
|­­­­­phing
|­­­­­­­bin
|­­­­­­­­­phing
|­­­­­­­build
|­­­­­­­classes
|­­­­­­­docs
|­­­­­­­etc
|­­­­­­­test

12. How to install Phing? The Composer way...
Phing for power users
/home/shochdoerfer/myproject
|­vendor
|­­­bin
|­­­­­@phing
|­­­composer
|­­­phing
|­­­­­phing
|­­­­­­­bin
|­­­­­­­­­phing
|­­­­­­­build
|­­­­­­­classes
|­­­­­­­docs
|­­­­­­­etc
|­­­­­­­test
$> ./vendor/bin/phing ­v
Phing 2.5.0
Running Phing:

13. Properties File
Phing for power users

14. <?xml version="1.0"?>
<project name="myproject" default="hello">
<target name="hello"
description="Says whatever you want to say">
<property
file="./build.properties" />
<echo msg="${Hello}" />
</target>
</project>
Properties File
Phing for power users

15. <?xml version="1.0"?>
<project name="myproject" default="hello">
<target name="hello"
description="Says whatever you want to say">
<property
file="./build.properties" />
<echo msg="${Hello}" />
</target>
</project>
Properties File
Phing for power users
Hello=Hello, world!
build.properties:

16. $> phing
Buildfile: /home/shochdoerfer/build.xml
myproject > hello:
[property] Loading /home/shochdoerfer/build.properties
[echo] Hello, world!
BUILD FINISHED
Total time: 0.0601 seconds
Properties File
Phing for power users

17. Properties File - Improved version
Phing for power users

18. Properties File - Improved version
Phing for power users
Requirement: Externalize the properties
but offer customization capabilities!

19. <?xml version="1.0"?>
<project name="myproject" default="hello">
<target name="hello" depends="init">
<echo msg="${Hello}" />
</target>
<target name="init" depends="prop, local-prop">
<!-- some more init logic -->
</target>
<target name="prop">
<echo message="Load default build.properties"/>
<property
file="./build.properties" />
</target>
Properties File - Improved version
Phing for power users

20. <target name="local-prop"
if="local-prop.exists"
depends="local-prop-check">
<echo message="Loading custom properties!"/>
<property
file="${project.basedir}/local.properties"
override="true"/>
</target>
<target name="local-prop-check">
<available
file="${project.basedir}/local.properties"
property="local-prop.exists" />
</target>
</project>
Properties File - Improved version
Phing for power users

21. Enforce Internal Targets
Phing for power users

22. Enforce Internal Targets
Phing for power users
User can call both targets from command line.
We do not want that.
<?xml version="1.0"?>
<project name="myproject" default="hello">
<target name="init"
description="Property initialization">
<property name="Hello" value="Hello, world!" />
</target>
<target name="hello"
depends="init">
<echo msg="${Hello}" />
</target>
</project>

23. <?xml version="1.0"?>
<project name="myproject" default="hello">
<target name="-init"
description="Property initialization">
<property name="Hello" value="Hello, world!" />
</target>
<target name="hello"
depends="-init">
<echo msg="${Hello}" />
</target>
</project>
Enforce Internal Targets
Phing for power users
Prefixing a targets with a „-“ prevents the target
from being called from the command line.

24. $> ./vendor/bin/phing -l
Buildfile: /home/shochdoerfer/myproject/build.xml
Default target:
---------------------------------------------------------
hello
Main targets:
---------------------------------------------------------
-init Property initialization
Subtargets:
---------------------------------------------------------
hello
Enforce Internal Targets
Phing for power users

25. Enforce Internal Targets (Improved Version)
Phing for power users
<?xml version="1.0"?>
<project name="myproject" default="hello">
<target name="-init"
hidden="true"
description="Property initialization">
<property name="Hello" value="Hello, world!" />
</target>
<target name="hello"
depends="-init">
<echo msg="${Hello}" />
</target>
</project>

26. $> ./vendor/bin/phing -l
Buildfile: /home/shochdoerfer/myproject/build.xml
Default target:
---------------------------------------------------------
hello
Subtargets:
---------------------------------------------------------
hello
Enforce Internal Targets (Improved Version)
Phing for power users

27. Custom Tasks
Phing for power users

28. Custom Tasks
Phing for power users
Remember: Phing can do way
more than simple exec calls!

29. Custom Task (Adhoc definition)
Phing for power users
<?xml version="1.0"?>
<project name="myproject" default="hello">
<target name="init">
<adhoc-task name="mytask"><![CDATA[
class MyTask extends Task {
/**
* (non-PHPdoc)
* @see Task::main()
*/
public function main() {
// Custom code here...
}
}
]]></adhoc-task>
</target>
<target name="hello"
depends="init">
<mytask />
</target>
</project>

30. <?php
require_once 'phing/Task.php';
class MyTask extends Task {
/**
* (non-PHPdoc)
* @see Task::main()
*/
public function main() {
// Custom code here...
}
}
Custom Task (External file)
Phing for power users

31. <?xml version="1.0"?>
<project name="myproject" default="hello">
<target name="init">
<taskdef
name="mytask"
classpath="${project.basedir}"
classname="MyApp.Common.Phing.MyTask" />
</target>
<target name="hello"
depends="init">
<mytask />
</target>
</project>
Custom Task (External file)
Phing for power users

32. <?php
require_once 'phing/Task.php';
class MyTask extends Task {
protected $file;
/**
* @param string $file
*/
public function setFile($file) {
$this->file = $file;
}
/**
* @see Task::main()
*/
public function main() {
// Custom code here...
}
}
Custom Task with Parameters
Phing for power users

33. <?xml version="1.0"?>
<project name="myproject" default="hello">
<target name="init">
<taskdef
name="mytask"
classpath="${project.basedir}"
classname="MyApp.Common.Phing.MyTask" />
</target>
<target name="hello"
depends="init">
<mytask file="myfile.txt" />
</target>
</project>
Custom Task with Parameters
Phing for power users

34. <?xml version="1.0"?>
<project name="myproject" default="app:run">
<!--
The following target namespaces exist:
db:* - Database specific targets
app:* - Application specific tasks
ci:* - CI server specific tasks
-->
<import file="build/build.db.xml" />
<import file="build/build.app.xml" />
<import file="build/build.ci.xml" />
</project>
Imports for Targets can help structuring
Phing for power users

35. Import Targets: Composer packages
Phing for power users

36. <?xml version="1.0"?>
<project name="myproject" default="app:run">
<!--
The following target namespaces exist:
lib1:* - Targets imported from lib1
lib2:* - Targets imported from lib2
app:* - Local application targets
-->
<import file="vendor/lib1/build/build.xml" />
<import file="vendor/lib2/build/build.xml" />
<import file="build/build.app.xml" />
</project>
Import Targets: Composer packages
Phing for power users

37. Import Targets: Path handling
Phing for power users
Be aware that imports behave
like include in PHP!

38. <?xml version="1.0"?>
<project name="myproject" default="lib1:run">
<!--
The following target namespaces exist:
lib1:* - Targets imported from lib1
-->
<import file="vendor/lib1/build/build.xml" />
</project>
Import Targets: Path handling
Phing for power users
build.xml

39. <?xml version="1.0"?>
<project name="lib1" default="lib1:run">
<target name="lib1:run">
<echo msg="Local dir: ${phing.dir.lib1}" />
<echo msg="Global dir: ${phing.dir}" />
</target>
</project>
<?xml version="1.0"?>
<project name="myproject" default="lib1:run">
<!--
The following target namespaces exist:
lib1:* - Targets imported from lib1
-->
<import file="vendor/lib1/build/build.xml" />
</project>
Import Targets: Path handling
Phing for power users
build.xml
vendor/lib1/build/build.xml

40. $> ./vendor/bin/phing
Buildfile: /tmp/myproject/build.xml
myproject > lib1:run:
[echo] Local dir: /tmp/myproject/vendor/lib1/build
[echo] Global dir: /tmp/myproject
BUILD FINISHED
Total time: 0.0411 seconds
Import Targets: Path handling
Phing for power users

41. Import Targets: Path handling
Phing for power users
Be aware to always(!) use the
projects name in lowercase format!

42. Import Targets: Path handling
Phing for power users
It`s ${ping.dir.myproject} not
${phing.dir.MyProject}!

43. Distinct Target Naming
Phing for power users

44. Distinct Target Naming
Phing for power users
<?xml version="1.0"?>
<project name="myproject" default="ci:run-tests">
<target name="app:clean-cache">
</target>
<target name="app:create-cache">
</target>
<target name="db:migrate">
</target>
<target name="js:minifiy">
</target>
<target name="ci:lint">
</target>
<target name="ci:run-tests">
</target>
</project>

45. Prompt user for input
Phing for power users
<?xml version="1.0"?>
<project name="myproject" default="run">
<target name="run">
<!-- tag the database -->
<input
propertyname="tag"
defaultValue="mytag">Tag to create?</input>
<liquibase-tag
tag="${tag}"
jar="/opt/liquibase/liquibase.jar"
classpathref="/opt/liquibase/lib/mysql.jar"
changelogFile="${project.basedir}/diff.xml"
username="liquibase"
password="liquibase"
url="jdbc:mysql://localhost/myproject"/>
</target>
</project>

46. Calling PHP functions from Phing
Phing for power users

47. Calling PHP functions from Phing
Phing for power users
<?xml version="1.0"?>
<project name="myproject" default="run">
<target name="run">
<!--
Returns canonicalized absolute pathname
-->
<php function="realpath"
returnProperty="app.dir">
<param value="${app.dir}"/>
</php>
</target>
</project>

48. Accessing application configuration
Phing for power users

49. Accessing application configuration
Phing for power users
<?php
require_once 'phing/Task.php';
class ConfigMapperTask extends Task {
/**
* @see Task::main()
*/
public function main() {
// will import $APP_CONF in local context
require_once('src/bootstrap.php');
$project = $this->project;
$project->setProperty(
'db.host', $APP_CONF['db_host']);
$project->setProperty(
'db.database', $APP_CONF['db_database']);
$project->setProperty(
'db.user', $APP_CONF['db_user']);
$project->setProperty(
'db.password', $APP_CONF['db_passwd']);
}
}

50. Phing + Jenkins
Phing for power users

51. Phing + Jenkins
Phing for power users
Install the Jenkins Phing plugin

52. Phing for power users

53. Phing for power users

54. Phing for power users

55. Phing + Composer + Jenkins
Phing for power users

56. Phing + Composer + Jenkins
Phing for power users
Install the Jenkins EnvInject plugin

57. Phing for power users

58. Phing for power users

59. Phing for power users

60. Phing for power users

61. Follow conventions
A Phing fairy tale

62. Follow conventions
A Phing fairy tale
Phing expects your build file to be called
build.xml and the build’s properties file
build.properties

63. Follow conventions
A Phing fairy tale
Pick meaningful, human-readable
names for targets and properties.

64. Follow conventions
A Phing fairy tale
Make build files self-contained.

65. Thank you!

66. http://joind.in/8766