PhpStorm 2020.2 ヘルプ

ライブテンプレート変数

ライブテンプレートの略語を展開すると、その変数は値を入力できる入力フィールドとして表示されるか、値に置き換えられます。これらは、変更可能なデフォルト値または関数を使用して計算された値です。

テンプレート内で変数を宣言するには、次の形式を使用します: $VAR$

式を使用して各変数を定義し、式が評価に失敗した場合のデフォルト値を提供します。

この式には、次の構成が含まれる場合があります。

  • 二重引用符で囲まれた文字列定数

  • ライブテンプレートで定義されている他の変数の名前

  • 可能な引数を持つ事前定義された関数

テンプレート変数を設定する

  1. 設定 / 環境設定ダイアログ Ctrl+Alt+S で、エディター | ライブテンプレートに移動します。

  2. 変数を設定するテンプレートを選択します。

  3. テンプレートテキストで変数を指定し、変数の編集をクリックします。

  4. テンプレート変数の編集ダイアログでは、各変数に対して以下の操作を実行できます。

    • 変数名を変更する

    • 事前定義された関数を使用して式を定義します

    • 式の評価に失敗した場合のデフォルト値を指定する

    • 式が正常に評価された場合にユーザーに入力を求めるときに変数をスキップするかどうかを指定する

定義済みのテンプレート変数

PhpStorm は、変更できない以下の定義済みライブテンプレート変数をサポートしています。

  • $END$ は、コードスニペットが完了したときのカーソルの位置を示し、Tab を押して次の変数にジャンプすることはできなくなりました。

  • $SELECTION$ はサラウンドテンプレートで使用され、ラップされるコードフラグメントを示します。テンプレートが展開されると、テンプレートで指定されたとおりに選択されたテキストがラップされます。例:コードで EXAMPLE を選択し、割り当てられた略語で "$SELECTION$" テンプレートを呼び出すか、Ctrl+Alt+T を押してリストから目的のテンプレートを選択すると、PhpStorm は選択を二重引用符で次のようにラップします: " EXAMPLE "

ライブテンプレート変数で使用される関数

ライブテンプレート変数を定義するには、次の関数を使用できます。

機能 説明
camelCase(<String>)

文字列をキャメルケースに変換します。

例: camelCase(" my-text-file ") , camelCase("my text file") および camelCase(" my_text_file ") はすべて myTextFile を返します。

capitalize(<String>)

文字列の最初の文字を大文字にします。

例: capitalize(" name ")Name を返します。または、capitalize(camelCase(" my awesome class ")) と組み合わせて MyAwesomeClass を取得することもできます。

capitalizeAndUnderscore(<String>)

文字列のすべての文字を大文字にし、パーツ間にアンダースコアを挿入します。

例: capitalizeAndUnderscore(" FooBar ") , capitalizeAndUnderscore("foo bar") および capitalizeAndUnderscore(" foo-bar ") はすべて FOO_BAR を返します。

clipboard() システムクリップボードの内容を返します。
commentEnd() 現在の言語コンテキストでコメントの終わりを示す文字を返します。行コメントのある言語の場合、戻り値は空です。
commentStart() 現在の言語コンテキストでコメントの開始を示す文字を返します。行コメントのある言語の場合、戻り値は lineCommentStart() と同じように行コメントの始まりです。
complete() 変数の位置でコード補完を呼び出します。
completeSmart() 変数の位置でスマート型補完を呼び出します。
concat(<String>, ...)

パラメーターとして関数に渡されたすべての文字列の連結を返します。

例: concat(date()," ",user()) は、スペースで区切られた現在のシステム日付とユーザー名を返します。

date([format])

現在のシステム日付を返します。

デフォルトでは、パラメーターなしで、現在のシステム形式で日付を返します。別の形式を使用するには、SimpleDateFormat 仕様に従ってパラメーターを指定します。例: date( "Y-MM-d, E, H:m") は、2020-02-27, Thu, 16:11 としてフォーマットされた日付を返します。

decapitalize(<String>)

文字列の最初の文字を対応する小文字に置き換えます。

例: decapitalize(" Name ")name を返します。

enum(<String>, ...)

テンプレートが展開されたときに補完が提案される文字列のリストを返します。

例: enum(" Foo ","Bar","Baz") は、指定された文字列の 1 つを選択できるリストを表示します。

escapeString(<String>)

結果を Java 文字列で使用できるように、特殊文字をエスケープします。

例:タブ文字を \t で置き換え、改行文字を \n で置き換え、バックスラッシュを \\ としてエスケープし、引用符を \" としてエスケープします。

fileName() 現在のファイルの名前とその拡張子を返します。
fileNameWithoutExtension() 現在のファイルの名前を拡張子なしで返します。
filePath() 現在のファイルへの絶対パスを返します。
fileRelativePath() 現在のプロジェクトに相対的な現在のファイルパスを返します。特定のファイルの相対パスを確認するには、ファイルを右クリックして参照のコピーを選択するか、Ctrl+Alt+Shift+C を押します。
firstWord(<String>)

