Formatowanie kodu PHP

Klasy

Nadając nazwy klasom, staraj się, aby były one jasne i nie zawierały skrótów. Nazwa klasy powinna rozpoczynać się dużą literą. W celu zawarcia informacji o hierarchii klas stosuj znak podkreślenia:

1. Log
2. Net_Finger
3. HTML_Upload_Error

Listing zwinięty - 3 linii

Składowe prywatne należy poprzedzać prefiksem _:

var $_nazwa_pliku;

Funkcje i metody

Przy nazywaniu funkcji i metod stosuje się zasadę "wielbłądzich garbów" (ang. camel caps). Oznacza to, że nazwę funkcji rozpoczyna się zawsze małą literą, zaś każdy kolejny człon (tj. wyraz, skrót lub fragment wyrazu) literą dużą. Ewentualnie nazwę funkcji można poprzedzać prefiksem pakietu:

1. connect()
2. getData()
3. buildSomeWildget()
4. XML_RPC_serializeData()

Listing zwinięty - 4 linii

Nazewnictwo plików

Pliki zawierające klasy najlepiej nazywać nazwą klasy, nadając im rozszerzenie .class.php, na przykład: Smarty.class.php. Można ewentualnie pominąć człon .class w nazwie pliku DB.php.

Każdą klasę należy zapisać w osobnym pliku lub też zgrupować w jednym pliku kilka klas współpracujących ze sobą.

Plikom zawierającym stałe, zmienne globalne oraz funkcje nadawaj rozszerzenie .inc.php, ewentualnie pomijając człon .inc: walidacja.inc.php, function.eval.php.

Przykładowe adresy URL

Zgodnie z dokumentem RFC 2602, poprawnymi przykładowymi adresami URL są adresy zawierające jedną z następujących nazw domenowych: example.com, example.org lub example.net. Na przykład:

http://www.example.org/skrypt.php?
imie=Jan&nazwisko=Nowak
email:ktos@example.net

Spójność formatu

Wymagania wymienione powyżej są w znacznej mierze oparte na wielokrotnie wspomnianym już dokumencie "Standardy kodowania biblioteki PEAR". Zagadnienia nieporuszone przez standardy (m.in. kilka operatorów, puste wiersze, wcinanie komentarzy) oparłem na własnych przyzwyczajeniach oraz na kodach aplikacji wymienionych we wstępie.

Zwróć uwagę na pewien ważny aspekt formatowania kodu, a mianowicie jego spójność. Może się zdarzyć tak, że części zasad nie zaakceptujesz i pozostaniesz przy stosowaniu własnych rozwiązań. Dla przykładu formatowanie referencji możesz chcieć zapisywać w postaci: $a =& $b;.

W takiej sytuacji powinieneś konsekwentnie stosować jeden z zapisów. Bałaganiarstwem jest pisanie:

1. $a =& $b;
2. ...
3. $a = &$b;

Listing zwinięty - 3 linii

A bałaganiarstwo nigdy nie popłaca.

Jeśli z jakichkolwiek powodów zdecydujesz się na krótkie otwarcie PHP oraz wcięcia przy użyciu tabulatorów, wówczas w całym skrypcie (czy też we wszystkich skryptach w przypadku większych projektów), musisz konsekwentnie stosować wybrane rozwiązanie.