PhpStorm 8.0.2 Web Help

Live Template Variables

On this page:

What are template variables

Template variables in live templates enable user input. After a template is expanded, variables appear in the editor as input fields.

Declaring template variables

Variables within templates are declared in the following format:

$<variable_name>$

Creating and editing template variables

Variables are defined by expressions, and can accept some default values.

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.
.

Template variables are editable in the Edit Template Variables Dialog, which contains a complete list of available functions. See the list of predefined functions below on this page.

PhpStorm supports two predefined live template variables: $END$ and $SELECTION$.

You cannot edit the predefined live template variables $END$ and $SELECTION$.

  • $END$ indicates the position of the cursor after the template is expanded. For example, the template return $END$; will be expanded into
    return ;

    with the cursor positioned right before the semicolon.

  • $SELECTION$ is used in surround templates and stands for the code fragment to be wrapped. After the template is expanded, the selected text is wrapped as specified in the template.

    For example, if you select EXAMPLE in your code and invoke the "$SELECTION$" template via the assigned abbreviation or by pressing Ctrl+Alt+T and selecting the desired template from the list, PhpStorm will wrap the selection in double quotes as follows:

    "EXAMPLE"
    .

Predefined Functions to Use in Live Template Variables

Item Description
capitalize(<name>) Capitalizes the first letter of the name passed as a parameter.
capitalizeAndUnderscore(<String>) 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.
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() 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:

date_format
decapitalize(<name>) Replaces the first letter of the name passed as a parameter with the corresponding lowercase letter.
enum(...) List of comma-delimited strings suggested for completion at the template invocation.
escapeString() 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() Returns file name with extension.
fileNameWithoutExtension() Returns file name without extension.
firstWord(String) Returns the first word of the string passed as a parameter.
lineNumber() Returns the current line number.
snakeCase(String) Returns snake_case string out of CamelCase string.
time() Returns the current system time.
underscoresToCamelCase 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(VAR) 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.

See Also

Last modified: 10 December 2014