パラメーターとして渡された文字列の最初の単語を返します。

例: firstWord( "one two three")one を返します。

JsArrayVariable() 現在の JavaScript 配列の名前を返します。
jsClassName() 現在の JavaScript クラスの名前を返します。
jsComponentTypeOf() 現在の JavaScript コンポーネントの型を返します。
jsDefineParameter モジュールの名前に基づいて、define([" module "], function (<parameter_in_question>>) {}) からパラメーターを返します。
jsMethodName() 現在の JavaScript メソッドの名前を返します。
jsQualifiedClassName() 現在の JavaScript クラスの完全な名前を返します。
jsSuggestDefaultVariableKind(Boolean)Boolean パラメーターは、現在のコンテキストで定数が許可されるかどうかを決定します。パラメーターが指定されていない場合は、定数が許可されます。テンプレートが展開されると、TypeScript および ES6 の場合は var , let , const オプション、それ以前のバージョンの JavaScript の場合は var オプションが 1 つだけのリストが表示されます。
jsSuggestImportedEntityName() ファイル名に基づいて、タイプ `import * as $ITEM$ from" $MODULE$ "` または `import $ITEM$ from" $MODULE$ "` のインポートステートメントの名前を提案します。
jsSuggestIndexName() 最も一般的に使用されているもの( i , j , k 以降)から、インデックス変数の推奨名を返します。現在のスコープでまだ使用されていない名前が最初に表示されます。
jsSuggestVariableName() 変数の命名規則を参照するコードスタイル設定に従って、変数の型と初期化子式に基づいて変数の推奨名を返します。
例:反復内の要素を保持する変数の場合、PhpStorm は、反復されるコンテナーの名前を考慮して、最も妥当な名前を推測します。
lineCommentStart() 現在の言語コンテキストでの行コメントの開始を示す文字を返します。
lineNumber() 現在の行番号を返します。
lowercaseAndDash(<String>) 文字列を小文字に変換し、セパレータとして n ダッシュを挿入します。例: lowercaseAndDash(" MyExampleName ")lowercaseAndDash(" my example name ") はどちらも my-example-name を返します。
phpClassName() 現在の PHP クラスの短い名前を返します。
phpQualifiedClassName() 現在の PHP クラスの完全修飾名を返します。
phpSuggestVariableName()

変数の命名規則を参照するコードスタイル設定に従って、変数の型と初期化子式に基づいて変数の推奨名を返します。
例:反復内の要素を保持する変数の場合、PhpStorm は、反復されるコンテナーの名前を考慮して、最も妥当な名前を推測します。

この機能を使用する場合は、デフォルト値の対応する変数のデフォルト値を指定する必要があります。

regularExpression(<String>, <Pattern>, <Replacement>) String 内のすべての Pattern を検索し、Replacement に置き換えます。パターンを正規表現として指定して、文字列内で一致するすべてのものを検索できます。
snakeCase(<String>) 文字列を snake_case に変換します。例: snakeCase(" fooBar ")snakeCase(" foo bar ") はどちらも foo_bar を返します。
spaceSeparated(<String>) 区切り文字としてスペースを含む指定された文字列を返します。例: spaceSeparated(" fooBar ")foo Bar を返し、spaceSeparated(" Foo_BAR ")Foo BAR を返します。
spacesToUnderscores(<String>) パラメーターとして渡された文字列内のスペースをアンダースコアに置き換えます。例: spacesToUnderscores(" foo bar BAZ ")foo_bar_BAZ を返します。
substringBefore(<String>, <Delimeter>) 指定された区切り文字までの部分文字列を返します。これは、テストファイル名の拡張子を削除できます。例:component-test.js という名前のファイルで使用すると、substringBefore(fileName()," . ")component-test を返します。
time([format])

現在のシステム時刻を返します。

デフォルトでは、パラメーターなしで、現在のシステム形式で時刻を返します。別の形式を使用するには、SimpleDateFormat 仕様に従ってパラメーターを指定します。例: time(" H:m z") は、13:10 UTC としてフォーマットされた時刻を返します。

timestamp()1970 年 1 月 1 日から計算された現在の時刻をミリ秒単位で返します。記事 Unix 時間(英語)を参照してください。
underscoresToCamelCase(<String>) 下線付きの文字列( snake_case など)を camelCase に変換します。例: underscoresToCamelCase(foo_bar_baz)underscoresToCamelCase(FOO_BaR_baZ) はどちらも fooBarBaz を返します。
underscoresToSpaces(<String>) 文字列のアンダースコアをスペースに変換します。例: underscoresToSpaces(foo_bar_baz)foo bar baz を返し、underscoresToSpaces(FOO_BaR_baZ)FOO BaR baZ を返します。
user() 現在のユーザーの名前を返します。
最終更新日 :