PhpStorm 2018.1 Help

Edit Template Variables Dialog

File | Settings | Live Templates - Edit Variables for Windows and Linux
PhpStorm | Preferences | Live Templates - Edit Variables for macOS
Ctrl+Alt+S
settings


The dialog opens when you click the Edit Variables button in the Template Text area on the Live Templates page.

Use this dialog box to create and edit expressions for variables in the selected live template.

On this page:

Controls

ItemDescription
NameIn this text box, view or edit the variable name in the format $<variable_name>$.
ExpressionIn this text box, specify the expression to have the value of the corresponding template input field calculated automatically.

This expression may contain constructs of the following basic types:

  • String constants in double quotes.
  • The name of another variable defined in a live template.
  • Predefined functions with possible arguments.

Type an expression manually or select a predefined function from the drop-down list. The list shows also the number and type of parameters, if any, for the selected function. The available functions are listed alphabetically in the Functions table.

Default valueIn this text box, specify the default string to be entered in the corresponding input field of the expanded template, if the expression does not give any result after calculation.

Note that a default value of a variable is an expression that can refer to other live template variables. To define the default value as a literal, enclose it in quotation marks.

Skip if definedSelect this checkbox to have PhpStorm proceed with the next input field, if the value of the current input field is defined.
Move Up / Move DownUse these buttons to change the order of variables in the list. The order of variables in the table determines the order in which PhpStorm will switch between the corresponding input fields when the template is expanded.

Predefined Functions to Use in Live Template Variables

ItemDescription
camelCase(String)Converts a string into cameCase. For example, camelCase(my-text-file), camelCase(my text file), and camelCase(my_text_file) all return myTextFile.
capitalizeAndUnderscore(sCamelCaseName)Capitalizes all the letters of a CamelCase name passed as parameter, and inserts an underscore between the parts. For example, capitalizeAndUnderscore(FooBar) returns FOO_BAR.
capitalize(String)Capitalizes the first letter of the parameter.
classNameComplete()This expression substitutes for the class name completion at the variable position.
clipboard()Returns the contents of the system clipboard.
complete() Invokes code completion at the position of the variable.
completeSmart() Invokes smart type completion at the position of the variable.
date(sDate) Shows the current system in the specified format.

By default, the current date is returned in the default system format. However, if you specify date format in double quotes, the date will be presented in this format:

date_format
decapitalize(sName)Replaces the first letter of a name parameter with the corresponding lowercase letter.
enum(sCompletionString1,sCompletionString2,...)Shows a list of comma-separated strings suggested for completion at the template invocation.
escapeString(sEscapeString)Escapes a string.
expectedType()Returns the expected type of the expression into which the current template expands. Makes sense if the template expands in the right part of an assignment, after return, etc.
fileName()Returns the name of a file with its extension.
fileNameWithoutExtension()Returns the name of a file without its.
firstWord(sFirstWord)Returns the first word of a string.
JsArrayVariable Returns the name of the current JavaScript array.
jsClassName()Returns the name of the current JavaScript class.
jsComponentTypeOf() Returns the type of the current JavaScript component.
jsDefineParameter()
jsMethodName()Returns the name of the current JavaScript method.
jsQualifiedClassName Returns the complete name of the current JavaScript class.
jsSuggestDefaultVariableKind(Boolean)
jsSuggestImportedEntityName()
jsSuggestIndexName Returns a suggested name for an index.
jsSuggestVariableName Returns the suggested name for a variable.
lineNumber()Returns the current line number.
lowercaseAndDash(String) Converts a capitalized camelCase string into lower case and inserts n-dashes as separators. For example, lowercaseAndDash(MyExampleName) returns my-example-name.
snakeCase(String) Converts a string into snake_case, for example, snakeCase(fooBar) returns foo_bar.
spaceSeparated(String) Converts a CamelCase string into lower case and inserts spaces as separators. For example, spaceSeparated(fooBar) returns foo bar.
substringBefore(String,Delimiter) Removes the extension after the specified delimiter and returns only the file name. This is helpful for test file names, for example, substringBefore($FileName$,".") will return component-test in component-test.js.
time(sSystemTime)Returns the current system time.
timestamp()This function without parameters returns the current time in milliseconds from the 1st January 1970. Refer to the article Unix time.
underscoresToCamelCase(sCamelCaseText)Replaces underscores with CamelHump letters. For example, underscoresToCamelCase(foo_bar) returns underscoresToCamelCase(fooBar).
underscoresToSpaces(sParameterWithSpaces)Replaces underscores with spaces.
user()Returns the name of the current user.
Last modified: 13 February 2018

See Also