PhpStorm 8.0.0 Web Help

File | Settings | Editor | File and Code Templates


Files can be created according to pre-defined templates (file templates). Use this page to view, edit, and create such templates.

Existing templates are listed in the central part of the page. Different groups of templates are located in different tabs.

When you select a template, its contents and description are displayed in the right-hand part of the page.

    Tabs

    Tab Description
    Templates This tab displays the available file templates.

    You can edit the existing templates, or create new ones.

    Note

    The Class templates cannot be deleted and their names and extensions cannot be edited.

    Includes This tab shows the templates for reusable fragments that can be included in file templates.

    You can edit the existing templates, or create new ones.

    PhpStorm provides as set of predefined built-in templates for generating PHP file headers and PHPDoc comments for PHP classes, fields, and functions (methods).
    Code This tab displays built-in snippets, i.e. templates for code fragments that PhpStorm can generate in various typical situations, for example, for generating implemented or overridden method bodies.

    You can edit the existing snippets, but you cannot create new ones.

    Toolbar

    Item Tooltip Description
    add.png Create Template Click this button to create a new template in the currently opened tab. This option is only available in the Templates and the Includes tabs.
    delete.png Remove Template Click this button to delete the selected template. This option is only available for certain templates in the Templates and the Includes tabs.
    copy Copy Template Click this button to create a copy of the selected template. This option is only available in the Templates and the Includes tabs.
    resetProfileToDefault.png Reset to Default Click this button to revert the selected template to its original state. This option is only available for templates that have been modified (they are highlighted in blue).
    N/A Reset This link appears in the top-right corner of the page when you start editing a template. Clicking this link resets all unsaved changes to any template in any tab.

    Template settings and contents

    Item Description
    Name This text box appears when a new template is created. Specify the name of the new template.
    Extension In this text box, specify the extension. PhpStorm will apply this template when new files of this type are created.
    Reformat according to style Select this check box, to have PhpStorm reformat generated stub files according to the style defined on the Code Style page.

    Note

    This option is only available in the Templates tab.

    Template text Edit the template contents. You can use:
    • Plain text.
    • #parse directives to work with template includes.
    • Variables to be expanded into corresponding values in the ${<variable_name>} format.

      The available predefined file template variables are:

      • ${PROJECT_NAME} - the name of the current project.
      • ${FILE_NAME} - the name of the PHP file that will be created.
      • ${NAME} - the name of the new file which you specify in the New File dialog box during the file creation.
      • ${USER} - the login name of the current user.
      • ${DATE} - the current system date.
      • ${TIME} - the current system time.
      • ${YEAR} - the current year.
      • ${MONTH} - the current month.
      • ${DAY} - the current day of the month.
      • ${HOUR} - the current hour.
      • ${MINUTE} - the current minute.
      • ${PRODUCT_NAME} - the name of the IDE in which the file will be created.
      • ${MONTH_NAME_SHORT} - the first 3 letters of the month name. Example: Jan, Feb, etc.
      • ${MONTH_NAME_FULL} - full name of a month. Example: January, February, etc.

      PhpStorm provides a set of additional variables for PHP include templates, that is, templates of reusable fragments that can be included in other PHP file template. The built-in PHP include templates are intended for generating file headers and PHPDoc documentation comments. The following variables are available in PHP include templates:

      • ${NAME} - the name of the class, field, or function (method) for which the PHPDoc comment will be generated.
      • ${NAMESPACE} - the fully qualified name (without a leading slash) of the class or field namespace.
      • ${CLASS_NAME} - the name of the class where the field to generate the PHPDoc comment for is defined.
      • ${STATIC} - gets the value static if the function (method) or field to generate the comment for is static. Otherwise evaluates to an empty string.
      • ${TYPE_HINT} - a prompt for the return value of the function (method) to generate the comment for. If the return type cannot be detected through the static analysis of the function (method), evaluates to void.
      • ${PARAM_DOC} - - a documentation comment for parameters. Evaluates to a set of lines @param type name. If the function to generate comments for does not contain any parameters, the variable evaluates to empty content.
      • ${THROWS_DOC} - a documentation comment for exceptions. Evaluates to a set of lines @throws type. If the function to generate comments for does not throw any exceptions, the variable evaluates to empty content.
      • ${DS} - a dollar character ($). The variable evaluates to a plain dollar character ($) and is used when you need to escape this symbol so it is not treated as a prefix of a variable.
      • ${CARET} - indicated the position of the caret after generating and adding the comment.

        Note

        This ${CARET} variable is applied only when a PHPDoc comment is generated and inserted during file creation. When a PHPDoc comment is created through Code | Generate | PHPDoc block, multiple selection of functions or methods is available so documentation comments can be created to several classes, functions, methods, or fields. As a result, PhpStorm cannot "choose" the block to apply the ${CARET} variable in, therefore in this case the ${CARET} variable is ignored.

      • 6.0+ You can prevent treating dollar characters ($) in template variables as prefixes. If you need a dollar character ($ inserted as is, use the ${DS} file template variable instead. When the template is applied, this variable evaluates to a plain dollar character ($).

        For example, to use some version control keywords (such as $Revision$, $Date$, etc.) in your default class template, write ${DS} instead of the dollar prefix ($).

        To have a PHP variable rendered "as is" in the generated file, also use ${DS}: the template code ${DS}this will be rendered as $this.

      • PhpStorm doesn't prompt for the values of Velocity variables defined with #set.
    • Custom variables. Their names can be defined right in the template through the #set directive or will be defined during the file creation.
    Description This read-only field provides the information about the template, its predefined variables, and the way they work. This field is not available in custom templates.

    See Also

    Procedures:

    Web Resources: