A.4. Стиль кодирования
Пред. | Приложение A. Стандарт кодирования на PHP в Zend Framework'е | След.

## A.4. Стиль кодирования

### A.4.1. Обрамление PHP-кода

PHP-код должен всегда обрамлятся полными PHP-тегами:

    <?php

    ?>

Короткие теги не допустимы.

### A.4.2. Строки

#### A.4.2.1. Строковые литералы

Когда строка является литеральной (не содержит подстановок переменных), для ее обрамления должны использоваться апострофы или "одинарные кавычки":

    $a = 'Example String';

#### A.4.2.2. Строковые литералы, содержащие апострофы

Когда строка литералов сама содержит апострофы, разрешается для обрамления строки использовать "двойные кавычки". Это особенно актуально для SQL-запросов:

    $sql = "SELECT `id`, `name` from `people` WHERE `name`='Fred' OR `name`='Susan'";

Синтаксис выше является более предпочтительным, чем экранирование апострофов.

#### A.4.2.3. Подстановка переменных

Подстановка переменных разрешается с использованием двух нижеприведенных форм:

    $greeting = "Hello $name, welcome back!";

    $greeting = "Hello {$name}, welcome back!";

Для надежности, эта форма не допустима:

    $greeting = "Hello ${name}, welcome back!";

#### A.4.2.4. Конкатенация строк

Строки должны объединятся с помощью оператора ".". Пробел должен всегда добавлятся до и после оператора "." для улучшения читабельности:

    $company = 'Zend' . 'Technologies';

Когда производится конкатенация строк с помощью оператора ".", разрешается разрывать выражение на несколько строк для улучшения читабельности. В этом случае, каждая следующая строка должна быть дополнена пробелами так, чтобы оператор "." был выровнен под оператором "=":

    $sql = "SELECT `id`, `name` FROM `people` "
         . "WHERE `name` = 'Susan' "
         . "ORDER BY `name` ASC ";

### A.4.3. Массивы

#### A.4.3.1. Массивы с числовыми индексами

Отрицательные числа в качестве индексов запрещены.

Хотя индекс массива может начинаться с отрицательного числа, но это не приветствуется и рекоммендуется, чтобы все массивы начинали индексирование с 0.

Когда определяется индексированный массив с помощью конструкции `array`, завершающий пробел должен быть добавлен после каждой запятой для улучшения читабельности:

    $sampleArray = array(1, 2, 3, 'Zend', 'Studio');

Также разрешается определять многострочные индексированные массивы, используя конструкцию "array". В этом случае, каждая следующая строка должна быть дополнена пробелами так, чтобы начало каждой строки было выравнено как показано ниже:

    $sampleArray = array(1, 2, 3, 'Zend', 'Studio',
                         $a, $b, $c,
                         56.44, $d, 500);

#### A.4.3.2. Ассоциативные массивы

Когда определяется ассоциативный массив с помощью конструкции "array", приветствуется разделение выражения на несколько строк. В этом случае, каждая следующая строка должна быть дополнена с помощью пробелов так, чтобы и ключи и значения были выровнены:

    $sampleArray = array('firstKey'  => 'firstValue',
                         'secondKey' => 'secondValue');

### A.4.4. Классы

#### A.4.4.1. Определение класса

Классы должны определяться по следующей схеме.

Фигурная скобка всегда пишется на следующей строке под именем класса.

Каждый класс должен иметь блок документации (doc-блок) в соответствии со стандартом PHPDocumentor.

Код внутри класса должен иметь отступ в четыре пробела.

Только один класс разрешен внутри одного PHP-файла.

Размещение дополнительно кода в файле с классом разрешено, но не приветствуется. В таких файлах, две пустые строки должны разделять класс и дополнительный PHP-код.

Это пример допустимого определения класса:

    /**
     * Doc-блок здесь
     */
    class SampleClass
    {
        // содержимое класса должно быть
        // с отступом в четыре пробела
    }

#### A.4.4.2. Переменные - члены классов

Переменные - члены классов должны определяться по следующей схеме.

Любые переменные определенные в классе должны быть определенные в начале класса, до определения любого метода.

Ключевое слово `var` не разрешено. Члены класса должны всегда определять их область видимости, используя ключевое слово `private`, `protected` или `public`. Доступ к переменным - членам класса напрямую используя префикс `public` разрешено, но не приветствуется в пользу методов доступа (set/get).

### A.4.5. Функции и методы

#### A.4.5.1. Определение функций и методов

Функции должны определяться по следующей схеме.

Функции внутри классов должны всегда определять свою область видимости с помощью одного из префиксов `private`, `protected` или `public`.

Как и у классов, фигурная скобка всегда пишется на следующей строке под именем функции. Пробелы между именем функции и круглой скобкой для аргументов - отсутствуют.

Функции в глобальной области видимости крайне не приветствуются.

Это пример допустимого определения функции:

    /**
     * Doc-блок здесь
     */
    class Foo
    {
        /**
         * Doc-блок здесь
         */
        public function bar()
        {
            // содержимое класса должно быть
            // с отступом в четыре пробела
        }
    }

ЗАМЕЧАНИЕ: Передача по ссылке допустима только в определениях функций:

    /**
     * Doc-блок здесь
     */
    class Foo
    {
        /**
         * Doc-блок здесь
         */
        public function bar(&$baz)
        {}
    }

Передача по ссылке во время вызова запрещена.

