Coding Style Index

(:toc:)

• ITestClass.interface.php

Methodennamen beginnen mit einem Kleinbuchstaben und folgen der mixedCaseSyntax.

Zusammengesetzte Namen sind mit Unterstrich (underscore_syntax) oder Großbuchstaben (MixedCaseSyntax) zu trennen.

Dem Namen eines Arrays wird ein "a" vorangestellt, gefolgt von der MixedCaseSyntax (Klassen-/Interface-/Methoden-/Attribut-/Parameter-Kontext) oder der underscore_syntax (Funktions-/Variablen-Kontext).

Dem Namen der Referenzvariablen oder eines Refenrenzargumentes so wie dem Namen einer Funktion/Methode, die Referenzen zurückliefern, wird ein "r" vorangestellt, gefolgt von der MixedCaseSyntax (Klassen-/Interface-/Methoden-/Attribut-/Parameter-Kontext) oder der underscore_syntax (Funktions-/Variablen-Kontext).

Dem Variablennamen wir ein "g" vorangestellt, gefolgt von der MixedCaseSyntax (Klassen-/Interface-/Methoden-/Attribut-/Parameter-Kontext) oder der underscore_syntax (Funktions-/Variablen-Kontext).

Dem Namen einer statischen Variablen wir ein "s" vorangestellt, gefolgt von der MixedCaseSyntax (Klassen-/Interface-/Methoden-/Attribut-/Parameter-Kontext) oder der underscore_syntax (Funktions-/Variablen-Kontext).

• DbManager
• StudipSemTreeView

Dem Namen der Class Member Variable wird ein "m" vorangestellt, gefolgt von der MixedCaseSyntax.

Non-Class Member Variablennamen werden klein geschrieben und ggf. mit "_" getrennt (underscore_syntax).

Die Parameter einer Methode oder Funktion beginnen mit einem Kleinbuchstaben und werden in mixedCaseSyntax geschrieben.

Dem Namen eines Arrays wird ein "a" vorangestellt, gefolgt von der MixedCaseSyntax (Klassen-/Attribut-/Parameter-Kontext) oder der underscore_syntax (Funktions-/Variablen-Kontext).

Dem Namen der Referenzvariablen oder eines Refenrenzargumentes so wie dem Namen einer Funktion/Methode, die Referenzen zurückliefern, wird ein "r" vorangestellt, gefolgt von der MixedCaseSyntax (Klassen-/Attribut-/Parameter-Kontext) oder der underscore_syntax (Funktions-/Variablen-Kontext).

Dem Variablennamen wir ein "g" vorangestellt, gefolgt von der MixedCaseSyntax (Klassen-/Attribut-/Parameter-Kontext) oder der underscore_syntax (Funktions-/Variablen-Kontext).

• global $g_log

Dem Namen einer statischen Variablen wir ein "s" vorangestellt, gefolgt von der MixedCaseSyntax (Klassen-/Attribut-/Parameter-Kontext) oder der underscore_syntax (Funktions-/Variablen-Kontext).

    static $msStatus = 0;

Klassennamen beginnen immer mit einen Großbuchstaben und folgen der MixedCaseSyntax.

Methodenname beginnen mit einem Kleinbuchstaben und folgen der mixedCaseSyntax.

Funktionen (die also nicht Teil von Klassendefinitionen sind) bekommen Namen in underscore_syntax und nur mit Kleinbuchstaben. Dem Funktionsnamen den Package-Namen voranstellen, um Kollisionen mit anderen Funktionsnamen zu vermeiden.

Zusammengesetzte Namen sind mit Unterstrich oder Großbuchstaben zu trennen.

Bestimmten Variablentypen werden bestimmte Buchstaben vorangestellt:

• lib_classes_Table
• lib_classes_StudipSemTreeView

PHP-Files, die ein Interface enthalten, sind nach dem Interfacename zu benennen und enden auf ".interface.php".

Bsp:

Bsp:

• TestClass.class.php

Bsp:

• ITestClass.inerface.php

Bsp:

• testscript.inc.php

Bsp:

• Lib_Classes_Table
• Lib_Classes_StudipSemTreeView

Bsp:

