%TOC%

---++ Introduction

Within the documentation of [[PhpFront][PHP-front]] the TheExampleProject is used to explain how you can setup your own project. This documentation uses PHP-Tools as the running example. Although it is used in the documentation the package actually builds and provides real-life tools.

PHP-Tools is growing to be a package with useful tools for analyzing PHP-projects. All of the tools will be able to answer a single question. The following list of tools is available:

	* defined-functions ; which functions are defined outside the scope of a class? (since revision 396)
	* input-vector ; Which entries in the input arrays are being accessed within the project? 
	* test-migration ; Are there any static problems with migrating my code to PHP5? (since revision 406) ([[http://ericbouwers.blogspot.com/2007/09/little-migration-helper.html][More info]])
	* php-cyco ; What is the cyclomatic complexity of me PHP-script? (since revision 421) ([[http://ericbouwers.blogspot.com/2007/12/calculating-complexity-of-php.html][More info]])


Yes, this list is to be [[http://bugs.strategoxt.org/secure/IssueNavigator.jspa?reset=true&&pid=10180&resolution=-1&component=10282&sorter/field=priority&sorter/order=DESC][extended]].

---++ Download 

---+++ Latest Developments

Distributions of the head revision are created continuously:

	 * %DIST%/php-tools/channel/latest

The distributions contain the latest of the latest developments, but if you really want to, the latest sources can be checked out using:
<pre>
  svn checkout %SVNROOT%/psat/php-tools/trunk
</pre>
Before you can configure the package as described above you have to run the =./bootstrap= script.

---+++ Installation

Install the package with the usual sequence of commands:

<verbatim>
$ ./configure
$ make
$ make install
</verbatim>

You might need to set your =PKG_CONFIG_PATH= if you did not install the dependencies in a standard location. Configure will tell you to do this if it cannot find aterm, sdf or strategoxt.

---++ Project Info

---+++ Issue Tracking

We use JIRA to keep track of issues. Please report any issues that you encounter!
	* %ISSUE%/PSAT (or [[https://bugs.cs.uu.nl/secure/IssueNavigator.jspa?reset=true&&pid=10180&resolution=-1&component=10282&sorter/field=priority&sorter/order=DESC][direct]])

---+++ Contact and Mailing List

You can either ask question about the project on the MailingList or swing by on #stratego on irc://irc.freenote.net.

---+++ Source Repository

The sources of php-tools are available from Subversion.
	* %SVNROOT%/psat/php-tools/trunk

---+++ Developer(s)

	* [[http://ericbouwers.blogspot.com][Eric Bouwers]] (lead developer)

---+++ License

PHP-Tools is LGPL (GNU Lesser General Public License) software.

<!--
	* Set SKIN = customtitle
	* Set CUSTOMTOPICTITLE = PHP-tools
	* Set CUSTOMHEADTITLE = PHP-tools: tools for analyzing PHP-projects
-->