Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

--- dev:all:standards2 [10.08.2014 23:34] – [Funktionen und Methoden] Manuela v.d.Decken
+++ dev:all:standards2 [14.09.2014 07:18] (aktuell) – gelöscht Manuela v.d.Decken
@@ Zeile 1: / Zeile 1: @@
-====== Coding Standards #2 ======
-===== Namens-Konventionen =====
-==== Allgemeines ====
-WebsiteBaker übernimmt auch hier weitgehendst die Standards von Zend in einer an die Besonderheiten von WB angepassten Form. Die wichtigste Abweichung findet sich im Aufbau der Suchpfade für die Dateien. In späteren Versionen wird auch hier eine weitere Annäherung an Zend erfolgen.
-<blockquote>{{:info.png?nolink&32 |Hinweis}}
-**Hinweis:**
-Die strikte Einhaltung dieser Konventionen ist zwingend erforderlich, damit es bei verschiedenen Modulen keine Namensgleichheiten von Klassen und Funktionen/Methoden geben kann. Der Core ist dadurch in der Lage, die Position der Klassendateien anhand der Klassennamen eindeutig zu bestimmen, um sie durch den auf WB optimierten Autoloader nachzuladen. Eine explizite Einbindung der Klassendateien per include() oder require() wird dadurch überflüssig.
-</blockquote>WebsiteBaker ab v2.9.0 erfordert PHP 5.4.x als Mindestvoraussetzung. Für eine Übergangszeit sind 2 verschiedene Namenskonventionen für Klassen zulässig. Das erklärte Ziel ist jedoch die durchgängige Umstellung auf Namespaces um deren Vorteile zu nutzen und auch den Benennungsaufwand deutlich reduzieren zu können.
-==== Klassen ====
-Klassennamen müssen in **StudlyCaps** deklariert werden und müssen folgender RegEx-Regel entsprechen: '/[A-Z][a-zA-Z0-9]+/'. Nummern sind in Klassennamen gestattet, sollten jedoch auf das Notwendigste beschränkt werden und keine Verwechslungsgefahr mit Buchstaben bergen. Besteht der Klassenname aus mehr als einem Wort, so ist der jeweils erste Buchstabe eines Wortes groß zu schreiben. Mehrere aufeinanderfolgende Großbuchstaben sind nicht erlaubt. Beispiel anhand eines Namens:
-^Bezeichner ^ Stautus |
-|smtp_mailer | [color=red]falsch[/color] |
-|Smtp_Mailer | [color=red]falsch[/color] |
-|SMTPmailer | [color=red]falsch[/color] |
-|SmtpMailer | [color=green]richtig[/color] |
-==== Abstrakte Klassen und Interfaces ====
-Generell folgen abstrakte Klassen und Interfaces der gleichen Konvention wie Klassen, mit einer zusätzlichen Regel: Die Namen von abstrakten Klassen und Interfaces müssen mit derm Term "**Abstract**" bzw. "**Interface**" enden, und dem Term darf kein Unterstrich vorangestellt sein. Als Beispiel wird //**Plugin_Abstract**// als ungültig angenommen, aber **PluginAbstract** oder **m_MyModul_PluginAbstract** wären gültige Namen.
-==== Emulierte Namespaces ====
-In diesem Modus ist in Klassennamen zusätzlich der Unterstrich '_' als Sonder-/Funktionszeichen gestattet. Er dient jedoch ausschließlich als Pfadseperator. Klassennamen bestehen hier nicht allein aus dem bis jetzt definierten Namen, sondern müssen zusätzlich noch genau definierte Präfixes enthalten. Nur dann ist es möglich, aus dem Klassennamen den exakten Dateinamen zu ermitteln, so dass die passende Datei bei einem Zugriff auf eine Klasse automatisch geladen(included) werden kann.
-Die Klassenbibliotheken von WebsiteBaker sind in mehrere Gruppen aufgeteilt:\\
-**Klassen des Kerns**:  sind im Verzeichnis **''/framework/''** oder einem seiner Unterverzeichnisse zu finden. Hierfür ist kein Prefix erforderlich.\\
-**Klassen der Module**: Klassen der Module im jeweiligen Modulverzeichnis **''/modules/%modul_name%/''** oder einem seiner Unterverzeichnisse. Der Bezeichner muss zwingend den Prefix  '**m_**' erhalten. **Beispiel:** m_MyModule_PluginInterface \\
-**Klassen des ACP**: (AdminControlPanel => ehem. Backend) sind im Verzeichnis **''/admin/''** oder einem seiner Unterverzeichnisse zu finden. Der KlassenBezeichner muss zwingend den Prefix '**a_**' erhalten. **Beispiel:** a_Pages_PageTree\\
-**Klassen der third-party libraries**: die im Verzeichniss **''/include/''** sowie seinen Unterverzeichnissen liegen, werden vom Autoloader nicht automatisch erfasst. Jede Library hat jedoch die Möglichkeit, eine eigene Registrierung im SPL-Autoloaderstack vorzunehmen. Mehr dazu in der Beschreibung des Autoloaders.
-==== Dateinamen ====
-Soweit die vorgenannten Regeln für Klassennamen eingehalten wurden, ergeben sich die Dateinamen eindeutig aus den Klassennamen. Die Klasse **m_MyModul_PluginAbstract** findet sich demnach in der Datei **''/modules/MyModul/PluginAbstract.php''**.\\
-Für alle anderen Dateien sind nur alphanummerische Zeichen und der Bindestrich (**-**) gestattet. Leerzeichen sind völlig verboten.\\
-Jede Datei die irgendeinen PHP Code enthält sollte mit der Endung **.php** enden.
-==== Funktionen und Methoden ====
-Funktionsnamen dürfen nur Alphanummerische Zeichen enthalten. Unterstriche sind nicht gestattet. Nummern sind in Funktionsnamen gestattet aber in den meisten Fällen nicht empfohlen.
-Funktionsnamen sollten den StudlyCaps-Konventionen folgen und immer mit einem Großbuchstaben anfangen. Wenn Funktionsnamen aus mehr als einem Wort bestehen, muß der erste Buchstabe jeden Wortes großgeschrieben werden. Wortreichtum wird generell befürwortet. Funktionsnamen sollten so wortreich wie möglich sein um deren Zweck und Verhalten möglichst genau zu erklären.
-Für Objekt-orientiertes Programmieren, sollten Zugriffspunkte zu Methoden oder Eigenschaften möglichst immer mit einem klein geschriebenen Verb wie //get//, //set//, //add//, //delete//, //load//, //save//, //execute// etc. beginnen, das dann von einem Substantiv in StudlyCaps gefolgt wird, welches das zu bearbeitende Objekt beschreibt. Beispiel: <php> $oMyObject->saveItemList(); </php> oder <php> $oMyObject->reloadAllModules(); </php>
-Für Methoden in Objekten die mit dem "private" Modifikator deklariert sind, muß das erste Zeichen des Namens der Methode ein einzelner Unterstrich sein. Das ist die einzige akzeptable Anwendung von einem Unterstrich im Namen einer Methode. Methoden die als "public" deklariert sind sollten nie einem Unterstrich enthalten.
-:!: **Achtung:** Es dürfen niemals doppelte Unterstriche als Prefix für Methoden-, Funktions- oder Variablennamen verwendet werden. Es besteht hier die Gefahr, dass es zu Überschneidungen mit aktuellen oder zukünftigen, PHP-eigenen Magic-Functions etc. kommt.

WebsiteBaker Documentation

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Unterschiede

Seiten-Werkzeuge