- Зачем нужен PHP Formatter?
- Где взять "укрошатель" PHP кода?
- Как пользоваться PHP Beautifier от BeautifyTools
Зачем нужен PHP Formatter?
Как среди гурманов яиц идёт нескончаемый спор, с какого конца правильно вскрывать скорлупу, так и в среде программистов на языке программирования PHP есть два лагеря, которые предпочитают отбивать строки пробелами с одной стороны, и табуляцией с другой. На вкус яиц и на работу PHP-скриптов это не сильно влияет, однако, для стандартизации программисты придумали Codestyle. И когда для разработки какого-то большого приложения, команда кодеров сначала договаривается о том, в каком стиле делать оформление кода. Это сильно упрощает общение в команде, снимает кучу вопросов и экономит массу времени на споры, не касающиеся решаемой задачи.
А еще некоторые программеры для усложнения использования их кода, (и для ускорения его работы, хотя это на современных компьютерах имеет всё меньше и меньше значения), вытягивают весь код в одну строчку. Работать с таким кодом конечно невозможно.
Итак, чтобы переводить PHP-код всё переводить в удобочитаемый привычный вид, можно потратить массу сил. Поэтому были придуманы и разработаны алгоритмы, которые позволяют быстро обрабатывать и "причёсывать" код в тот стиль, к которому привык тот или иной программист.
Где взять "укрошатель" PHP кода?
Когда есть готовый алгоритм, реализовать его — это уже вопрос для самых ленивых. Для больших проектов конечно лучше использовать алгоритмы, которые будут автоматически обходить все папки и модифицировать файлы с расширением .php
. Но для бытовых нужд есть много on-line редакторов PHP-кода, которыми очень удобно пользоваться.
Мне понравился вот этот сервис: https://beautifytools.com/php-beautifier.php
Как пользоваться PHP Beautifier от BeautifyTools
Итак, у нас есть два окошка. В левое вводим наш PHP-код, который нужно отформатировать, а в правом получаем готовый красивый код. Но есть некоторые настройки, про которые нужно знать. Итак по порядку о кнопках, которые расположены над левым окошком.
Load Url (загрузка по адресу из интернета)
Странная кнопка, но, видимо она от других инструментов, которые предлагает BeautifyTools. Чужой PHP-код выполняется на удалённом сервере, поэтому его код невозможно просто взять и загрузить.
Browse (загрузить файл с локального компьютера)
Эта кнопка позволяет выбрать php-файл с локального компьютера и его содержимое подгрузить в левое текстовое окошко. Это видимо для самых ленивых, которым лень нажимать Ctrl+C
и Ctrl+V
. =)
Beautify PHP
Это самая полезная кнопка на этой странице! Она запускает процесс обработки и переформатирования кода в левом окошке, а результат выдаёт в виде чистого PHP-кода в нужном формате в правом окошке. Результат можно выделить Ctrl+A
, скопировать Ctrl+C
и потом вставить в свой редактор PHP-кода Ctrl+V
.
Для самых ленивых, кто хочет получить чистый PHP в один клик, в правом верхнем углу правого окна есть специальная кнопка, позволяющая скопировать готовый код в один клик мышкой! =)
Options (настройка форматирования PHP-кода)
Очень важная кнопка! Она открывает настройки форматирования PHP-кода.
Выпадающий список Indentation style (Стиль отступа) позволяет выбрать 4 (четыре) стиля:
K&R style (Стиль Кернигана и Ричи)
Назван в честь Kernighan & Ritchie, потому что примеры в K&R отформатированы таким образом.
Также называется "стилем ядра", поскольку ядро Unix написано в нем, и "единым истинным стилем оформления" (сокращенно 1TBS от "One True Brace Style") его приверженцами.
В коде на языке Си отступ от тела обычно составляет восемь пробелов (или одну табуляцию) на уровень, как показано ниже. Четыре пробела иногда встречаются в Си, но в C++ и Java четыре пробела скорее правило, чем исключение.
Пример форматирования PHP в стиле K&R style
if ([cond]) {
[body]
}
Allman style (Стиль Олмана)
Назван в честь Эрика Оллмана, хакера из Беркли, который написал на нем множество утилит BSD (иногда его называют стилем BSD).
Похож на нормальный стиль отступов в Паскале и Алголе. Это единственный стиль, кроме K&R, широко используемый программистами Java.
Базовый отступ на один уровень, показанный здесь, составляет восемь пробелов, но четыре (или иногда три) пробела обычно предпочитают программисты C++ и Java.
Пример форматирования PHP в стиле Allman style
if ([cond])
{
[body]
}
Whitesmiths style
Популярен благодаря примерам, которые поставлялись с Whitesmiths C, ранним коммерческим компилятором языка Си.
Базовый отступ на уровень, показанный здесь, составляет восемь пробелов, но иногда встречается и четыре пробела.
Пример форматирования PHP в Whitesmiths style
if ([cond])
{
[body]
}
GNU style (Стиль GNU)
Используется в GNU EMACS и в коде Фонда свободного программного обеспечения, и почти нигде больше.
Отступы всегда равны четырем пробелам на уровень, при этом { и } находятся на полпути между внешним и внутренним уровнями отступов.
Пример форматирования PHP в стиле GNU
if ([cond])
{
[body]
}
Ну и дальше идёт выпадающий список используемых стилей отступов (пробелы или табуляции). Под ним - сколько пробелов использовать для единичного отсупа в PHP-коде. А в самом низу опции:
- Indent the array structures
- Отступы структур массива
- Align the equals symbols in contiguous lines
- Выравнивание символов равенства в непрерывных строках
- Create fluent style for multi-level object access
- Создать плавный стиль для многоуровневого доступа к объектам
- Keep a single empty line where empty lines can be found
- Сохранять одну пустую строку там, где встречаются пустые строки
- Create a list of functions and classes in the script
- Создать список функций и классов в сценарии
- Lowercase all control structures
- Выделить все управляющие структуры нижним регистром
Таким образом можно быстро и автоматически привести свой PHP-код к нужному виду написания.
Заберите ссылку на статью к себе, чтобы потом легко её найти!
Раз уж досюда дочитали, то может может есть желание рассказать об этом месте своим друзьям, знакомым и просто мимо проходящим?
Не надо себя сдерживать! ;)