PhpStorm 8.0.2 Web Help

Live Templates

File | Settings | Editor | Live Templates


Use this page to create, manage, and edit live templates.

On this page:

List of available live templates

Item Tooltip and shortcut Description
By default expand with Use this drop-down list to specify the default invocation key for all templates. Individual expansion keys for the particular templates are defined in the editing area.

8.1+If the standard expansion keys (Tab, Enter, or Space) are not desirable, select the Custom option from this drop-down list.

When Custom is selected, the Change link appears next to the drop-down, leading you to the Keymap page.

Live Templates This list shows all currently available template abbreviations supplied with their descriptions. The abbreviations are grouped below nodes and sorted alphabetically within each group. To activate a template or an entire group, select the check box to its left.
add,png Add
Alt+Insert
Click this button to have a new template item added to the current group of template. You can define the template abbreviation, description, text, variables, expansion key, and context in the editing area below.
delete.png Remove
Delete
Click this button to have the selected live template removed from the list.
copy.gif Copy Click this button to create a new template based on the selected template. A new template item is added to the current node and the fields in the Template Text area show the definition of the selected template.

Context menu of a live template

Item Description
Move Choose a group to move the selected template to.
Change context Choose this command to modify the set of contexts where the current template is enabled. Upon choosing this command, a list of supported language contexts is displayed. To make PhpStorm consider a context sensitive to the template, select a check box next to the context name.

The available context types depend on the enabled plugins.

Restore defaults This command only appears on the context menus of the modified templates, marked blue. Choose this command to restore the default template settings.

Template editing area

The focus is moved to this area in the following cases:

  • When you click the Add add,png or Copy copy.gif button.
  • When you select a live template in the list.
  • When you select a fragment of code in the editor and choose Tools | Save as Live Template.

Use controls of this area to create new live templates and edit the settings for the existing ones.

You can navigate through the Template Text Area using the hot keys that are marked in the field labels.

Item Description
Abbreviation In this text box, specify the template abbreviation.
Description In this text box, provide optional description of a template or an example of its usage.
Template Text In this text box, type the template body that may contain plain text and variables in the format $<variable name>$.

When editing the live template variables, mind the following helpful hints:

  • If you need a dollar sign ($) in the template text, escape it by duplicating this character ($$).
  • To change the variables in a template, click the Edit Variables button and configure the variables as described in Creating and Editing Template Variables.

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

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

Applicable in: This read-only field shows the languages and/or pieces of code where the editor should be sensitive to the template. Upon pressing Ctrl+J in such context, PhpStorm displays a list of templates that are valid for this context.
Change Click this link to modify the set of contexts where the current template is enabled. Upon clicking the link, a list of supported language contexts is displayed. To make PhpStorm consider a context sensitive to the template, select a check box next to the context name.

The available context types depend on the enabled plugins.

Edit Variables Click this button to open the Edit Template Variables dialog box, where you can define how PhpStorm should process template variables upon template expansion.

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

The Edit Template Variables dialog box contains a complete list of available functions. See the list of predefined functions below on this page.
Options In this area, define the behavior of the editor when a template is expanded.
  • Expand with - from this drop-down list, choose the key to invoke the template.
  • Reformat according to style - select this check box to have PhpStorm automatically reformat the expanded text according to the current style settings, defined on the Code Style page.

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