Как подружить PhpStorm и Drupal

В этой статье будем рассматривать настройку среды разработки (в случае нашей компании — это PhpStorm) для работы с Drupal. Если точнее, то разберёмся, как в данной IDE активировать встроенную поддержку Drupal API, задать стиль кодирования Drupal и настроить автоматическую проверку кода PHP на основе PHP Code Sniffer. Все настройки будем выполнять на базе операционной системы Linux Ubuntu 16.04.

Отмечено, что помимо вышеуказанных полезностей, PhpStorm умеет ещё в интеграцию с Drush, подскажет много полезного по Symfony для Drupal 8 и может подружиться с проблемой- трекером на drupal.org.

Настройка поддержки Drupal API

Выполнить настройку несложно. В PhpStorm переходим Файл -> Настройки -> Языки и рамки -> PHP -> Drupal . Ставим галочку Включить интеграцию с Drupal , указываем путь, где установлен Drupal и выбираем версию. В случае пути разработки в пути установки указывается до самого самого проекта. В случае установки всех нужных файлов в проекте PhpStorm будут все нужные файлы, поэтому в настройках указывается путь к отдельным папкам со всеми удаленными загрузочными файлами Drupal.

того, как PhpStorm После выполнит переиндексацию, разработчик получит доступ к подсказкам по хукам, сможет быстро просмотреть выбранную хука и все варианты его реализации в проекте.

Настройка стиля кода Drupal

Здесь тоже всё просто, поскольку PhpStorm содержит предустановленный стиль кода для Drupal. Открываем Файл -> Настройки -> Редактор -> Стиль кода -> PHP . В правой части открывшихся настроек выбираем Set from … -> Predefined style -> Drupal и сохраняем изменения.

На этой настройке завершена и теперь IDE сама будет следить за расстановкой переносов, отступов, открывающих/закрывающих скобок и других немаловажных вещей, стандартной системы кодирования Drupal , а поврежден Код -> Переформатировать код , вы сможете автоматически отформатировать код в открытом файле согласно текущему стилю.

Настройка PHP Code Sniffer для автоматизированной проверки кода

Один из важных компонентов написания модуля или темы — соблюдение стандартов кодирования Drupal. Код, написанный по стандартам, легко понять, с ним легко работать и его приятно поддерживать. Ко всему прочему, стандарты кодирования гарантируют, что любой квалифицированный Drupal-разработчик сможет понять написанный вами код, а новичок не сможет допустить совсем глупую ошибку. Так как сами стандарты предоставляют собой большой объём данных, чтобы держать их все в голове и следить за их соблюдением проблематично даже для опытных друпалеров. Очевидно, возникает желание автоматизировать данный процесс в среде разработки и не отвлекаться от написания кода. Благо, для этого есть все необходимые инструменты.

Для установки PHP Code Sniffer понадобится Composer. Если он у вас уже имеется, то переходите на второй шаг.

1. Установка Composer

Обновляем кэш менеджера пакетов.

 
 $ sudo apt-get update 

Устанавливаем необходимые зависимости. Нам нужен curl для загрузки самого Composer и php-cli для его установки и запуска. Пакет php-mbstring требуется для некоторых функций Composer, git для зависимостей проектов, распаковать соответственно для распаковки zip-пакетов .

 
 $ sudo apt-get install curl php-cli php-mbstring git unzip 

Загружаем установщик Composer.

 
 $ curl -sS https://getcomposer.org/installer -o composer-setup.php 

Устанавливаем Composer глобально.

 
 $ php composer-setup.php --install-dir =/usr /local/bin --filename = composer 

Проверяем корректность установки.

 
 $  композитор 

2. Установка и настройка PHP Code Sniffer

Ставим пакет squizlabs/php_codesniffer глобально с помощью Composer. Во избежание ошибок, ставим версию версии «2. *» .

 
 $ composer global require "squizlabs/php_codesniffer = 2  . * "

В PhpStorm переходим File -> Settings -> Languages ​​& Frameworks -> PHP -> Code Sniffer и открываем настройки локальной конфигурации.

В поле path нужно указать системный путь до исполняемого файла phpcs . Узнать его расположение можно с помощью команд.

 
 $ composer config --global home $ composer config --global bin-dir 

В нашем случае исполняемый файл предоставляется по адресу ~/.composer/vendor/bin/phpcs . После ввода пути в поле path можно выполнить проверку работоспособности PHP Code Sniffer с помощью кнопки Validate .

Для включения проверки кода в PhpStorm идём Файл -> Настройки -> Также можно настроить максимальное количество отображаемых сообщений и время ожидания результата проверки кода. Редактор -> Инспекции . В списке проверок для языка PHP находим Проверка PHP Code Sniffer , включаем его, выбираем проверяемый стандартный кодирование и вид отображаемых сообщений.

3. PHP Code Sniffer + Drupal

В списке стандартов кодирования проверки вы не найдёте Drupal — они не найдены в стандартной установке PHP Code Sniffer, что логично. Нужные стандарты можно найти в модуле Coder. Собственно с версии 8.x это и не модуль уже.

Перво-наперво ставим Coder глобально с помощью Composer.

 
 $ composer global require drupal/coder 

После установки Coder будет доступен по адресу ~/.composer/vendor/drupal/coder . Далее делаем команду phpcs доступной глобально.

 
 $ export PATH = "$ PATH: $ HOME/.composer/vendor /bin "

Указываем PHP Code Sniffer, где искать стандарты кодирования Drupal.

 
  $ phpcs --config-set installed_paths ~/.composer/vendor/drupal/coder/coder_sniffer 

Выполнение данной команды должно вернуть Config value » installed_paths «успешно обновлены . Делаем проверенных стандартов кодирования.

 
 $ phpcs -i 

Если всё верно, в настройках PHP Code Sniffer в PhpStorm появились новые стандарты — Drupal и DrupalPractice. Как правило, на постоянной основе используют первый стандарт. Второй будет полезен для обнаружения распространенных ошибок. В любом случае выбрать можно только один стандарт.

Комментарии

Здравствуйте, у меня нет опции Друпал .. Файл -> Настройки -> Языки и платформы -> PHP -> Drupal

    Добавить комментарий

    Оцените статью
    techsly.ru
    Добавить комментарий