Select Page

When Joomla! meet Maven for PHP

When Joomla! meet Maven for PHP

  I will quickly describe in this post how you can code your component/plugins/modules against a specific version of #Joomla! with no effort using #Maven for PHP.

The trick I made is to package the whole #Joomla distribution in a jar file, and add a #Maven dependency to the project. As #Joomla, PHPUnit, or any other 3rd party is not a set of class packaged in a jar, the brilliant idea of #Maven for PHP is to unpack all these dependencies in the target/phpinc directory automatically AND concatenating this directory to the php setting include_path during compile and test phase. You can do the same using the command line by running:

php -d include_path=

That’s also why, It is very important to not put anything from this directory under version control (add a cvs.ignore or svn properties svn:ignore) as it contains dependencies that have no reason to be put under version control in #Maven paradigm (they have to reside in a #Maven repository)

So I create a new zip file joomla-1.5.10.jar with a directory inside named ‘Joomla’ that contains a standard binary distribution…this jar is published in artifactory with a groupid org.joomla (arbitrary chosen by me)

Artifactory will generate a default pom.xml. Normally it should contains more meta data and be created by the Joomla team itself. (if they ever support Maven)

<?xml version="1.0" encoding="UTF-8"?>

The artifact is deployed and viewable at

With the code below I can bind my component to a new version or old version of Joomla just by modifying the component pom.xml. Note the version number 1.5.10 (the latest version of Joomla! to date)


Test cases classes are directly in the eclipse project under src/test/php (this directory is created by the archetype php5-lib-archetype), In bold, this is how you can import the whole Joomla! framework!

require_once ('PHPUnit/Framework.php'); 
require_once ('Joomla/index.php');

//I load the PHP class that I would like to test 
require_once ('admin/class/logUtils.php');

class LogUtilsTest extends PHPUnit_Framework_TestCase {

//a poor PHPUNit testcase 
function testisAnEmail() {

        $LogUtils = new LogUtils(); 
        $this->assertEquals(true, $LogUtils->isAnEmail("[email protected]")); 
        $this->assertEquals(false, $LogUtils->isAnEmail("")); 
        $this->assertEquals(true, $LogUtils->isAnEmail("[email protected]"));


About The Author

I worked with various Insurances companies across Switzerland on online applications handling billion premium volumes. I love to continuously spark my creativity in many different and challenging open-source projects fueled by my great passion for innovation and blockchain technology.In my technical role as a senior software engineer and Blockchain consultant, I help to define and implement innovative solutions in the scope of both blockchain and traditional products, solutions, and services. I can support the full spectrum of software development activities, starting from analyzing ideas and business cases and up to the production deployment of the solutions.I'm the Founder and CEO of Disruptr GmbH.