Выжимка из требований PEAR к оформлению PHP-кода. Ниже перечислены не все, но наиболее часто используемые правила.
- Вместо табуляции – 4 пробела
- Размер строки – 75-85 символов
- Всегда используйте фигурные скобки для управляющих структур тип if, switch
<?php
if ((condition1) || (condition2)) {
action1;
} elseif ((condition3) && (condition4)) {
action2;
} else {
defaultaction;
}
?>
<?php
switch (condition) {
case 1:
action1;
break;
case 2:
action2;
break;
default:
defaultaction;
break;
}
?>
- Параметры функции разделяются пробелом
<?php
$var = foo($bar, $baz, $quux);
?>
- Функция должна возвращать значение
- Фигурная скобка при определении функций и классов ставится на следующей строке
<?php
class Foo_Bar
{
//… code goes here
}
?>
- Если объявление массива разбито на несколько строк, то значения должны быть выровнены, а после последнего – ставится запятая
- Комментарии – в стиле C и C++ (/* */ и // соответственно), а не в стиле Perl (#)
- Если файл включается при выполнении определенных условий, используется include_once, в остальных случаях – require_once
- Теги PHP – только <?php ?>, а не <? ?>
- Имена классов начинаются с заглавной буквы
- Имена переменных и методов классов начинаются с прописной буквы, каждая буква нового слова – в верхнем регистре: buildSomeWidget()
- Имена приватных членов класса предваряются знаком подчеркивания: $_status
- Имена констант – заглавными буквами, слова отделены знаком подчеркивания: SERVICES_AMAZON_S3_LICENSEKEY
