Использование Live Templates в PhpStorm

👁 290 просмотров
1 Звезда2 Звезды3 Звезды4 Звезды5 Звезд (Пока оценок нет)
Загрузка...

Часто бывает так, что вам приходится писать много однотипных операций — объявление классов, функций, массивов или какого то цикла операций. Чтобы не тратить на ввод каждый раз однотипных операций в PhpStorm создали такую фишку, которая носит название Live Templates, иначе говоря «живые шаблоны». Live Templates — это кусочки пользовательского кода , которые часто используются разработчиками. Вы можете добавить, редактировать  и удалять шаблоны,  сгруппирурая их в тот или иной язык.

Использование

Начну я с примеров использования LT. Чтобы посмотреть какие шаблоны нам доступны по умолчанию в PhpStorm откроем File -> Settings -> Live Templates и перед вами откроется окно как на рисунке:

php-live-tmlpl-1

Здесь представлены различные, стандартные, шаблоны кода, откройте вкладку php и наметим какой-нибудь шаблон, допусти шаблон создания закрытого метода под аббривиатурой prif, что означает Private Function. Закрываем окно настройки и переходим в редактор, открываем любой файл php расширения и нажимаем сочетание клавищ Ctrl + J и откроется список всех доступных шаблонов, которые будут отсортировываться в зависимости от того, что мы будем печатать, а печатать мы будем prif:

php-live-tmlpl-2

После жмете ENTER и данный шаблон вставиться в печатаемое место, вам остается всего лишь дописать название метода, ввести параметры и написать необходимый код и так со всеми остальными шаблонами-все очень просто:

php-live-tmlpl-3

Добавление новых шаблонов

Чтобы добавить новый шаблон, как и впредыдущий раз заходим в Settings  -> Live Templates или сразу жмите Alt +F7 и выбираем язык из списка существующих языков, допустим PHP и жмем зеленый плюсик в правом верхнем углу и вам предлагаю создать 1.Live Template(шаблон) или 2.Template Group(группу шаблонов), выберем шаблон:

php-live-tmlpl-4

Здесь вам предлагается ввести аббревиатуру для нового шаблона, по которому будет доступен данный шаблон, его следует подбирать в укороченной форме, чтобы не печатать длинный текст при подборе, вводите описание, чтобы не забыть что данный шаблон делает. Давайте создадим шаблон, который 5 раз выводит «Hello World» для этого пропишите все пункты, как указано на картинке и код:


for($i; $i<4; $i++)
{
echo "Hello".$i."\n";
$END$
}

не обращайте внимание на $END$, его мы обсудим попозже:

php-live-tmlpl-5

Все, создали и он будет теперь доступен как и все шаблоны.

Создание псевдопеременных в Live Templates

Псевдопеременные — это пользовательские переменные внутри шаблона, которые автоматически можно указать при вставке шаблона одним вводомт и вам не потребуется в каждом участке кода, где одна и та же переменная вновь и вновь написать одну и ту же переменную. Данные переменные начинаются и заканчиваются на знак $, к примеру, мы сейчас создадим переменную $i$ для нашего шаблона, для этого, вместо $i, напишем $i$ вот так:


for($i$; $i$<4; $i$++)
{
echo "Hello".$i$."\n";
$END$
}

php-live-tmlpl-6

 

Теперь нажимаем в редакторе, как в прошлый раз, Ctrl + J и печатаем say5hello и жмите ENTER, начинайте вводить переменную и вы увидите, как это название вставляется сразу в нескольких местах:

php-live-tmlpl-7

Открываем официальную страницу PhpStorm и видим такую надпись:

PhpStorm supports two predefined live template variables: $END$ and $SELECTION$.

Т.е. это уже предопределенные переменные, которые пользователь не может изменить. Переменная $END$  указывает положение курсора после того, как шаблон вставлен, а $SELECTION$  используется для фрагмента кода, который должен быть упакован. О всех особенностях Live Templates можете прочесть по этой же ссылке.