Edit Template Variables Dialog
for Windows and Linux
for OS X
Ctrl+Alt+S
The dialog opens when you click the Edit Variables button in the Template Text area on the Live Templates page.
The Edit Variables button is enabled only if the template body
contains at least one user-defined variable, that is, a variable different from
$END$ or $SELECTION$.
Use this dialog box to create and edit expressions for variables in the selected live template.
On this page:
Controls
| Item | Description |
|---|---|
| Name | In this text box, view or edit the variable name in the format $<variable_name>$. |
| Expression | In 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:
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 value | In 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 defined | Select this check box to have PhpStorm proceed with the next input field, if the value of the current input field is defined. |
| Move Up / Move Down | Use 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
| Item | Description |
|---|---|
camelCase(String) | Returns the string passed as a parameter, converted to camel case. For example,
my-text-file/my text file/my_text_file will be converted to
myTextFile. |
capitalize(String) | Capitalizes the first letter of the name passed as a parameter. |
capitalizeAndUnderscore(sCamelCaseName) | Capitalizes the all letters of a CamelCase name passed as a parameter, and inserts an underscore
between the parts. For example, if the string passed as a parameter is FooBar, then
the function returns FOO_BAR. |
classNameComplete() | This expression substitutes for the class name completion at the variable position. |
clipboard() | Returns the contents of the system clipboard. |
snakeCase(String) | Returns CamelCase string out of snake_case string. For example, if the string passed as a parameter is
foo_bar, then the function returns fooBar. |
complete() | This expression substitutes for the code completion invocation at the variable position. |
completeSmart() | This expression substitutes for the smart type completion invocation at the variable position. |
date(sDate) |
Returns the current system date 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:  |
decapitalize(sName) | Replaces the first letter of the name passed as a parameter with the corresponding lowercase letter. |
enum(sCompletionString1,sCompletionString2,...) | List of comma-delimited strings suggested for completion at the template invocation. |
escapeString(sEscapeString) | Escapes the specified string. |
expectedType() | Returns the type which is expected as a result of the whole template. Makes sense if the template is expanded in the right part of an assignment, after return, etc. |
fileName(sFileName) | Returns file name with extension. |
fileNameWithoutExtension() | Returns file name without extension. |
firstWord(sFirstWord) | Returns the first word of the string passed as a parameter. |
lineNumber() | Returns the current line number. |
lowercaseAndDash(String) | Returns lower case separated by dashes, of the string passed as a parameter. For example, the string
MyExampleName is converted to my-example-name.
|
snakeCase(sCamelCaseText) | Returns snake_case string out of CamelCase string passed as a parameter. |
spaceSeparated(String) | Returns string separated with spaces out of CamelCase string passed as a parameter. For example, if the
string passed as a parameter is fooBar, then the function returns
foo bar. |
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) | Returns the string passed as a parameter with CamelHump letters substituting for underscores.
For example, if the string passed as a parameter is foo_bar, then the function returns
fooBar. |
underscoresToSpaces(sParameterWithSpaces) | Returns the string passed as a parameter with spaces substituting for underscores. |
user() | Returns the name of the current user. |
JsArrayVariable | Returns JavaScript array name. |
jsClassName() | Returns the name of the current JavaScript class. |
jsComponentType | Returns the JavaScript component type. |
jsMethodName() | Returns the name of the current JavaScript method. |
jsQualifiedClassName | Returns the complete name of the current JavaScript class. |
jsSuggestIndexName | Returns a suggested name for an index. |
jsSuggestVariableName | Returns a suggested name for a variable. |