Namens-Konventionen

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 Untersrich 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

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_.

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.

Beispiel-URLs (Previous) Dateiformate (Next)
Last updated: Sun, 19 Dec 2010 — Download Documentation
Do you think that something on this page is wrong? Please file a bug report or add a note.
View this page in:

User Notes:

Note by: user@example.com
codextasy, I've read some PEAR packages code and they use "public $foo_bar" and "private $_foo_bar".
Note by: codextasy
What about local variables inside functions and methods:
$my_local_var or $myLocalVar?
Note by: Carl
Yes, PHP 5.x has truly private methods and properties if they are preceded by the "private" keyword.
Note by: hablutzel1@hotmail.com
I supposed that in php5 private properties are really private. or is it wrong?
Note by: user@example.com
PHP does not yet support truly-enforceable private namespaces

In PHP 5 you have truly-enforceable private namespaces, don't you?