1.4 Der PEAR-Coding Standard 

Der PEAR-Coding Standard ist ein Standard, der für Programmierer gedacht ist, die selbst Pakete entwickeln. Ich werde hier nur auf die Punkte eingehen, die für Sie als Anwender hilfreich sein können. Den kompletten Standard finden Sie unter der URL http://pear.php.net/manual/en/standards.php.

Sie werden beim Lesen des Buchs feststellen, dass ich mich zum Beispiel bei der Klammersetzung nicht an den PEAR-Coding Standard halte.

1.4.1 Aufbau der Dateien 

Einrückungen werden in den Quelltexten immer durch vier Leerzeichen dargestellt. Es werden keine Tabulatorsprünge genutzt, um eine Plattformunabhängigkeit zu gewährleisten.

Zeilenumbrüche sind mit einem einfachen Linefeed (\n) darzustellen. Dadurch könnten Sie in einigen Windows-Editoren Probleme haben, dass die Zeilenumbrüche nicht korrekt dargestellt werden.

Als Zeichensatz wird ISO-8859–1 für die Dateien genutzt. Bitte beachten Sie das, wenn Sie die Dateien mit Betriebssystemen bearbeiten, die UTF-8 nutzen, wie das bei OS X oder Linux der Fall sein könnte.

1.4.2 Klammersetzung 

Um geschweifte Klammern zu setzen, gibt es zwei unterschiedliche Regeln: die eine für Kontrollstrukturen und die andere für Klassen und Funktionen. Bei Kontrollstrukturen wie if-Abfragen, Schleifen oder switch-Konstrukten soll die öffnende geschweifte Klammer am Ende der Zeile platziert werden, die das Konstrukt einleitet. Die schließende geschweifte Klammer ist am Anfang einer Zeile auf derselben Höhe zu platzieren wie das Schlüsselwort, das das Konstrukt einleitet.

Für Klassen, Methoden und Funktionen gilt, dass die öffnende geschweifte Klammer in der Zeile unterhalb des Schlüsselwortes function oder class zu platzieren ist. Die Einrückungstiefe ist identisch mit der der deklarierenden Zeile, was auch für die schließende Klammer gilt.

Das folgende Beispiel verdeutlicht das:

function foobar() 
{ 
   // Tut was 
} 
 
class foo 
{ 
   function bar() 
   { 
      if (bedingung) { 
         // Mach was 
      } else { 
         // Mach was anderes 
      } 
      while (bedingung) { 
         // Wiederhol was 
      } 
   } 
}

Wenn Sie einen Blick in die Quelltexte werfen, werden Sie feststellen, dass viele Entwickler sich nicht immer daran halten. Gerade bei Klassen und Methoden wird oft die öffnende Klammer in derselben Zeile platziert wie der Beginn der Deklaration:

class foo { 
   function bar () { 
      // Mach was 
   } 
}

1.4.3 Namenskonvention 

Auch für die Benennung von Klassen und Methoden sind Regeln vorgesehen. Die Namen von Klassen setzen sich in den meisten Fällen aus mehreren Wörtern zusammen, die durch Unterstriche voneinander abgeteilt werden. Handelt es sich bei einem Teil des Namens um eine Abkürzung, so wird diese komplett in Großbuchstaben dargestellt. Handelt es sich um ein normales Wort, wird nur der erste Buchstabe großgeschrieben und der Rest klein. Ein typisches Beispiel ist die Klasse HTML_Template_Flexy. Die Klasse gehört zu einem Paket, das in der Kategorie HTML angesiedelt ist und dort zur Unterkategorie Template gehört. Anhand des Klassennamens können Sie auch sofort erkennen, in welcher Datei die Klasse definiert ist. Die Datei heißt Flexy.php und liegt im Ordner HTML/Template.

require_once('HTML/Template/Flexy.php'); 
 
$flexy = new HTL_Template_Flexy;

In einigen Fällen setzt sich ein Teil des Namens aus zwei Wörtern zusammen. In dem Fall wird das zweite Wort durch einen Großbuchstaben eingeleitet, was zum Beispiel für File_SearchReplace gilt.

require_once('File/SearchReplace.php'); 
 
$flexy = new File_SearchReplace;

Allerdings werden Sie feststellen, dass es auch hier einige Ausreißer gibt, die sich nicht an die Konvention halten.

Die Namen von Methoden beginnen üblicherweise mit einem Kleinbuchstaben. Setzen sie sich aus mehreren Wörtern zusammen, so wird das neue Wort mit einem Großbuchstaben eingeleitet.

$db->connect(); 
$db->affectedRows(); 
$db->setFetchMode()

Private Methoden und Eigenschaften, also solche, auf die von außen nicht zugegriffen werden soll, sind jeweils mit einem Unterstrich einzuleiten. Namen von selbst definierten Konstanten sind komplett in Großbuchstaben zu schreiben, und einzelne Wörter sind durch einen Unterstrich voneinander abzugrenzen.