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

ファイルとコードテンプレートの設定がワークスペース全体に関連するのか、現在のプロジェクトに関連するのかを選択します。

• ファイルとコードのテンプレートがグローバルの場合、デフォルトのスキームが選択されます。

• 共有可能なプロジェクト固有のファイルとコードテンプレートを使用する場合は、プロジェクトスキームが選択されます。

このタブには、利用可能なファイルテンプレートが表示されます。

既存のテンプレートを編集したり、新しいテンプレートを作成したりすることができます。

このタブには、ファイルテンプレートに含めることができる再利用可能なフラグメントのテンプレートが表示されます。

既存のテンプレートを編集したり、新しいテンプレートを作成したりすることができます。

PhpStorm は、PHP クラス、フィールド、関数（メソッド）用の PHP ファイルヘッダーと PHPDoc コメントを生成するための事前定義された組み込みテンプレートセットを提供します。

このタブには、組み込みのスニペット（実装されたメソッド本体やオーバーライドされたメソッド本体の生成など、さまざまな典型的な状況で PhpStorm が生成できるコードフラグメントのテンプレートが表示されます）

既存のスニペットは編集できますが、新しいスニペットを作成することはできません。

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

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

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

• プレーンテキスト。

• 作業に #parse ディレクティブとテンプレートが含まれます。

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

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

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

  次の定義済み変数は、ファイルテンプレートで使用できます。

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

  PhpStorm は、PHP インクルードテンプレートの追加変数のセットを提供します。これらの変数は、ファイルヘッダーや 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 としてレンダリングされます。

このチェックボックスをオンにすると、PhpStorm はコードスタイルページで定義されたスタイルに従ってスタブファイルを再フォーマットします。

このオプションは、ファイルタブでのみ使用できます。

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

例:

カーソル位置を指定できます。ここではライブテンプレート変数を使用する必要があることに注意してください。

この読み取り専用フィールドには、テンプレート、事前定義された変数、それらが動作する方法に関する情報が表示されます。

このフィールドは、カスタムテンプレートでは使用できません。