• ITestClass

Bsp:

• showSemTree()

Bsp:

• getUsername()
• setUsername()

Funktionen

Funktionen (die also nicht Teil von Klassendefinitionen sind) in underscore_syntax. Funktionsnamen sollte der Package-Name vorangestellt werden, um Kollisionen mit anderen Funktionsnamen zu vermeiden.

• lib_get_object_name()

• Referenz als Klassenattribut: $rmMyMemberClassVariable

Bsp:

• $mUserName

Bsp:

• $user_name

Bsp:

• setParam($myParam)

Bsp:

• $aMyArray
• $a_my_array

Bsp:

• $rVariable
• function fct(&rArgument)
• function &rFct() { }

Bsp:

• global $gLog

Bsp: [@function test()

}@]

• Files

• Methoden

• Funktionen

• Klassenattribute
• Nicht-Klassenattribut Variablen
• Parameter
• Arrays
• Referenzvariablen / Funktionen, die Referenzen zurückgeben
• Globale Variablen
• Statische Variablen
• Konstanten

Files

Bsp:

• TestClass.class.php

Bsp:

• ITestClass.inerface.php

Bsp:

• testscript.inc.php

Bsp:

Interfacenamen beginnen mit einem großen I und danach in der MixedCaseSyntax. Wenn das Interface die Funktionalität nur einer Klasse definiert, sollte das Interface wie folgt heißen: I+KlassenName.

Bsp:

• ITestClass

Methoden

Bsp:

Bsp:

• getUsername()
• setUsername()

Funktionen

Bsp:

Verschiedenen Variablen-Typen werden verschiedene Buchstaben vorangestellt:

• "m" - Class Member Variable
• "a" - Array
• "r" - Reference
• "g" - Global Variable
• "s" - Static Variable

Klassenattribute

Dem Namen der Class Member Variable wird ein "m" vorangestellt.

Nicht-Klassenattribut Variablen

Non-Class Member Variablennamen werden klein geschrieben und ggf. mit "_" getrennt.

Bsp:

• $user_name

Parameter

Die Parameter einer Methode oder Funktion werden in mixedCaseSyntax geschrieben.

• setParam($myParam)

Arrays

Dem Namen eines Arrays wird ein "a" vorangestellt.

Referenzvariablen / Funktionen, die Referenzen zurückgeben

Dem Namen der Referenzvariablen oder eines Refenrenzargumentes so wie dem Namen einer Funktion/Methode, die Referenzen zurückliefern, wird ein "r" vorangestellt.

Globale Variablen

Dem Variablennamen wir ein "g" vorangestellt.

Statische Variablen

Dem Namen einer statischen Variablen wir ein "s" vorangestellt.

Bsp: function test() {

  static $msStatus = 0;

}

• Interfaces
• Methodennamen

• Funktionsnamen
• Variablen
  • Class Attribute Name
  • Method Argument Names
  • Variablennamen
  • Array Name
  • Referenzvariablen / Funktionen, die Referenzen zurückgeben
  • Globale Variablen
  • Statische Variablen
  • Konstanten

PHP-Files, die ein Interface enthalten, sind nach dem Interfacename zu benennen und enden auf ".interface.php".

Eine PHP-Datei sollte nur maximal eine Klasse enthalten. Falls eine Klasse enthalten ist bekommt die Datei den Namen der Klasse + .class.php.

Interfaces

Interfacenamen beginnen mit einem großen I und danach in der Klassennamensyntax. Wenn das Interface die Funktionalität nur einer Klasse definiert, sollte das Interface wie folgt heißen: I+Klassenname.

Eine PHP-Datei sollte nur maximal ein Interface enthalten.

Funktionsnamen

Funktionen (die also nicht Teil von Klassendefinitionen sind) in underscore_syntax. Funktionsnamen sollte der Package-Name vorangestellt werden, um Kollisionen mit anderen Funktionsnamen zu vermeiden.

Beispiel für Funktionsname:

• Lib_get_object_name()

Zusammengesetzte Namen sind mit Unterstrich oder Großbuchstaben zu trennen. (Bei Variablen unterscheidet PHP zwischen Groß- und Kleinschreibung.)

