PhpStorm 2020.2ヘルプ

テンプレート変数の編集ダイアログ

WindowsおよびLinux用のファイル | 設定 | エディター | ライブ・テンプレート - 変数の編集

macOS Ctrl+Alt+S the Settings/Preferences iconPhpStorm | 環境設定 | エディター | ライブ・テンプレート - 変数の編集

ライブテンプレートユーザー定義変数が含まれている場合は、テンプレート変数の編集ダイアログを使用して、これらの変数を定義する式を構成できます。

コントロール

項目

説明

名前このフィールドで、$<variable_name>$の形式で変数名を表示または編集します。
このフィールドでは、対応するテンプレート入力フィールドの値が自動的に計算されるように式を指定します。

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

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

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

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

式を手動で入力するか、リストから定義済みの関数を選択してください。リストには、選択した機能のパラメータの数と種類(ある場合)も表示されます。使用可能な機能は、関数表にアルファベット順にリストされています。

デフォルト値計算後に式で結果が得られない場合は、このフィールドに、展開されたテンプレートの対応する入力フィールドに入力するデフォルトの文字列を指定します。

変数のデフォルト値は、他のライブテンプレート変数を参照できる式であることに注意してください。デフォルト値をリテラルとして定義するには、引用符で囲みます。

定義済みはスキップ現在の入力フィールドの値が定義されている場合、PhpStormに次の入力フィールドを進めるには、このチェックボックスを選択します。
上へ移動/下へ移動これらのボタンを使用して、リスト内の変数の順序を変更します。テーブル内の変数の順序は、テンプレートが展開されたときにPhpStormが対応する入力フィールドを切り替える順序を決定します。

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

関数説明
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()現在のユーザーの名前を返します。
最終更新日: 2020年5月08日