ファイルおよびコード・テンプレート

このボタンをクリックすると、現在開いているタブに新しいテンプレートが作成されます。このオプションは、ファイルおよびインクルードタブでのみ使用できます。

新しいテンプレートの場所はスキーマリストによって定義されます。

テンプレートの内容を編集します。使用することができます：

• プレーン・テキスト。

• #parse directives to work with template includes.

• カスタム変数。変数の名前は、#set 指示文を使用してテンプレート内で直接定義することも、ファイルを作成する際に定義することもできます。

  PhpStormは、#setで定義されたVelocity変数の値を要求しません。

• ${<variable_name>} 形式の対応する値に展開される変数。

  The following predefined variables can be used in file templates:

  変数	説明
  ${DATE}	現在のシステム日付
  ${DAY}	今月の現在の日
  ${DS}	ドル記号 $。この変数はドル記号をエスケープするために使用されるため、テンプレート変数の接頭辞としては扱われません。
  ${FILE_NAME}	新しいPHPファイルの名前
  ${HOUR}	現在の時間
  ${MINUTE}	現在の分
  ${MONTH}	現在の月
  ${MONTH_NAME_FULL}	現在の月のフル・ネーム (1月、2月など)
  ${MONTH_NAME_SHORT}	現在の月名の最初の3文字 (1月、2月など)
  ${NAME}	新しいエンティティの名前 (ファイル、クラス、インターフェースなど)
  ${ORGANIZATION_NAME}	プロジェクト設定で指定された組織の名前 ( Ctrl+Alt+Shift+S )
  ${NAMESPACE}	クラスまたはフィールドの名前空間の完全修飾名（先頭にスラッシュなし）
  ${PRODUCT_NAME}	IDEの名前 (たとえば、PhpStorm)
  ${PROJECT_NAME}	現在のプロジェクトの名前
  ${TIME}	現在のシステム時刻
  ${USER}	現在のユーザーのログイン名
  ${YEAR}	現在の年

  PhpStorm provides a set of additional variables for PHPインクルードテンプレート , which are used to define reusable pieces of code, such as file headers and PHPDoc コメント ).

  PHPインクルードテンプレートでは、以下の追加定義済み変数を使用できます。

  変数	説明
  ${CARET}	変数の編集が終了したら、キャレットの位置を指定します。ファイル作成中にPHPDocコメントが生成されて挿入された場合にのみ適用されます。PHPDocコメントがコード | 生成 | PHPDocブロックを介して作成された場合、関数やメソッドの複数選択が可能です。この場合のドキュメントコメントは、いくつかのクラス、関数、メソッド、またはフィールドに対して作成することができるため、${CARET} 変数は無視されます。
  ${CLASS_NAME}	PHPDocコメントを生成するフィールドまたはメソッドが定義されているクラスの名前
  ${NAME}	PHPDocコメントが生成されるクラス、フィールド、または関数（メソッド）の名前
  ${NAMESPACE}	クラスまたはフィールドの名前空間の完全修飾名（先頭にスラッシュなし）
  ${PARAM_DOC}	パラメータのドキュメントコメント。一連の @param type name 行を評価します。コメントを生成する関数にパラメータが含まれていない場合は、空の文字列に評価されます。
  ${STATIC}	PHPDocコメントを生成する関数（メソッド）またはフィールドが静的である場合は、static キーワードに置き換えられます。それ以外の場合は、空の文字列に評価されます。
  ${THROWS_DOC}	例外のドキュメントコメント。一連の @throws type 行を評価します。コメントを生成する関数が例外をスローしない場合は、空の文字列に評価されます。
  ${TYPE_HINT}	PHPDocコメントを生成する関数（メソッド）の戻り値。関数（メソッド）の静的解析によって戻り値の型を検出できない場合は、voidと評価されます。

  ドル記号の処理

  • テンプレート変数のドル記号 $ を接頭辞として扱うことを防ぐことができます。ドル記号（$ をそのまま挿入する必要がある場合は、代わりに ${DS} ファイルテンプレート変数を使用します。テンプレートが適用されると、この変数は単純なドル記号 $に評価されます。

    例:

    • デフォルトクラステンプレートで一部のバージョン管理キーワード（ $Revision$ , $Date$など）を使用するには、ドル記号 $の代わりに ${DS} を記述します。

    • テンプレートコード ${DS}this は $thisとしてレンダリングされます。

ファイルテンプレート内でライブテンプレートを使用するには、このチェックボックスをオンにします。そうすることで、ライブテンプレートフラグメントをVelocityエスケープ構文に入れる必要があります。

例:

Thus, one can specify the cursor position. Note that it is required to use the live template variables here!