Das Tool lässt sich einfach über das Context Menü aufrufen:

Im Editor werden dann die Fehler angezeigt:

Zur Installation sollte man diese Eclipse Update Seite verwenden:

http://www.phpsrc.org/eclipse/pti/

Danach muss man noch die Einstellungen anpassen und die PHP Executable und die PEAR Libary anpassen:

Darüber hinaus beinhaltet das Eclipse Plugin auch eine Funktion zum schnellen Ausführen von Unit Tests.

Wenn man an einen Unit Test arbeitet kann man einfach einen Button im Eclipse anklicken zum Ausführen des Tests.

Erstmal ist das relativ unspannend, da das selbe passiert wie bei einem Kommandozeilen Aufruf und die Ausgabe nur  unschön in der Eclipse Console erscheint.

Es spart aber immerhin einen Toolwechsel und einige Klicks.

Wirklich praktisch finde ich aber die Auswertung der Fehler im Editor von Eclipse. Dort wird die Stelle wo der Fehler aufgetreten ist als unterstrichener Fehler markiert.

Es wird nicht nur die Stelle im Test markiert sondern Fehler die in den getesteten Code Aufgetreten sind. Wenn dort ein PHP Fehler auftritt oder eine Exception geworfen wird die nicht abgefangen wird, wird diese Stelle markiert. So braucht man nicht anhand der Zeilen Nummern die Stellen suchen.

PHP Fatal error:  Cannot redeclare class

Aus dem Code war kein Grund dafür ersichtlich da alle Dateien mit require_once eingebunden waren. Das Problem lag dabei in der Verwendung von Mock Klassen ohne diese vorher importiert zu haben.

Ich kann mit folgenden Code eine Object der Klasse Example erstellen ohne die original Klasse zu laden.

$object = $this->getMock ( 'Example', array (), array (), '', false );

Wenn danach die original Klasse Example importiert wird, ist diese schon deklariert und es kommt zu diesen Fehler. Abhilfe tut hier ein require_once im Test:

require_once('path/to/Example.php');
$object = $this->getMock ( 'Example', array (), array (), '', false );

Dann klappt es auch mit der Coverage Auswertung.

phpcs --standard=C:\path\to\standard

Wenn man aber bei den PHP-Tools in die Debug Ausgabe schaut wird folgender Befehl ausgeführt

phpcs --standard=C:/path/to/standard

Dadurch findet der CodeSniffer die Dateien nicht.

Ich habe den Bug gemeldet und hoffe das es bald behoben ist.

Als Workaround habe ich den CodeSniffer innerhalb des PEAR Packet angepasst und folgende Zeile ergänzt:

PHP\CodeSniffer.php Zeile 400

$this->standardDir = str_replace('/',DIRECTORY_SEPARATOR,$this->standardDir);

In Eclipse muss man dann noch bei den PHP-Tools Einstellungen die lokale PEAR Libary verwenden.

Das Ergebnis kann in einer XML Datei ausgegeben werden und dann zum Beispiel in phpUnderControl eingebunden werden. Für die Entwicklung ist es aber recht mühsam die Stellen per Hand zu suchen und zu fixen. Besser geht das mit den den PHP Tools für Eclipse. Nach der Installation über die Update Seite hat man in den  Eclipse Einstellungen ein neuen Bereich mit den Einstellungen für den CodeSniffer.

Hier lässt sich einfach ein eigener “Coding Standard” auswählen.

Danach steht das Programm im Kontext Menü zur Verfügung. Man kann den CodeSniffer auch in den Validierungs Prozess von Eclipse aktiveren.

Dann werden die Dateien automatisch mit den CodeSniffer validiert.

Die Fehler oder Warnungen werden in der Datei angezeigt:

Unter Windows gibt es noch einen kleinen Bug mit den DIRECTORY_SEPARATOR der sich umgehen lässt indem man eine eigene PEAR Libary einbindet und dort den Bug behebt. Ich suche aber noch nach einer eleganteren Lösung.

Ganz praktisch dafür ist ist die Möglichkeit der Debug Ausgabe in der Eclipse Console.

Sinnvoll ist es auch zu zur Prüfung ob ein Opensource Projekt den eigenen Ansprüchen genügt oder ob ein schlechter Code zu erwarten ist mit dem man auf Dauer nicht arbeiten kann.

phploc wird einfach über den PEAR Installer installiert und kann dann über die Komandozeile über diesen Befehl aufgerufen werden.

> phploc "C:\...."

Ich habe ein bekanntes Projektmanagementtool mit diesen Tool getestet und folgendes Ergebnis bekommen.

Auffällig ist das hier keinerlei Interfaces und Abstrakte Klassen verwendet werden. Der Code ist relativ gut dokumentiert. Die Methoden haben mit durchschnittlich 36 Zeilen zu viel Logik und auch die Cyclomatische Komplexität ist etwas zu hoch. Der hohe Anteil an öffentlichen Methoden sprechen für eine potentielle Instabilität. Dafür scheint die Package Struktur übersichtlich zu sein.

Man kann PHP_Depend über einen beliebigen Code Ordner laufen lassen und sich dabei verschiedenen Formate ausgeben lassen.

JDepend ist ein Format aus der JavaWelt und wohl auch für den Namen des Projektes verantwortlich

JDepend traverses Java class file directories and generates design quality metrics for each Java package. JDepend allows you to automatically measure the quality of a design in terms of its extensibility, reusability, and maintainability to manage package dependencies effectively.

• –jdepend-chart=….svg Erzeugt eine SVG Grafik die die Instabilität in Abhängigkeit zur Abstraktion anzeigt
• – jdepend-xml=…xml Gibt diese Informationen als XML Datei aus

Es gibt auch eine reine XML Ausgabe,  in der die Ergebnisse für jede einzelne Datei steht

• –summary-xml=….xml

Spannend ist auch die Pyramiden Darstellung

• –overview-pyramid=….xml

@package

Wenn man in seinen PHPDoc Kommentaren nicht mit dem @package Element gearbeitet hat muss man den Parameter –bad-documentation angeben. Lässt man den weg wird entweder gar nichts erzeugt oder nur für die Dateien die diesen Element besitzen. Um ordentlich mit dem Tool arbeiten zu können, sollte man @package ergänzen.

Typo3 Vergleich

Ich habe man den Kern von Typo3 Version 4 und 5 mit dem Tool analysiert:

JDepend Chart:

Typo3 4

Typo3 5

Überblick:

Typo3 4

Typo3 5

Aussagekräftig ist dieser Vergleich natürlich noch nicht, da Version 5 noch kaum Code enthält, aber man kann einen deutliche besseren Code erkennen.