Verschiedene Typen von Variablen werden verschiedene Buchstaben vorangestellt:

• m - Class Member Variable
• a - Array
• r - Reference
• g - Global Variable
• s - Static Variable

Diese Buchstaben können miteinander kombiniert werden, z.B.:

• Referenz auf Klassenvariable: $rmMyVariable

Class Attribute Name

Dem Namen der Class Member Variable wird ein m vorangestellt.

Bsp:

• $mUserName

Method Argument Names

Die Argumente einer Methode werden in mixedCaseSyntax geschrieben.

Variablen Namen

Variablennamen werden klein geschrieben und ggf. mit _ getrennt.

Bsp:

• $user_name

Array Name

Dem Namen eines Arrays wird ein a vorangestellt.

Bsp:

• $aMyArray
• $a_my_array

Referenzvariablen / Funktionen, die Referenzen zurückgeben

Dem Namen der Referenzvariablen oder eines Refenrenzargumentes so wie dem Namen einer Funktion/Methode, die Referenzen zurückliefern, wird ein r vorangestellt.

Bsp:

• $rVariable
• function fct(&rArgument)
• function &rFct() { }

Globale Variablen

Dem Variablennamen wir ein g vorangestellt.

Bsp:

• global $gLog

Statische Variablen

Dem Namen einer statischen Variablen wir ein s vorangestellt.

Konstanten

Konstanten werden immer vollständig groß geschrieben, mit Unterstrichen zwischen den Worten. Ihre Namen müssen mit dem Klassen- bzw. Package-Namen beginnen. Zum Beispiel beginnen alle Konstanten des DB::-Packages mit DB_.

Anmerkung: Die Konstanten true, false und null werden als einzige Ausnahme immer klein geschrieben.

Verwende beschreibende, aussagekräftige Namen und vermeide Abkürzungen! Auch sollten Uppercase Abkürzungen (wie z.B. HTML oder XML) vermieden und nur der erste Buchstabe groß geschrieben werden ( z.B. Html oder Xml).

Methoden sollten der mixedCaseSyntax folgen.

• showSemTree()

PHP-Files, die ein Interface enthalten, enden mit ".interface.php".

Übersicht

• Namensgebung
• Filename
• Klassen
• Methodennamen
• Funktionsnamen
• Accessor-Methoden
• Variablen
  • Konstanten
  • Globale Variablen
• Beispiel-URLs

Namenskonventionen

[ Zurück: Formatierung | Index: Übersicht | Vor: Fehlerbehandlung ]

Namensgebung

Verwende beschreibende, aussagekräftige Namen und vermeide Abkürzungen!

Filename

PHP-Filenamen enden auf ".php".

PHP-Files, die eine Klasse enthalten, sind nach den Klassennamen zu benennen. Zusätzlich wird ".class.php" angehängt.

PHP-Files, die inkludiert werden, enden mit ".inc.php" oder sollten in einem Unterverzeichnis liegen.

Klassen

Klassennamen beginnen immer mit einen Großbuchstaben. Die Klassenhierarchie spiegelt sich auch im Klassennamen wieder, jede Ebene der Hierarchie wird durch einen einzelnen Unterstrich getrennt. Darauf folgend werden Klassennamen in MixedCaseSyntax geschrieben.

Beispiele für Klassennamen:

• Lib_Classes_Table
• Lib_Classes_StudipSemTreeView

Eine PHP-Datei sollte maximal nur eine Klasse enthalten. Falls eine Klasse enthalten ist bekommt die Datei den Namen der Klasse + .class.php.

Methodennamen

Methoden sollten der mixedCaseSyntax folgen. Methodennamen sollten der Package-Name vorangestellt werden. Der erste Buchstabe nach dem Prefix wird klein geschrieben, und jeder Buchstabe eines neuen „Wortes“ im Namen wird großgeschrieben.

Beispiel für Methodenname:

• Lib_Classes_showSemTree()

Funktionsnamen

Funktionen (die also nicht Teil von Klassendefinitionen sind) in underscore_syntax. Funktionsnamen sollte der Package-Name vorangestellt werden, um Kollisionen mit anderen Funktionsnamen zu vermeiden.

