phm-0.1: Benamung von Klassen

Vorgestern gab es ja den ersten Teil zu meiner kleinen Standardisierungs-Serie. Gestern ist dort in den Kommentaren dann auch eine Diskussion entstanden, die recht interessiert war bzw. ist. Danke dafür an alle Beteiligten. Ich werde die nächste Zeit nochmal die Diskussionen Revue passieren lassen und vielleicht meinen Standard daraufhin auch anpassen. Je nachdem wie die Argumente der unterschiedlichen Parteien aussehen werden. Wer also Lust hat, sollte sich beteiligen.

Fangen wir erstmal mit einer Richtigstellung an. Ich hatte gestern gesagt, die Klassen sollten sich im Namespace Http\Request liegen, was natürlich nicht ganz richtig ist. Die Klassen müssen im Namespace phm\LibraryName\Http\Request liegen. Ansonsten würden sie nicht dem psr-0 entsprechen. Danke dafür an Thomas.

Wir waren im letzten Artikel bei den Interfaces stehen geblieben und haben uns noch keine Gedanken darüber gemacht, wie jetzt eigentlich konkrete Implementierungen benamst werden. Dort gibt es wie ich finde nur eine Sache, die man festlegen muss. Wir hatten gesagt, wir wollen einen Http-Request implementieren, der cURL nutzt, um Aufrufe zu tätigen. Wie schon das Interface muss jetzt die Implementierung im Request-Namespace liegen. Wie aber heißt die Klasse? Ich finde hier haben zwei Alternativen Gültigkeit. Zum einen kann man die Klasse einfach CURL nennen. Da sie sich im Request-Namespace befindet ist klar, dass es sich dabei um einen Request handelt und man muss es nicht mehr explizit im Namen angegeben werden. Die zweite Möglichkeit wäre es CURLRequest zu nennen. Hier hat man zwar eine Dopplung, bei der Verwendung im Code ist es aber klarer, dass es sich um einen Request handelt und das Lesen wird dadurch erleichtert.

Trotz der Dopplung würde ich zur zweiten Lösung tendieren, da ich dort die Lesbarkeit des Codes erhöhe. Die Regel dazu lautet also:

• Klassen tragen ihren Typ im Klassenamen und nicht nur im Namespace.

Wenn wir jetzt diese ganzen Regeln in Beispiele packen wollen, so haben wir folgende Klassen und Interfaces:

• phm\LibraryName\Http\Request\Request
• phm\LibraryName\Http\Request\CURLRequest

Ich hoffe, das heute wieder eine rege Diskussion aufkommt, so dass ich dann mal eine finale Version des phm-0 rausbringen kann, an die ich mich dann auch halten will. CodeSniffer und Co. sollte man dort dann auch drauf ansetzen können. Das ist eben der Vorteil von Standards, dass man von den Tools der anderen profitieren kann.