Live templates или живые шаблоны в PhpStorm

Live templates (живые шаблоны) в PhpStorm – это фрагменты кода, вставляемые в редакторе по сокращению. Данный функционал используется для вставки часто используемых фрагментов кода. Эти фрагденты вставляются при нажатии Tab после ввода сокращения.

По умолчанию в PhpStorm уже есть набор шаблонов. Например, введите fore и нажмите Tab, в редактор вставится примерно такой PHP код:

foreach ( as $) {
   
}

fore – это сокращение для куска кода, который содержит цикл foreach.

Живые шаблоны разделяются по расширению файла, т.е. для PHP одни шаблоны, для JavaScript другие.

Вы можете изменить или добавить шаблоны в Settings -> Editor -> Live Templates.

Для создания живого шаблона:

  • зайдите в Settings -> Editor -> Live Templates
  • выбирете для чего вы будете создавать шаблон (PHP, HTML, JavaScript…)
  • нажмите кнопку + справа (или комбинацию клавиш Alt+Insert)
  • выбирите из выпадающего списка “Live Templates”
  • в появившейся снизу форме введите сокращение (Abbreviation)
  • введите описание (Description). Оно будет отображаться в подсказке
  • напишите сам код шаблона (Template text). Он и будет вставляться после нажатия Tab. Тут можно использовать переменные, например, $END$ – это место, куда будет установлена корретка после вставки.
  • Тут вы можете установить свои переменные. Для этого:
  •    - напишите имя переменной, заключённое в знаки $
  •    - нажмите справа на “редактировать переменные” (edit variables)
  •    - укажите выражение для переменной, например, это может быть date(), которая вставит текущую дату
  •    - укажите значение по умолчанию, если нужно
  •    - можно изменить клавишу вставки данного шаблона
  • при установки галочки перед “Reformat according to style”, при вставки шаблон будет переформатироваться. Например, это означает, что если у вас несколько команд в шаблоне записаны в одну строку, то после вставки они будут перенесине каждый на новую строку.
  • Всё, шаблон готов, проверьте как он вставляется

Также вы можете изменить клавишу вставки шаблона для всех вставок на свою. Для этого в окне Live Templates в поле “by default expand with” выбирите нужную клавишу.

Также можно создать свою группу шаблонов. Для этого, при добавлении шаблона в окне Live Templates, выберите (Template group).