Code-Vervollständigung für CakePHP-Applikationen unter Eclipse

Die Eclipse-IDE eignet sich zum Entwickeln von vielen Programmiersprachen, unter anderem auch PHP. Ich bin zur Zeit am Entwickeln eines Webprojekts mit Hilfe des Frameworks CakePHP. Dieser Eintrag erklärt Schritt-für Schritt wie man die Code-Vervollständigung für ein Projekt aktiviert ohne den ganze CakePHP-Code im Eclipse-Projekt zu haben.

Für die nachfolgende Einrichtung wird vorausgesetzt, dass Eclipse installiert ist (mit PHP-Unterstützung), das CakePHP-Framework ebenfalls heruntergeladen und entpackt wurde und über den (lokalen) Webserver erreichbar ist (die Startseite meldet das erfolgreiche Backen der Anwendung). Falls schon mehr vom Projekt besteht => umso besser.

1. Neues Projekt erstellen (File -> New -> PHP Project)
2. Projektname eingeben (beliebig)
3. Im Feld „Contents“ die Auswahl „Create project at existing location (from existing sources)“ auswählen und das „app“-Verzeichnis aus dem CakePHP-Verzeichnis auswählen. Bei der Standart-Installation von CakePHP befinden sich die applikationsspezifischen Daten im Verzeichnis „app“, die Framework spezifischen Daten in „cake“ und in „plugins“ und „vendors“ befindet sich nichts.
4. Auf „Next >“ klicken
5. Im Abschnitt „Libraries“ auf „Add Library…“ klicken und dort „User Library“ auswählen.
6. Falls CakePHP nicht bereits in der Liste angezeigt wird auf „Configure…“ klicken.
7. „New…“-Button anklicken um eine neue PHP-Library anzulegen.
8. In das Feld „User library name“ den Namen von CakePHP eingeben, z.B. „CakePHP Version 2.0 DEV“. Mit „OK“ bestätigen. Die Nennung der Versionsnummer erleichtert das Handling falls mehrere Projekte mit verschiedenen CakePHP-Version in Eclipse entwickelt werden.
9. Nun den eben angelegten Eintrag auswählen und auf der rechten Seite „Add External folder…“ anklicken. Im Auswahl-Bildschirm das „cake“-Verzeichnis auswählen (worin sich die Framework-spezifischen Dateien befinden). Bestätigen.
10. Den obigen Schritt für die Verzeichnisse „plugins“ und „vendors“ wiederholen. Wichtig: Nicht die plugins/vendors-Unterverzeichnis aus dem „app“-Folder auswählen sondern aus dem Elternverzeichnis.
11. Alle Fenster schliessen bis nur noch das Fenster „New PHP Project“ offen ist und dort den Reiter „Order“ auswählen.
12. Überprüfen und allenfalls korrigieren, dass das Projekt-Verzeichnis zu oberst in der Liste steht. Anschliessend mit „Finish“ beenden.

Fertig. Ab sofort hat man nun Code-Vervollständigung zur Hand.

Falls man auch Unit-Tests entwickelt will, kann das Unit-Test-Framework ebenfalls als „User Library“ eingebunden werden. Somit hat man auch Zugriff auf alle Methoden des Frameworks in der Code-Vervollständigungsliste. Zumindest funktioniert das für CakePHP-Version 2, das als Unit-Test-Framework auf PHPUnit setzt. Aber es sollte auch für Version 1.3.* funktionieren, dass noch auf SimpleTest setzt.

Falls das Eclipse-Projekt bereits besteht oder Änderungen an den Bibliothekseinstellungen gemacht werden müssen, können die über die Projekt-Einstellungen vorgenommen werden (Project -> Properties -> PHP Include Path).