IDE phpStorm как инструмент разработки в MODX

Долгое время я пользовался простыми и быстрыми редакторами для разработки, типа Geany и Notepad++. Просто не понимал, зачем мне тяжеловесная IDE, если и этих редакторов хватает с головой?

Я помню свой код, что откуда выходит и как работает, зачем мне подсказки от программы, которая грузится полторы минуты? Тем более, я люблю по-быстрому забежать на сервер, подправить пару опечаток и сохранить файл. Мне не нужно создавать проект, синхронизировать его с сервером и т.д.

Однако, всё поменялось, когда я написал miniShop. Компонент вышел большой, и со временем я понял, что просто запутываюсь в нём. Заодно я понял, что допустил много грубых ошибок, по незнанию — например доставучие уведомления о необъявленных переменных или ключах массива, те самые — E_NOTICE.

Поэтому, когда я засел за Tickets, сразу решил писать его в IDE phpStorm, чтобы таки разобраться в ней и упростить себе разработку. Поначалу было непросто, но я быстро втянулся.

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

Почему phpStorm?

IDE я выбирал как обычно, просто наугад. Конечно, поглядел конкурентов, но в целом, все IDE показались мне на одно лицо. Однако, у phpStorm есть несколько неоспоримых преимуществ:
1. Возможность получить OpenSource лицензию на год, бесплатно.
2. Хоть весь интерфейс и на английском, но компания российская и работают там русские люди, в основном.
3. phpStorm советуют сами авторы MODX. Раньше даже давали лицензию своим партнёрам.

Об этом выборе я не только не пожалел, но даже купил 2 нормальных лицензии на последней распрадаже, вместо OpenSource — чтобы поддержать разработчиков.

Настройка сервера

Для начала расскажу, как у меня налажено производство компонентов.

Основной инструмент — домашний сервер с Ubuntu, настроенной по собственной заметке, с доступом через SSH и SFTP. Все проекты располагаются к корне сайта, каждый в своей директории. При этом, директории замонтированы внутрь сайта через --bind.

То есть, на сайте одни и теже файлы находятся в двух местах. MODX считает, что компоненты у него разложены в нужных директориях, а я могу синхронизировать эти директории с github и phpStorm.

На ноутбуке phpStorm, в котором лежат все нужные проекты, настроенный на синхронизацию с сервером. То есть, код одновременно лежит и на сервере и на ноуте. Это полезно, в случае непредвиденной атаки терористов на ваш хостинг.

Справа картинка, где стрелочками показано, что куда монтируется. Если захотите сделать также — вот команда:

sudo mount --bind /var/www/test/www/dateAgo/core/components/dateago/ /var/www/test/www/core/components/dateago/

Еще раз — файлы у меня в одном экземпляре, в директорию MODX они как бы зеркалируются.

Коммиты в репозиторий я присылаю из консоли сервера. Можно настроить это и на ноуте (и даже в IDE), но пока руки не дошли.

Настройка phpStorm

Итак, есть тестовый сайт с грамотно разложенными компонентами, которые нам нужно разрабатывать. Осталось настроить IDE для работы с ними.

• Новый проект из старых файлов.
  
• Имя и путь на локальном компе.
  
• Файлы лежат на сервере.
  
• Создаём новое подключение.
  
• Вводим данные для доступа.
  
• И выбираем корень проекта.
  

Если у вас несколько проектов на этом сервере — создавать подключение для каждого не нужно.

После создания проекта нужно зайти в Settings -> Deployment -> Options и установить Always в параметре загрузки обновлений на сервер. Теперь все изменения на локальном компе будут мгновенно синхронизироваться с удалённым, и вы сможете проверять результаты своей работы.



Настройки шрифтов редактора находятся в Editor -> Colors & Fonts -> Font. Можно скачать и установить разнообразные темы. Лично мне нравятся Twilight и Monokai с шрифтом Ubuntu Mono.

А теперь самое главное — нужно подключить файлы MODX, чтобы во время разработки IDE подсказывала нам, откуда что наследуется.
Для этого качаем свежую версию дистрибутива MODX, распаковываем на локальный компьютер и указываем:



Сюда можно подключать не только MODX, но и любые другие компоненты\библиотеки, которые будет использовать ваше расширение, например, pdoTools.

Теперь при наборе $modx-> IDE будет вам подсказывать методы класса MODX, с параметрами.

Как работать

Мы правильно настроили phpStorm и уже наслаждаемся подсказками, автодополнениями и прочими вкусняшками IDE.

Однако, чтобы автодополнение правильно работало, нужно указывать, где какие ипользуются классы. Делается это комментарием перед объявлением переменной.

/* @var modResource $resource */
if ($resource = $modx->getObject('modResource', 1)) {
	print_r($resource->toArray());
}

Пожалуйста, не ленитесь указывать объекты переменных, это сэкономит вам кучу времени, ведь IDE не только подскажет методы, но и проверит, что они должны возвращать и какие требуют параметры.

Если вы пишите что-то не то, IDE проверяет и подчеркивает ошибки красным. Если вы объявляете и не используете переменную — она будет более бледной, чем другие. Если пытаетесь использовать переменную, которая не видна в текущем цикле\условии — будет warning и подчеркивание желтым.

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

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

Также, если вам нужно перейти на объявление метода — кликните на него и нажмите Ctrl+B. Словами трудно объяснить, поэтому записал коротюсенькое видео.

Заключение

phpStorm — отличный инструмент, который экономит кучу времени и оберегает от множества ошибок. Совершенно не представляю, как я раньше без него работал?
Да, он требует определённой организации труда, но вы всё равно рано или поздно к ней придёте, если хотите делать интересные и полезные вещи для MODX Revolution.

А если нет — зачем вы это читаете?

Обновлено 24.06.13

Прислали ссылочку на канал phpStorm с обучающими видео. Всем рекомендую — www.youtube.com/playlist?list=PLQ176FUIyIUbfeFz-2EbDzwExRlD0Bc-w

<input [[+disabled]] value="">

sudo mount --bind /var/www/test/www/dateAgo/core/components/dateago/ /var/www/test/www/core/components/dateago/

ln -s /home/host1111111/domen.ru/dev/www/core /home/host1111111/domen.ru/www/core