Beispiel für Funktionsname:

• Lib_get_object_name()

Accessor-Methoden

Accessor-Methoden müssen mit den Schlüsselwwörtern get bzw. set gekennzeichnet werden. Der erste Buchstabe des Variablennamens wird groß geschrieben.

• Getter-Methode: get+Variablenname
• Setter-Methoden: set+Variablenname

Variablen

Zusammengesetzte Namen sind mit Unterstrich oder Großbuchstaben zu trennen. (Bei Variablen unterscheidet PHP zwischen Groß- und Kleinschreibung).

Session Variablen, die nur von einem bestimmten Script genutzt werden (wie z.B. edit_about), sollten einen neuen "Namensraum" in $_SESSION durch Anlegen eines Arrays (wie z.B. $_SESSION['edit_about'] = array('x' => 1, 'y' => 2);) bekommen.

Konstanten

Konstanten werden immer vollständig groß geschrieben, mit Unterstrichen zwischen den Worten. Ihre Namen müssen mit dem Klassen- bzw. Package-Namen beginnen. Zum Beispiel beginnen alle Konstanten des DB::-Packages mit DB_.

Anmerkung: Die Konstanten true, false und null werden als einzige Ausnahme immer klein geschrieben.

Globale Variablen

Wenn Ihr Package globale Variablen benötigt, sollte deren Name mit einem Unterstrich beginnen, gefolgt vom Package-Namen und einem weiteren Unterstrich. Zum Beispiel: $_Lib_destructor_object_list.

Beispiel-URLs

Benutzen Sie example.com, example.org und example.net für alle Beispiel-URLs und Email-Adressen entsprechend RFC 2606.

Session Variablen, die nur von einem bestimmten Script genutzt werden (wie z.B. edit_about), sollten einen neuen "Namensraum" in $_SESSION durch Anlegen eines Arrays (wie z.B. $_SESSION['edit_about'] = array('x' => 1, 'y' => 2);) bekommen.

PHP-Filenamen enden auf ".php".

PHP-Files, die eine Klasse enthalten, sind nach den Klassennamen zu benennen. Zusätzlich wird ".class.php" angehängt.

PHP-Files, die inkludiert werden, enden mit ".inc.php" oder sollten in einem Unterverzeichnis liegen.

• PHP-Files, die inkludiert werden, enden mit ".inc.php" oder sollten in einem Unterverzeichnis liegen.

Filename

• PHP-Filenamen enden auf ".php".
• PHP-Files, die eine Klasse enthalten, sind nach den Klassennamen zu benennen. Zusätzlich wird ".class.php" angehängt.

• PHP-Filenamen enden auf ".php".
• PHP-Files, die eine Klasse enthalten:

• Filenamen enden auf ".php".

Namensgebung

Verwende beschreibende, aussagekräftige Namen und vermeide Abkürzungen!

Klassennamen beginnen immer mit einen Großbuchstaben. Die Klassenhierarchie spiegelt sich auch im Klassennamen wieder, jede Ebene der Hierarchie wird durch einen einzelnen Unterstrich getrennt. Darauf folgend werden Klassennamen in MixedCaseSyntax geschrieben.

Zusammengesetzte Namen sind mit Unterstrich oder Großbuchstaben zu trennen. (Bei Variablen unterscheidet PHP zwischen Groß- und Kleinschreibung).

• Files, die eine Klasse enthalten:

Filename

• Bei Files die eine Klasse enthalten:

Das File ist nach dem Klassennamen zu benennen. Zusätzlich wird .class.php angehängt.

Accessor-Methoden

Accessor-Methoden müssen mit den Schlüsselwwörtern get bzw. set gekennzeichnet werden. Der erste Buchstabe des Variablennamens wird groß geschrieben.

• Getter-Methode: get+Variablenname
• Setter-Methoden: set+Variablenname

Beispiel-URLs

Benutzen Sie example.com, example.org und example.net für alle Beispiel-URLs und Email-Adressen entsprechend RFC 2606.

Variablen

Variablen sollten aussagekräftige Namen haben. Zusammengesetzte Namen sind mit Unterstrich oder Großbuchstaben zu trennen. (Bei Variablen unterscheidet PHP zwischen Groß- und Kleinschreibung).

