Programmer's Reference Guide

PHP Dateiformatierung

Namens Konventionen

Klassen

Der Zend Framework benutzt eine Klassennamen Konvention wobei die Namen der Klassen direkt mit den Verzeichnissen übereinstimmen muß in welchen Sie gespeichert sind. Das Basisverzeichnis des Zend Framework ist das "Zend/" Verzeichnis, in welchem alle Klassen hierarchisch gespeichert werden.

Klassennamen dürfen nur alphanumerische Zeichen enthalten. Nummern sind in Klassennamen gestattet es wird aber von Ihnen abgeraten. Unterstriche sind nur gestattet im Platz des Pfadseperators -- der Dateiname "Zend/Db/Table.php" muß übereinstimmen mit dem Klassennamen "Zend_Db_Table".

Wenn ein Klassenname aus mehr als einem Wort besteht, muß der erste Buchstabe von jedem neuen Wort großgeschrieben werden. Durchgehende Großbuchstaben sind nicht erlaubt, z.B. eine Klasse "Zend_PDF" ist nicht erlaubt, aber "Zend_Pdf" ist akzeptierbar.

Zend Framework Klassen welche von Zend oder einer der teilnehmenden Partnerfirmen authorisiert und mit dem Framework ausgeliefert werden, müssen immer mit "Zend_" beginnen und im "Zend/" Verzeichnis hierarchisch geordnet gespeichert werden.

Das sind Beispiel von akzeptierbaren Namen für Klassen:

Zend_Db

Zend_View

Zend_View_Helper
                
WICHTIG: Code welche mit dem Framework arbeitet, aber nicht Teil des Frameworks ist, z.B. Code der von Framework Benutzern und nicht von Zend oder einer der Partnerfirmen des Frameworks geschrieben wurde, darf nie mit "Zend_" beginnen.

Interfaces

Interfaceklassen müssen den gleichen Konventionen folgen wie die anderen Klassen (siehe oben), müssen aber mit dem Wort "Interface" enden, wie in diesen Beispielen:

Zend_Log_Adapter_Interface
Zend_Controller_Dispatcher_Interface
                

Dateinamen

Für alle anderen Dateien sind nur alphanummerische Zeichen, Unterstriche, und der Bindestrich ("-") gestattet. Leerzeichen sind verboten.

Jede Datei die irgendeinen PHP Code enthält muß mit der Endung ".php" enden. Diese Beispiele zeigen akzeptierbare Dateinamen welche die Klassennamen der Beispiele der obigen Sektion enthalten:

Zend/Db.php

Zend/Controller/Front.php

Zend/View/Helper/FormRadio.php
                
Dateinamen müssen mit dem Mapping der Klassennamen übereinstimmen wie oben beschrieben.

Funktionen und Methoden

Funktionsnamen dürfen nur Alphanummerische Zeichen enthalten. Unterstriche sind nicht gestattet. Nummern sind in Funktionsnamen gestattet es wird aber von Ihnen abgeraten.

Funktionsnamen müssen immer mit einem Kleinbuchstaben anfangen. Wenn Funktionsnamen aus mehr als einem Wort bestehen, muß der erste Buchstabe jeden Wortes großgeschrieben werden. Das wird normalerweise "camelCase" Formatierung genannt.

Wortreichtum wird beführwortet. Funktionsnamen sollten so wortreich wie möglich sein um die Verständlichkeit des Codes zu erhöhen.

Das sind Beispiele akzeptierbarer Namen für Funktionen:

filterInput()

getElementById()

widgetFactory()
                

Für objekt-orientiertes Programmieren, sollten Zugriffspunkte für Objekte immer mit "get" oder "set" beginnen. Wenn Design-Pattern verwendet werden, wie Singleton oder das Factory Pattern, sollte der Name der Methode den Namen des Pattern enthalten wo es praktikabel ist, um das Pattern schneller begreifbar zu machen.

Für Methoden in Objekten die mit dem "private" oder "protected" Konstrukt deklariert sind, muß das erste Zeichen des variablen Namens ein einzelner Unterstrich sein. Das ist die einzige akzeptable Verwendung von einem Unterstrich im Namen einer Methode. Methoden die als "public" deklariert sind dürfen nie mit einem Unterstrich beginnen.

Funktionen im globalen Bereich ("floating functions") sind gestattet aber es wird von Ihnen abgeraten. Es wird vorgeschlagen das diese Funktionen in einer statischen Klasse gewrappt werden.

Variablen

Variablennamen dürfen nur Alphanummerische Zeichen enthalten. Unterstriche sind nicht gestattet. Nummern sind in Variablen gestattet es wird aber von Ihnen abgeraten.

Für Klassenvariablen die mit dem "private" oder "protected" Konstrukt deklariert werden, muß das erste Zeichen des Funktionsnamens ein einzelner Unterstrich sein. Das ist die einzige akzeptierte Verwendung eines Unterstriches in einem variablen Namen. Klassenvariablen welche als "public" deklariert werden dürfen nie mit einem Unterstrich beginnen.

Wie Funktionsnamen (siehe Abschnitt 3.3, darüber) müssen Variablennamen immer mit einem Kleinbuchstaben starten und der "camelCaps" Schreibweise folgen.

Wortreichtum wird beführwortet. Variablen sollen immer so wortreich wie möglich sein. Von gedrängte Variablennamen wie "$i" und "$n" wird abgeraten für alles andere als die kleinsten Schleifen. Wenn eine Schleife mehr als 20 Codezeilen enthält, benötigen die Variablen der Indezes einen ausführlicheren Namen.

Konstanten

Konstanten können beides enthalten, sowohl Alphanummerische Zeichen als auch den Unterstrich. Nummern sind in Konstantennamen gestattet.

Konstanten müssen alle Buchstaben immer großgeschrieben haben.

Konstanten müssen als Klassenkonstanten definiert werden mithilfe des "const" Konstruktes. Die Definition von Konstanten im globalen Bereich mit "define" ist gestattet aber es wird hiervon abgeraten.


PHP Dateiformatierung
blog comments powered by Disqus

Select a Version

Languages Available

Components

Search the Manual