Composer und PHPMD in IntelliJ IDEA einrichten

Wie im Artikel Entwicklungsumgebung für PHP unter Windows einrichten beschrieben, wollte ich PHPMD nutzen. Dabei handelt es sich um ein Tool zur statischen Code-Analyse nach dem Vorbild des in der Java-Welt bekannten Tools PMD. Es hat sich herausgestellt, dass es am einfachsten ist, wenn PHPMD via Composer eingerichtet wird.

Da ich beides in IntelliJ nutzen möchte, beschreibe ich, wie die Einrichtung der beiden Tools für IntelliJ funktioniert.

Hinweis: Wichtig ist, dass das PHP-Plugin aktiviert ist und bereits ein Projekt angelegt wurde. Ich vermute, dass die Einrichtung für PHPStorm ähnlich, wenn nicht sogar genauso funktioniert.

Composer einrichten

Composer muss zunächst wie im Artikel Entwicklungsumgebung für PHP unter Windows einrichten beschrieben installiert werden. Anschließend kann in IntelliJ über das Menü File -> Settings… => PHP -> Composer der Pfad zur composer.phar-Datei angegeben werden.

Einfacher geht es noch, wenn man dafür das Kontext-Menü im Projektfenster und den Dialog dazu verwendet. Dann wird auch gleich eine passende JSON-Datei für das Projekt generiert.

 

PHPMD einrichten

Download

PHPMD holen wir uns von der offiziellen Seite des Projekts, zu finden unter http://static.phpmd.org/php/latest/phpmd.phar. Einfach auf den Link klicken und die Datei speichern.

Ob PHPMD funktioniert, lässt sich mit dem Aufruf von php phpmd –version in der Eingabeaufforderung prüfen. Es darf kein Fehler angezeigt werden, sondern PHPMD x.y.z (wobei x.y.z die heruntergeladene Version von PHPMD ist)

Kommt es dabei zu der Fehlermeldung, dass bz2 notwendig ist, muss noch eine Anpassung in der php.ini-Datei vorgenommen werden:

  • Eintrag extension=php_bz2.dll aktivieren (das ‚;‘ rausnehmen)

 

Einrichten

(Der Absatz hat sich geändert ist nun gültig für IntelliJ 14.x)

Nach der Installation muss PHPMD noch aktiviert und eingerichtet werden. Dazu wieder über das Menü File -> Settings… aufrufen und im Bereich PHP den Punkt Mess Detector auswählen. Hinter dem Feld „Configuration“ auf den Button […] klicken. Hier kann nun direkt PHP aufgerufen werden und damit die .phar-Datei von phpmd.

Anschließend kann der Eintrag mit einem Klick auf Validate geprüft werden. Hat alles geklappt, wird in grün die Version von PHPMD angezeigt. Ansonsten in rot eine entsprechende Fehlermeldung.

Es reicht aber noch nicht, IntelliJ zu sagen, wo PHPMD zu finden ist, es muss auch noch aktiviert werden. Dazu File -> Settings… => Inspections aufrufen und im rechten Teil in der Liste PHP aufklappen. Am Ende der (Standard-)Inspections von IntelliJ zu PHP findet sich ein neuer Eintrag: PHP Mess Detector. Dieser kann über die Checkbox am rechten Rand aktiviert werden.

Wählt man den Eintrag aus, können unter Options nun die Rulesets ausgewählt werden, die angewendet werden sollen. Auswählbar sind die Standard-Rulesets. Es können aber auch eigene hinzugefügt werden.

Via Strg + Alt + Shift + I wird nun PHPMD zusätzlich zu den Prüfungen, die IntelliJ ohnehin schon ausführt angewendet.

 

Mit diesen Werkzeugen behalten wir den Überblick über unsere Abhängigkeiten und haben eine gute Basis für sauberen Code.

 

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.

Diese Website verwendet Akismet, um Spam zu reduzieren. Erfahre mehr darüber, wie deine Kommentardaten verarbeitet werden.