Elnevezési szabályok

Osztályok

Adjunk beszédes nevet az osztályoknak. Kerüljük rövidítések használatát, ahol lehetséges. Az osztálynevek mindig nagybetűvel kezdődjenek. A PEAR osztályhierarchia is tükröződjön az osztályok nevében, a hierarchia minden szintje egy önálló hangosközzel (underscore, "_") legyen elválasztva. Példa helyes osztálynevekre:

Log Net_Finger HTML_Upload_Error

Függvények és metódusok

A függvényeket és a metódusokat a "studly caps" -stílus szerint nevezzük el (hívják még "bumpy case " és "camel caps" stílusnak is). Az elnevezés továbbá tartalmazza prefixként a csomag nevét, a csomagok közötti elnevezés-ütközések elkerülése érdekében. Az elnevezés kezdőbetűje (a prefix után) kisbetű, ezt követően minden új "szó" kezdőbetűje nagybetűvel írandó. Néhány példa:

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

A privát osztály tagokat (osztály tagok, amelyeket csak abból az osztályból szándékozunk használni, amelyben deklarálva vannak; a PHP még nem támogatja a valódi privát névterületeket) vezessük be egy szimpla hangosközzel. Például:

_sort() _initTree() $this->_status

Konstansok

A konstansokat mindig írjuk végig nagybetűvel, hangosközt használva a szavak elhatárolására. Neveikben használjuk előképzőként annak az osztálynak/csomagnak a végig nagybetűkkel írt nevét, amelyben használva vannak. Például a DB:: csomag által használt konstansok nevei a DB_ karaktersorozattal kerülnek bevezetésre.

A true, false és null konstansok kivételt képeznek a nagybetűs szabály alól: ezek mindig kisbetűkkel írandók.

Globális változók

Ha a csomagunknak szüksége van globális változók definiálására, azok neveit kezdjük egy szimpla hangosközzel ("_"), folytatva a csomag nevével, majd egy további hangosközzel. Például, a PEAR csomag által használt egyik globális változó a $_PEAR_destructor_object_list.

Példa URL-ek (Previous) Fájlformátumok (Next)
Last updated: Mon, 01 Sep 2014 — 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?