Zend Framework по-русски

К сожалению, далеко не все следуют стандартам кодирования ZF при разработке своих скриптов. Признаюсь, и я нередко отступаю от них, а иногда и вовсе забываю некоторые моменты. Поэтому и пишу эту краткую памятку по их использованию.

1. Форматирование PHP-файлов
   1. Для файлов, содержащих только PHP-код, закрывающий тег (?>) не разрешён
   2. Отступ – 4 пробела
   3. Рекомендуемый предел длины строки – 80 символов. Максимальная длина – 120.
   4. Unix-style перевод строки (\n)
2. Соглашения по именованию
   1. Классы
      1. Имена классов могут содержать только буквенно-числовые символы. Числа разрешены, но не рекомендуются.
      2. Если имя класса состоит из более чем одного слова, то первая буква каждого слова должна быть заглавной. Последующие заглавные буквы недопустимы.
      3. Символы нижнего подчеркивания допустимы в местах разделителей пути – имя файла “Zend/Db/Table.php” должно указывать на класс с именем “Zend_Db_Table”.
      4. Код, написанный пользователем фреймворка и не являющийся его частью, не может иметь префикс “Zend_”
   2. Интерфейсы именуются так же, как и классы, с обязательным словом Interface в конце имени (Zend_Log_Adapter_Interface)
   3. В именах файлов допустимы буквенно-числовые символы, символы нижнего подчеркивания и тире (“-”). Пробелы запрещены.
   4. Функции и методы
      1. Имена функций могут содержать буквенно-числовые символы. Символы нижнего подчеркивания не разрешены. Числа разрешены в именах функций, но не приветствуются.
      2. “Верблюжья” нотация
      3. Многословность приветствуется
      4. “Плавающие” функции не рекомендуются
      5. Методы доступа должны иметь префикс get и set
      6. При использовании паттернов проектирования, имена методов должны содержать имя паттерна
   5. Переменные
      1. Имена переменных могут содержать буквенно-числовые символы. Символы нижнего подчеркивания не разрешены. Числа разрешены в именах переменных, но не приветствуются.
      2. private и protected свойства классов должны начинаться с символа “_”
      3. “Верблюжья” нотация
      4. Многословность приветствуется
      5. Короткие имена переменных ($i, $j) разрешены только в циклах менее 20 строк
   6. Константы
      1. Могут содержать буквенно-числовые символы и символы нижнего подчеркивания. Числа разрешены в именах констант.
      2. Имена должны быть в верхнем регистре
      3. Использование констант глобальной области видимости не рекомендуется
3. Стиль кодирования
   1. Только полные PHP-теги (<?php ?>)
   2. Строки
      1. Литеральные строки обрамляются апострофами
      2. Литеральные строки, содержащие апострофы, обрамляются двойными кавычками
      3. Допустимые формы подстановки переменных: “Hello $name”, “Hello {$name}”
      4. При конкатенации строк “.” обрамляется пробелами с обоих сторон
      5. Когда производится конкатенация строк с помощью оператора “.”, разрешается разрывать выражение на несколько строк для улучшения читабельности. В этом случае, каждая следующая строка должна быть дополнена пробелами так, чтобы оператор “.” был выровнен под оператором “=”
   3. Массивы
      1. Отрицательные числа в качестве индексов запрещены
      2. При определении массива с помощью array() завершающий пробел должен быть добавлен после каждой запятой
   4. Классы
      1. Фигурная скобка всегда пишется на следующей строке под именем класса
      2. Обязательный doc-блок
      3. Только один класс разрешен внутри одного PHP-файла
      4. Любые переменные, определенные в классе, должны быть определены в начале класса, до определения любого метода
      5. Ключевое слово var не разрешено
      6. Члены класса должны всегда определять их область видимости, используя ключевое слово private, protected или public
      7. Доступ к переменным-членам класса напрямую используя префикс public разрешено, но не приветствуется в пользу методов доступа (set/get)
   5. Функции и методы
      1. Функции внутри классов должны всегда определять свою область видимости с помощью одного из префиксов private, protected или public
      2. Фигурная скобка всегда пишется на следующей строке под именем функции
      3. Пробелы между именем функции и круглой скобкой для аргументов отсутствуют
      4. Обязательный doc-блок
      5. При вызове функции аргументы разделяются одним завершающим пробелом после каждой запятой
   6. Управляющие структуры
      1. Управляющие структуры, основанные на конструкциях if, elseif и switch, должны иметь один пробел до открывающей круглой скобки условия, и один пробел после закрывающей круглой скобки
      2. Внутри выражения условия между круглыми скобками операторы должны разделяться пробелами для читабельности
      3. Внутренние скобки приветствуются для улучшения логической группировки больших условий
      4. Открывающаяся фигурная скобка пишется на той же строке, что и условие. Закрывающаяся фигурная скобка пишется на отдельной строке.
      5. Конструкции без фигурных скобок запрещены
      6. В конструкции switch содержимое каждого “case” выражения должно писаться с отступом в 4 пробела
      7. Ключевое слово default обязательно
      8. Иногда полезно писать case выражения, которые передают управление следующему case выражению, опуская break или return. Для того, чтобы отличать такие случаи от ошибок, каждое case выражение, где опущен break или return, должно содержать комментарий “// break intentionally omitted”.
   7. Все doc-блоки должны быть совместимы с форматом phpDocumentor