Возвращаемое значение не должно обрамляться в круглые скобки. Иначе это ухудшает читабельность, а также можеть поломать код, если метод позже станет возвращать результат по ссылке.

    /**
     * Doc-блок здесь
     */
    class Foo
    {
        /**
         * ПЛОХО
         */
        public function bar()
        {
            return($this->bar);
        }

        /**
         * ХОРОШО
         */
        public function bar()
        {
            return $this->bar;
        }
    }

#### A.4.5.2. Использование функций и методов

Аргументы функции разделяются одним завершающим пробелом после каждой запятой. Это пример допустимого вызова функции для функции, которая принимает три аргумента:

    threeArguments(1, 2, 3);

Передача по ссылке во время вызова запрещена. Смотрите секцию определения функций для правильного способа передачи аргументов функции по ссылке.

Для функций, чьи аргументы допускают массив, вызов функции может включать конструкцию "array" и может быть разделено на несколько строк для улучшения читабельности. В этом случае, применим стандарт описания массивов:

    threeArguments(array(1, 2, 3), 2, 3);

    threeArguments(array(1, 2, 3, 'Zend', 'Studio',
                         $a, $b, $c,
                         56.44, $d, 500), 2, 3);

### A.4.6. Управляющие структуры

#### A.4.6.1. If / Else / Elseif

Управляющие структуры основанные на `if` и `elseif` конструкциях должны иметь один пробел до открывающейся круглой скобки условия, и один пробел после закрывающейся круглой скобки.

Внутри выражения условия между круглыми скобками операторы должны разделятся пробелами для читабельности. Внутренние скобки приветствуются для улучшения логической группировки больших условий.

Открывающаяся фигурная скобка пишется на той же строке, что и условие. Закрывающаяся фигурная скобка пишется на отдельной строке. Все содержимое между скобками пишется с отступом в четыре пробела.

    if ($a != 2) {
        $a = 2;
    }

Для выражения "if", включая "elseif" или "else", форматирование должно быть таким, как в следующем примере:

    if ($a != 2) {
        $a = 2;
    } else {
       $a = 7;
    }

    if ($a != 2) {
        $a = 2;
    } elseif ($a == 3) {
       $a = 4;
    } else {
       $a = 7;
    }

PHP допускает написание таких выражений без фигурных скобок при некоторых условиях. Стандарт кодирования не делает различий - для всех "if", "elseif" или "else" выражений необходимо использовать фигурные скобки.

Использование "elseif" конструкции допускается, но крайне не приветствуется в пользу "else if" комбинации.

#### A.4.6.2. Switch

Управляющие структуры написанные с использованием "switch" конструкции должны иметь один пробел до открывающейся круглой скобки условного выражение, и также один пробел после закрывающейся круглой скобки.

Все содержимое между фигурными скобками пишется с отступом в четыре пробела. Содержимое каждого "case" выражения должно писаться с отступом в дополнительные четыре пробела.

    switch ($numPeople) {
        case 1:
            break;

        case 2:
            break;

        default:
            break;
    }

Ключевое слово `default` никогда не должно опускаться `switch` выражении.

ЗАМЕЧАНИЕ: Иногда полезно писать `case` выражения, которые передают управление следующему `case` выражению опуская `break` или `return`. Для различия таких случаев от ошибок, каждое `case` выражение, где опущен `break` или `return`, должно содержать комментарий "// break intentionally omitted".

### A.4.7. Встроенная документация

#### A.4.7.1. Формат документации

Все блоки документации ("doc-блоки") должны быть совместимы с форматом phpDocumentor. Описание формата phpDocumentor вне рамок данного докумета. Для дополнительно информации смотрите: http://phpdoc.org/

Все файлы с исходными кодами написанные для Zend Framework'а или которые оперируют с фреймворком должны содержать "файловые" doc-блоки в начале каждого файла и "классовый" doc-блок непосредственно перед каждым классом. Ниже примеры таких doc-блоков.

#### A.4.7.2. Файлы

Каждый файл, содержащий PHP-код должен иметь заголовочный блок в начале файла, содержащий как минимум следующие phpDocumentor-теги:

    /**
     * Краткое описание файла
     *
     * Длинное описание файла (если есть)...
     *
     * LICENSE: Some license information
     *
     * @copyright  2005 Zend Technologies
     * @license    http://www.zend.com/license/3_0.txt   PHP License 3.0
     * @version    CVS: $Id:$
     * @link       http://dev.zend.com/package/PackageName
     * @since      File available since Release 1.2.0
    */

#### A.4.7.3. Классы

Каждый класс должен иметь doc-блок, содержащий как минимум следующие phpDocumentor-теги:

    /**
     * Краткое описание класса
     *
     * Длинное описание класса (если есть)...
     *
     * @copyright  2005 Zend Technologies
     * @license    http://www.zend.com/license/3_0.txt   PHP License 3.0
     * @version    Release: @package_version@
     * @link       http://dev.zend.com/package/PackageName
     * @since      Class available since Release 1.2.0
     * @deprecated Class deprecated in Release 2.0.0
     */

#### A.4.7.4. Функции

Каждая функция, включая методы объектов, должны иметь doc-блок, содержащий как минимум:

- Описание функции

- Все аргументы

- Все возможные возвращаемые значения

Нет надобности использовать тег "@access", потому что область видимости уже известна из ключевых слов "public", "private" или "protected". используемых при определении функции.

Если функция/метод может выбрасывать исключение, используйте тег @throws:

    @throws exceptionclass [описание]

Пред. | Уровень выше | След.
A.3. Соглашения по именованию | Начало | Приложение B. Copyright Information