Die CopyPaste Detection für PHP (phpcpd) ist eine wunderbare Sache und lässt sich einfach aufrufen und in phpUnderControl integrieren. Doch die Stellen zu suchen und zu Eliminieren kann schon etwas mühsam sein. Deutlich einfacher geht es mit dem Eclipse Plugin:  PHP Tool Integration. Hier kann man seit kurzem nicht nur den CodeSniffer innerhalb von Eclipse nutzen, sondern auch die CopyPaste Detection.

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:

Ich nutze die Eclipse PHP Tool Integration Tools jetzt standardmäßig wegen der guten  Code Sniffer Integration wie bereits in einen älteren Blogbeitrag beschrieben.

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.

Leider gibt es in den PHP Tools für Eclipse einen kleinen Bug unter Windows wenn man ein eigenen Coding Standard verwenden will. Der PHP_CodeSniffer kann mit dem Parameter –standard aufgerufen werden und der CodeSniffer sucht in dem Pfad nach Sniff Dateien. Der CodeSniffer verwendet dafür die PHP Konstante DIRECTORY_SEPARATOR die ja bekanntlich unter Windows ein \ ist und kein /. Jetzt sollte man unter Windows den CodeSniffer wie folgt aufrufen:

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 Tool PHP_CodeSniffer ist ein praktisches Tool um den PHP Code auf Einhaltung der Coding Style Guides zu prüfen. Mann kann das Tool einfach über den Befehl phpcs aufrufen und auch relativ einfach eigene Sniffs erstellen die den Code prüfen.

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.