Session Variablen, die nur von einem bestimmten Script genutzt werden, sollten den Namen des Scriptes mit dem Zusatz "_data" enthalten, etwa bekommt die edit_about die Sessionvariable edit_about_data zugeteilt. So verhindert man Probleme mit gleichen Sessionvariablen auf verschiedenen Seiten.

Verwenden Sie beschreibende Klassennamen und vermeiden Sie Abkürzungen. Klassennamen beginnen immer mit einen Großbuchstaben. Die Klassenhierarchie spiegelt sich auch im Klassennamen wieder, jede Ebene der Hierarchie wird durch einen einzelnen Unterstrich getrennt. Darauf folgend werden Klassennamen in MixedCaseSyntax geschrieben.

• Lib_Classes_Table
• Lib_Classes_StudipSemTreeView

Eine PHP-Datei sollte maximal nur eine Klasse enthalten. Falls eine Klasse enthalten ist bekommt die Datei den Namen der Klasse + .class.php.

Methodennamen

Methoden sollten der mixedCaseSyntax folgen. Methodennamen sollten der Package-Name vorangestellt werden. Der erste Buchstabe nach dem Prefix wird klein geschrieben, und jeder Buchstabe eines neuen „Wortes“ im Namen wird großgeschrieben.

Beispiel für Methodenname:

• Lib_Classes_showSemTree()

Funktionsnamen

Funktionen (die also nicht Teil von Klassendefinitionen sind) in underscore_syntax. Funktionsnamen sollte der Package-Name vorangestellt werden, um Kollisionen mit anderen Funktionsnamen zu vermeiden.

Beispiel für Funktionsname:

• Lib_get_object_name()

Wenn Ihr Package globale Variablen benötigt, sollte deren Name mit einem Unterstrich beginnen, gefolgt vom Package-Namen und einem weiteren Unterstrich. Zum Beispiel: $_Lib_destructor_object_list.

[ Zurück: Formatierung | Index: Übersicht | Vor: Fehlerbehandlung ]

Namenskonventionen

Klassen

Verwenden Sie beschreibende Klassennamen und vermeiden Sie Abkürzungen. Klassennamen beginnen immer mit einen Großbuchstaben. Die Klassenhierarchie in PEAR spiegelt sich auch im Klassennamen wieder, jede Ebene der Hierarchie wird durch einen einzelnen Unterstrich getrennt.

Beispiele für Klassennamen:

• Log
• Net_Finger
• HTML_Upload_Error

Funktionen und Methoden

Funktionen und Methoden sollten dem „Studly Caps“-Stil folgen (auch bekannt als „Bumpy Base“ oder „Camel Caps“). Funktionsnamen sollte der Package-Name vorangestellt werden, um Kollisionen mit anderen Funktionsnamen zu vermeiden. Der erste Buchstabe nach dem Prefix wird klein geschrieben, und jeder Buchstabe eines neuen „Wortes“ im Namen wird großgeschrieben.

Beispiele:

• connect()
• getData()
• buildSomeWidget()
• XML_RPC_serializeData()

Privaten Klassenelemente wird ein Unterstrich vorangestellt.

Zum Beispiel:

• _sort()
• _initTree()

$this->_status

Anmerkung: Unter PHP 5 gilt: Klassenelemente, welche protected sind, werden nicht mit einem Unterstrich versehen:

• protected $somevar
• protected function initTree()

Konstanten

Konstanten werden immer vollständig groß geschrieben, mit Unterstrichen zwischen den Worten. Ihre Namen müssen mit dem Klassen- bzw. Package-Namen beginnen. Zum Beispiel beginnen alle Konstanten des DB::-Packages mit DB_.

Anmerkung: Die Konstanten true, false und null werden als einzige Ausnahme immer klein geschrieben.

Globale Variablen

Wenn Ihr Package globale Variablen benötigt, sollte deren Name mit einem Unterstrich beginnen, gefolgt vom Package-Namen und einem weiteren Unterstrich. Zum Beispiel benutzt das PEAR-Package die globale Variable $_PEAR_destructor_object_list.