PhpStorm 2020.1ヘルプ

ライブテンプレート変数

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

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

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

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

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

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

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

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

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

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

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

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

    • 変数名を変更する

    • Define the expression using predefined functions

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

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

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

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

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

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

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

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

関数説明
camelCase(<String>)

Converts a string into camelCase

例: 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()Invokes code completion at the position of the variable.
completeSmart()Invokes smart type completion at the position of the variable.
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()Returns the suggested name for a variable based on its variable type and initializer expression, according to your code style settings that refer to the variable naming rules.
For example, if it is a variable that holds an element within an iteration, PhpStorm makes a guess on the most reasonable name, taking into account the name of the container that is iterated.
lineCommentStart()現在の言語コンテキストでの行コメントの開始を示す文字を返します。
lineNumber()現在の行番号を返します。
lowercaseAndDash(<String>)文字列を小文字に変換し、セパレータとしてnダッシュを挿入します。例: lowercaseAndDash("MyExampleName")lowercaseAndDash("my example name") はどちらも my-example-nameを返します。
phpClassName()現在のPHPクラスの短い名前を返します。
phpQualifiedClassName()現在のPHPクラスの完全修飾名を返します。
phpSuggestVariableName()

Returns the suggested name for a variable based on its variable type and initializer expression, according to your code style settings that refer to the variable naming rules.
For example, if it is a variable that holds an element within an iteration, PhpStorm makes a guess on the most reasonable name, taking into account the name of the container that is iterated.

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

regularExpression(<String>, <Pattern>, <Replacement>) String 内のすべての Pattern を検索し、Replacementに置き換えます。パターンを正規表現として指定して、文字列内で一致するすべてのものを検索できます。
snakeCase(<String>)Converts a string into snake_case. For example, snakeCase("fooBar") and snakeCase("foo bar") both return 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>)Returns the substring up to the specified delimiter. This is helpful for removing the extensions in test file names. For example, substringBefore(fileName(),".") returns component-test if used in a file named component-test.js.
time([format])

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

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

timestamp()1970年1月1日から計算された現在の時刻をミリ秒単位で返します。記事Unix時間(英語)を参照してください。
underscoresToCamelCase(<String>)Transforms a string with underscores (like snake_case) into camelCase. For example, underscoresToCamelCase(foo_bar_baz) and underscoresToCamelCase(FOO_BaR_baZ) both return fooBarBaz .
underscoresToSpaces(<String>)文字列のアンダースコアをスペースに変換します。例: underscoresToSpaces(foo_bar_baz)foo bar baz を返し、underscoresToSpaces(FOO_BaR_baZ)FOO BaR baZを返します。
user()現在のユーザーの名前を返します。
最終更新日: 2020年6月19日