File | Settings | Project Settings | Code Style - PHP
Use this page to configure formatting options for PHP files. View the result in the Preview pane on the right.
On this page:
Tabs and Indents
|Use tab character||
The Smart Tabs check box is available if the Use Tab Character check box is selected.
|Tab size||In this text box, specify the number of spaces included in a tab.|
|Indent||In this text box, specify the number of spaces (or tabs if the Use Tab Character check box is selected) to be inserted for each indent level.|
Use this tab to specify where you want spaces in your code. To have PhpStorm automatically insert a space at a location, select the check box next to this location in the list. The results are displayed in the Preview pane.
Wrapping and Braces
In this tab, customize the code style options, which PhpStorm will apply on reformatting the source code. The left-hand pane contains the list of exceptions (Keep when reformatting), and placement and alignment options for the various code constructs (lists, statements, operations, annotations, etc.). The right-hand pane shows preview.
Alignment takes precedence over indentation options.
Keep when reformatting
Use the check boxes to configure exceptions that PhpStorm will make when reformatting the source code.
Use this tab to define where and how many blank lines you want PhpStorm to retain and insert in your code after reformatting. For each type of location, specify the number of blank lines to be inserted. The results are displayed in the Preview pane.
|Keep Maximum Blank Lines||In this area, specify the number of blank lines to be kept after reformatting in the specified locations.|
|Minimum Blank Lines||In the text boxes in this area, specify the number of blank lines to be present in the specified locations.
These settings do not influence the number of blank lines before the first and after the last item.
This tab lets you define a set of rules that rearranges your code according to your preferences.
|Grouping Rules||Use this area to set the grouping rules.
|Matching rules||Use this area to define elements order as a list of rules, where every rule has a set of matches such as
modifier or type.
|Empty rule||Use this window to create a new matching rule or edit an existing one.
You can select from the following filters:
|This icon appears when you select Order by Name in Order option. The icon indicates that the items in this rule are alphabetized.|
In this tab, configure the code style to be applied inside PHPDoc comments.
|Align parameter names||Select this check box to have the &<paramname> elements aligned.|
|Keep blank lines||Select this check box to suppress removing blank lines automatically.|
|Blank lines around parameters||Select this check box to have a blank line inserted above and below the section with @param tags.|
|Blank line before the first tag||Select this check box to have an blank line inserted above the first PHPDoc tag.|
|Align tag comments||Select this check box to have the description elements aligned.|
|Indent code in PHP tags||Select this check box to have the code enclosed in <?php> tags indented against the opening <?php tag.|
|Align key-value pairs||Select this check box to have the => separators in key-value assignments aligned.|
|Align consecutive assignments||Select this check box to have the = operators in two or more consecutive assignments aligned.|
|Convert True/False constants to upper case||Select this check box to have the true and false constants displayed in the upper case.|
|Convert Null constant to upper case||Select this check box to have the null constant displayed in the upper case.|
Click this link to choose the base for the current language default code style from the pop-up list, that appears. The list contains two options:
- Language: choose this option to inherit the coding style settings from another language. Select the source language from the list, that opens. So doing, only the settings that are applicable to the current language are taken. All the other settings are not affected.
- Predefined code style: choose this option to use the coding standards defined for a specific framework. Select one of the following frameworks from the list:
This link appears in the upper-right corner of the language-specific code style page, when applicable.
Click Reset to discard changes and return to the initial set of code style settings.