PhpStormでスニペット(ライブテンプレート)を設定する方法

PhpStormのスニペット機能は、ライブテンプレートと呼ばれています。

この記事では、PhpStormのライブテンプレートの設定方法について紹介します。

PhpStormでライブテンプレートの設定

「ファイル」→「設定」をクリック。

サイドメニューの「エディター」→「ライブテンプレート」→「+」→「ライブテンプレート」をクリック。

下の方にライブテンプレートの追加画面が表示されるので、入力。

略称:ライブテンプレートを挿入するときに使うキーを入力。

説明:新規登録するライブテンプレートの説明。後から読んでわかりやすいように書くと良い。

テンプレートテキスト:挿入したいコードを入力。改行も反映される。「$TIME$」というように、「$」記号で囲むと変数として扱える「TIME」の部分は自分がわかりやすい名前をつけて良い。変数は複数設定でき、ライブテンプレート挿入後、変数部分に入力しTabキーを押すと次の変数へ移動し入力できる。「$END$」はPhpStormによって予約されていて、最終的に入力カーソルが「$END$」のところに移動する。ライブテンプレート挿入後、入力カーソルの位置を指定したいだけなら、入力カーソルを置きたい位置に「$END$」と入力すればOK。

テンプレートテキストを入力したら、「定義」をクリック。

どの言語で使用するかチェックするポップアップが出るので、作成したライブテンプレートを使いたい言語にチェックを入れる。

テンプレートテキスト内で「$END$」以外の変数を使っている場合、右側の「変数の編集」がクリックできるようになっているのでクリック。

変数に式を選択でき、例えばcamelCase()を使うと、ライブテンプレート挿入後に変数「USER」部分にカーソルが入力し、値を入力するとその値が自動的にキャメルケースに変換されます。

他は、変数部分にクリップボードの中身を自動で入力してくれる「clipboard()」などもあります。

使える式はたくさんあり、下記のページにまとまっているので自分がやりたいことを探してください。

変数の編集が終わったら「OK」をクリックして閉じ、設定画面も「OK」をクリックして閉じてOK。

エディタに戻り、設定した言語のファイルを開いて「略称」で設定した文字を入力すると候補欄に出てきてTabキーを押すと入力できます。

登録したテンプレートの編集

登録したライブテンプレートは、「User」という場所に入っているので、そこから編集できます。

おわりに

ライブテンプレートの登録の仕方が分かりづらかったので記事にしました。