phpUnderControl
~~~~~~~~~~~~~~~

:Author: 		Manuel Pichler
:Date:			Sun, 21 Sep 2008 12:13:34 +0200
:Revision: 		9
:Copyright:		CC by-nc-sa
:Description:
  phpUnderControl - The first CruiseControl integration tool for PHP
  development.

===================
Documentation - FAQ
===================

.. contents:: Table of Contents
   :depth: 3

Invalid File or Directory artifacts/BankAccount/.../coverage/index.html
=======================================================================

If you get this or a similar error message, then your CruiseControl installation 
contains a directory named *artifacts*. If this directory exists, CruiseControl 
will always look for project artifacts in this directory. Simply change the 
*artifactpublisher*-tags in your *config.xml* from *logs/${project.name}* to 
*artifacts/${project.name}*. Now CruiseControl will move the generated contents
into the expected directory.


How do I perform a phpUnderControl update
=========================================

Even if the command name **install** is a little bit confusing, this command does
both jobs, a fresh *install* or an *update* of an existing installation.


I updated phpUnderControl, but I still get no shiny Metric-Charts
=================================================================

You have updated phpUnderControl, but you still get the old metric charts. You
must adjust the *publishers*-section of the *config.xml* for your existing 
projects to get new shiny charts, generated by phpUnderControl, from this. ::

  <publishers>
    <execute command="phpuc graph logs/${project.name}"/>
  </publishers>
        
If you use the *artifacts* folder for output you must add a second argument to
the *graph* command. ::

  <publishers>
    <execute command="phpuc graph logs/${project.name} artifacts/${project.name}" />
  </publishers>

This example is based on the PEAR installer and expects that *phpuc* is in the
*PATH* environment variable. If you use the svn checkout, please change *phpuc*
to *phpuc.php*.

No tag "jmxbase" defined in tag library imported with prefix "cruisecontrol"
============================================================================

When you try to open the phpUnderControl dashboard and get this error message,
then the used CruiseControl version is to old. The referenced `tutorial`__ 
mentions the version 2.4.1 that was ok and up to date in 2006, but please update 
your CruiseControl installation to a `more recent version`__.

__ http://nohn.org/blog/view/id/cruisecontrol_ant_and_phpunit
__ http://sourceforge.net/project/showfiles.php?group_id=23523

I get an error about an invalid checkstyle.xml document
=======================================================

This could happen if you don't specify the optional @error attribute for the
`ant exec task`__. If this attribute is not specified every output, including
all errors and warning, is logged into the checkstyle.xml document.

__ http://ant.apache.org/manual/CoreTasks/exec.html 

Are there any example configurations for phpUnderControl?
=========================================================

Yes, phpUnderControl provides two full documented `build.xml`__ and 
`config.xml`__ files that can be found in the docs directory.

__ http://www.phpunit.de/browser/phpUnderControl/trunk/docs/build.xml
__ http://www.phpunit.de/browser/phpUnderControl/trunk/docs/config.xml

Why some parts of CruiseControl should not be public accessible
===============================================================

The CruiseControl dashboard contains a handy feature to edit the config.xml file
online. This means everybody who has access to a public available CruiseControl
instance can modify this file online. Therefore you should use something like
mod_proxy to only allow access to the required sections of your CruiseControl
installation.