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.

Sebastian Bergmann hat mit phploc ein kleines Tool geschaffen, das einem ein kurzen Überblick über die Beschaffenheit des PHP Projektes gibt. Im Gegensatz zu PHP_Depend beschränkt sich die Auswertung auf ein paar werte, die aber für eine Auswertung innerhalb eines continues integration Prozess ausreichen würde. Es eignet sich nicht um die Schwachstellen zu finden.

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.

Das PHP Pear Packet “PHP_Depend” eignet sich hervoragent zur Analyse der Code Qualität des eigenen PHP Projekts. Es lässt sich einfach über den Pear Installer installieren und kann dann auf der Comando Zeile über den Befehl “pdepend” aufrufen. Es wird nur PHP benötigt und kein Webserver oder Datenbank. Eine Installation unter Windows war ohne Probleme möglich.

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.

In der neuen Typo3 Version 4.3 existiert eine neue Klasse t3lib_PageRenderer in der die CSS und Javascript Dateien registriert werden können. In dieser Klasse ist es vorgesehen die CSS Dateien zu bündeln und zu komprimieren. Da diese Funktionen noch nicht implementiert sind und es aber die Möglichkeit für Hooks gibt habe ich die Extension js_css_optimizer erstellt, die diese Lücke füllt.

Die Extension registriert folgende Hooks:

• cssCompressHandler – zum Komprimieren der CSS Dateien
• jsCompressHandler – zum Komprimieren der JavaScript Dateien
• concatenateHandler – zum Bündeln der Dateien
• clearCachePostProc – zum Löschen der gecachten Dateien im typo3temp Verzeichnis

CSS Komrpimierung

Hierbei wird das Tool CSSTidy verwendet.  Die Konfiguration lässt sich über den Extension Manager in Typo3 einstellen.

Die CSS Datei wird in einem neuen Verzeichnis abgelegt. Die Extension versucht dabei die relativen Pfade in der CSS Datei auf Bilder um zuschreiben. Hier ist eventuell noch Anpassungbedarf.

Damit die CSS Datei komprimiert wird muss folgender Typo Script Code ergänzt werden:

