PhpStorm 2016.3 Help

Creating Code Constructs by Live Templates

On this page:

Introduction

This page describes how to generate source code using live templates.

Using Live Templates enables you to create such code constructs as JavaScript iterations, Emmet, HTML and XML tags.

To explore the list of available live templates, in the Settings/Preferences dialog, open the Live Templates page.

Inserting a live template

  1. Place the caret at the desired position, where the new construct should be added.
  2. Do one of the following:
    • On the main menu, choose Code | Insert Live Template.
    • Press Ctrl+J.
    • Type some initial letters of the template abbreviation to get the matching abbreviations in the suggestion list. Note that the suggestion list may contain same abbreviations for different templates.
  3. From the suggestion list, select the desired template. While the suggestion list is displayed, it is possible to view Quick Documentation for the items at caret, by pressing Ctrl+Q.
    /help/img/idea/2016.3/ps_py_qdoc_live_template.png
  4. Press the template invocation key (this may be Space, Tab or Enter, depending on the template definition). The new code construct is inserted in the specified position.
  5. If the selected template is parametrized and requires user input, the editor enters the template editing mode and displays the first input field highlighted with the red frame. Type your value in this frame and press Enter or Tab to complete input and pass to the next input field. After completing the last input field, the caret moves to the end of the construct, and the editor returns to the regular mode of operation.

It is also possible to type a template abbreviation, and then press Ctrl+J.

Using live templates for smart completion of parameters in function calls

In the PHP context, you can use an “automatic” live template that provides completion lists for the parameters passed into functions, methods, or class constructors.

  • To activate this functionality:
    1. Open the Settings / Preferences Dialog by pressing Ctrl+Alt+S or by choosing File | Settings for Windows and Linux or PhpStorm | Preferences for OS X. Expand the Editor node, and then click Smart Keys under General.
    2. On the Smart Keys page that opens, select the Enable smart function parameters completion check box in the PHP area.
  • To invoke the magic live template, type the params keyword as the first parameter in the call of the function, method, or class:
    ps_smart_parameter_completion_step_1.png
    PhpStorm displays a live template where the parameters are automatically completed with the variable names defined in the function declaration. To move to the next parameter, press Enter or Tab. To move to the previous parameter, press Shift+Tab.

    The completion list contains variables from a local scope in the next order: with the same type, with a similar name, defined nearby. You can always switch to the usual completion mode by pressing Ctrl+Space or just typing anything which is not in the list. Variables with similar names are inserted automatically.

See Also

Last modified: 1 December 2016