Форматировщик кода PHP

Что означает форматирование

Форматировщик меняет только разметку. Код должен делать то же самое до и после. Инструмент применяет короткий список правил разметки:

• Каждая точка с запятой завершает строку.
• Каждая открывающая фигурная скобка стоит на отдельной строке, и каждая закрывающая тоже.
• Код внутри фигурных скобок отступается на один уровень за каждую глубину вложенности.
• После запятой ставится один пробел.
• Пустые строки в результате удаляются.

Он не добавляет пробелы вокруг операторов, не переименовывает ничего и не меняет порядок кода.

Пример до и после

Исходные данные:

<?php class User{private $name;public function getName(){return $this->name;}}

Результат с 4 пробелами:

<?php class User
{
    private $name;
    public function getName()
    {
        return $this->name;
    }
}

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

Когда лучше использовать что-то другое

Инструмент считает фигурные скобки и точки с запятой обычными символами. Он не разбирает PHP, поэтому не может следовать руководству по стилю проекта, переносить длинные строки или исправлять пробелы вокруг операторов вроде = и +. Комментарии, heredoc и циклы for (;;) могут выйти неверно, потому что точка с запятой в них обрабатывается как любая другая. Для целой кодовой базы запускайте настроенный форматировщик в редакторе или в сборке, а эту страницу используйте для быстрых разовых правок.

Форматирование функции с циклом

Компактные исходные данные:

function total($items){$sum=0;foreach($items as $item){$sum+=$item["price"];}return $sum;}

Каждая скобка открывает новый уровень, поэтому тело цикла оказывается на два уровня глубже, а return возвращается на один уровень. Читая сверху вниз, теперь видно, что цикл добавляет значение к $sum, а функция возвращает его после этого. В однострочной версии это было трудно заметить.

Выбор 2 или 4 пробелов

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

Проверьте результат

Отформатированный код легче проверять, и в этом смысл. Прочитайте его один раз на предмет пропущенных или лишних фигурных скобок: инструмент их считает, но не сообщает о проблемах. Если отступ странно смещается к концу, обычная причина: непарная скобка во входных данных.