page {
includeCSS {
 screenStyle = ..../base.css
 screenStyle {
   media = screen
   import = 0
   compress=1
 }

JavaScript Komprimierung

Für das JavaScript wird die JSMin Klasse aus dem Typo3 Core verwendet. Es wird nicht die t3lib::minify… verwendet, da diese nicht so effektiv ist.

In TypoScript kann die Komprimierung einzeln ein und ausgeschaltet werden:

page{
 includeJS {
 file1 = ....common.js
 file1.compress=1
...

Bündelung

Die Bündelung der Javascripte und CSS Dateien kann über TypoScript aktiviert werden.  Dafür gibt es diese Einstellung:

config.concatenateJsAndCss = 1

Hierbei ist nicht möglich CSS und JavaScript unterschiedlich zu behandeln. Deshalb gibt es in der Extension die Möglichkeit über den Extension Manager die Bündelung beispielsweise für CSS auszuschalten.

Wenn bestimmte Dateien auf jeder Seite benötigt werden, dann macht es Sinn diese als Libs einzubinden. Dafür gibt es im TypoScript die Option includeJSlibs.

page.includeJSlibs{
  jquery = ...jquery-1.3.2.min.js
  ...
}

Dann werden die in eine separate Datei geschrieben und können vom Browser separat gecacht werden.

Caching

Die komprimierten und gebündelten Dateien werden in dem typo3Temp Verzeichnis abgelegt. Die Cache Datei werden nicht erneuert sondern müssen gelöscht werden um neu erzeugt zu werden. Das Löschen passiert automatisch wenn im Typo3 Backend der Cache gelöscht wird.

Javascript und CSS aus den Plugins hinzufügen

Wenn man früher in einem Plugin JavaScript oder CSS Daten hinzufügen wollte ohne TypoScript hat man das über $GLOBALS['TSFE']->additionalHeaderData machen. Da diese Daten nicht als JS oder CSS deklariert sind nutzen sie in diesen Kontext nichts mehr.  Man kann jetzt mittels $GLOBALS['TSFE']->getPageRenderer() auf den PageRenderer zugreifen und diesen die JS und CSS Dateien bekannt machen. Wenn man mit dem PageRenderer arbeitet kann man auch die Vorteile der Komprimierung und Bündelung nutzen. Es lohnt sich deshalb die Klasse t3lib_PageRenderer genauer anzuschauen.

In der neuen Typo3 Version 4.3 wird es diese TypoScript Einstellung geben mit der man die Javascript Import aus den Header Bereich der Seite an das Ende der Seite vor den schließenden Body Tag verschieben kann.

Dadurch erreicht man ein schnelleres Rendern der Seite vom Browser und damit eine subjektiv schnellere Ladezeit.

config.moveJsFromHeaderToFooter = 1

Das funktioniert aber nur bei Dateien die explizit als Javascript Dateien im Typo3 System bekannt sind. Dateien die einfach über $GLOBALS['TSFE']->additionalHeaderData  eingefügt worden sind, werden nicht verschoben.

Wiesbaden – Essen & Trinken – Cafes & Coffee Shops

Das Café ist ein Traum. Man kommt in die Prunkvolle Villa und hat erstmal eine wunderbare Auswahl an französischen Törtchen. Die Räume sind sehr stilvoll eingerichtet und es erinnert an französische Schlösser. Draußen kann man schön in der Nachmittagssonne sitzen und blickt auf die Bäume des Warmen Damm.

Trotz dieses gehobenen eleganten Ambiente sind die Preis günstig und der Service sehr freundlich und schnell. Am meisten begeistert hat mich die gute Tee Auswahl. Der Tee war wirklich hochwertig und wurde schön angerichtet.

Kaffee und Kuchen gibt es woanders besseren, aber waren trotzdem gut und lecker.

Dieses Café ist so wie man es sich bei einer Stadt wie Wiesbaden vorstellt. Hat lange gefehlt und ich liebe es jetzt schon.

Mein Beitrag zu Café Weißes Haus – Ich bin ajung – auf Qype

das Bundesamt für Arbeit (BA) bietet eine kostenlose Schnittstelle zum Veröffentlichen von Jobs auf deren Webseite. Das Interessante dabei ist, dass die Jobs von dort auch auf vielen anderen Job-Portalen veröffentlicht werden kann.

Für meine alte Firma hatte ich die Aufgabe, alle Jobs automatisiert über die XML Schnittstelle an das BA zu übertragen.

Der grobe Ablauf läuft folgendermaßen ab:

1. Man erstellt eine XML Datei mit den Jobs im speziellen HR-BA Format.
2. Diese Datei wird mit einem speziellen FTP Programm auf den BA Server übertragen.
3. Das BA liest diese XML Datei ein und veröffentlicht die Jobs.

Vorbedingung

Um die XML Schnittstelle zu nutzen benötigt man einen Vertrag mit der BA. Wenn der Vertrag unterschrieben ist bekommt man neben der Dokumentation eine CD mit einen Zertifikat für die FTP Übertragung.

Die HR-BA XML Datei

Die XML Datei ist im Gegensatz zu anderen Jobportalen sehr umfangreich. Zum Glück gibt es eine XSD mit der man die erstellte Datei prüfen kann. Eine valide Datei kann aber noch fachliche Fehler haben, aber dabei bekommt man Hilfe vom BA.

Beim Erstellen der XML Datei gibt es einige Knackpunkte:

1. Es wird ein Code für das Bundesland benötigt.  In meinen Fall musste ich diesen Code erstmal aus der Postleitzahl ermitteln.
2. Für den Titel muss ein spezieller Titel Code angegeben werden den man aus einer riesigen XML Datei ermitteln muss. Das macht ein automatisches Importieren sehr umständlich wenn man nicht die Titel des BA verwendet. In meinen Fall habe ich anhand einiger Merkmale den Job-Titel ermitteln können und hart hinterlegt. Das geht aber auch nur weil die Jobs in der Firma sehr ähnlich sind.
3. Man muss leider angeben ob ein Job neu angelegt, aktualisiert oder gelöscht werden soll. Diesen Job übernimmt das BA leider nicht. Ich verwende dafür den Zeitstempel der zuletzt hoch geladenen Datei und vergleiche diesen mit den Zeitstempel des Eingangsdatum und dem Datum der Löschung des Job Eintrages.
4. Die XML Datei muss einen ganz speziellen Datei Namen besitzen, damit die Datei überhaupt eingelesen wird. Dafür werden verschiedene IDs verwendet und das benötigte noch ein wenig Abstimmung mit der Technikabteilung des BA.

FTP Upload

Der FTP Upload geht leider nur mittels einem speziellen Programm:  Connect Direct FTP+. Damit dieses überhaupt eine Verbindung zum BA Server zustande bekommt muss ein Spezielles Zertifikat installiert werden und dann kann man sich mittels einer GUI auf den Server verbinden. Es stehen einem zwei Ordner zur Verfügung.

1. in: hier werden die XML Dateien zum hochladen der Jobs abgelegt
2. out: hier kann man die Titel Codes der Berufe und die Fehler Protokolle herunterladen

Das Programm lässt sich auch über die Komandozeile aufrufen. Steuern lässt es sich darüber aber nicht. Man kann aber eine Art Steuerungs Datei beim Starten des Programm angeben und dieses enthält dann die Befehle die das FTP Programm ausführen soll.

Ich habe dafür ein kleines Visual Basic Programm geschrieben das diese Steuerungsdatei anhand der erzeugten XML Datei (Dateiname ist immer unterschiedlich) erstellt und dann das FTP Programm zusammen mit dieser Datei aufruft:

Sub Upload()
        Console.WriteLine("Start CDFtp Upload")
        Dim content As String = vbCr & "cd in" & vbCr
        content = content & "lcd current" & vbCr
        content = content & "put " & XmlFile & vbCr
        content = content & "quit"
        My.Computer.FileSystem.WriteAllText(SyncFile, content, False)
        Dim command As String = "C:\Programme\CDFtp\CDFtp.exe -s:" & SyncFile & " open"
        Dim returnID As Integer = Shell(command, AppWinStyle.NormalFocus, True)
        Console.WriteLine("Finish CDFtp Upload")
    End Sub

Dieses Programm führe ich über die geplanten Tasks täglich aus. Dieses Verfahren läuft jetzt schon seit einigen Monaten problemlos. Die aktuell aktiven Jobs kann man sich im Service bereich für Arbeitgeber des BA anschauen und auch per Hand ergänzen oder löschen.