ファイルテンプレート変数
ファイルテンプレートには変数を含めることができ、テンプレートが適用されるときにそれらは値に置き換えられます。 変数は、ドル記号 $ で始まり、その後に変数名が続く文字列です。 変数名は、省略可能で波括弧で囲むことができます。 例えば、 $MyVariable と ${MyVariable} は同じ変数の異なる表記法です。
事前定義された変数とカスタム変数は、テンプレート本体とファイル名で使用できます。 例: テンプレートの ファイル名 フィールドに MyFile_${MONTH_NAME_FULL} と入力した場合、4 月に作成すると、結果のファイルの名前は MyFile_四月 になります。 ここで、 ${MONTH_NAME_FULL} は 事前定義された変数です。 代わりに カスタム変数を使用すると、このテンプレートを基にファイルを作成するときに PhpStorm が変数の値の入力を求めます。
定義済みのテンプレート変数
次の事前定義済み変数をファイルテンプレートで使用できます:
変数 | 説明 |
|---|---|
| 現在のシステム日付 |
| 現在の月の日 |
| ドル記号 |
| 新しい PHP ファイルの名前 |
| 現在の時間 |
| 現在の分 |
| 現在の秒 |
| 現在の月 |
| 現在の月のフルネーム(January、February など) |
| 現在の月名の最初の三文字(Jan、Feb など) |
| 新しいエンティティの名前 (ファイル、クラス、インターフェースなど) |
| クラスまたはフィールドの名前空間の完全修飾名(先頭にスラッシュなし) |
| IDE の命名(たとえば、PhpStorm) |
| 現在のプロジェクトの命名 |
| 現在のシステム時刻 |
| 現在のユーザーのログイン名 |
| 現在の年 |
PhpStorm は、 PHP インクルードテンプレートのために、ファイルヘッダーや 再利用可能なコード、 PHPDoc コメントなどを定義するための追加変数セットを提供します。
次の追加の事前定義変数は、 PHP インクルードテンプレートで使用できます。
変数 | 説明 |
|---|---|
| 変数の編集が終了したら、キャレットの位置を指定します。 ファイル作成中に PHPDoc コメントが生成されて挿入された場合にのみ適用されます。 PHPDoc コメントが を介して作成された場合、関数やメソッドの複数選択が可能です。 この場合のドキュメントコメントは、いくつかのクラス、関数、メソッド、フィールドに対して作成することができるため、 |
| PHPDoc コメントを生成するフィールドまたはメソッドが定義されているクラスの名前 |
| PHPDoc コメントが生成されるクラス、フィールド、関数(メソッド)の名前 |
| クラスまたはフィールドの名前空間の完全修飾名(先頭にスラッシュなし) |
| パラメーターのドキュメントコメント。 一連の |
| PHPDoc コメントを生成する関数 (メソッド) またはフィールドが静的な場合は、 |
| 例外のドキュメントコメント。 一連の |
| PHPDoc コメントを生成する関数(メソッド)の戻り値。 関数(メソッド)の静的解析によって戻り値の型を検出できない場合は、 |
変数メソッド
PhpStorm はファイルテンプレート用のテンプレートエンジンとして Velocityを使用しているため、ファイルテンプレート内の変数で Java 文字列メソッドが利用できます。 例: 次のことが可能です。
${NAME.toUpperCase()}: 新しいエンティティ (ファイル) の名前を大文字に変換します。${PROJECT_NAME.length()}: プロジェクト名の長さを出力します。${PRODUCT_NAME.substring(0,5)}: 使用している IDE の名前の最初の 5 文字を出力します。
カスタムテンプレート変数
事前定義されたテンプレート変数に加えて、カスタム変数を指定することができます。 必要に応じて、 #set ディレクティブを使用して、テンプレート内でカスタム変数の値を定義できます。 対応する変数が使用される前にディレクティブを記述します。
例: 事前定義された変数 ${USER} で定義されたログイン名の代わりにフルネームを使用する場合は、カスタム変数の前に次の構成を追加します。
テンプレート内で変数の値が定義されていない場合、PhpStorm はテンプレートが適用されたときにその入力を求めます。