PhpStorm: Setup

EditorConfig

Please note that there is an .editorconfig file in the TYPO3 core repository. See https://editorconfig.org/ for more information. Use the EditorConfig plugin for PhpStorm.

If you use the .editorconfig file (which is included in the TYPO3 core), some standard formatting rules are already setup automatically (e.g. indent with 4 spaces for PHP files).

The rules defined in .editorconfig are very minimal and it is suggested to see the TYPO3 Coding Guidelines for more information and toolchain configuration. Please read PhpStorm documentation on using PHP CS Fixer for information on how to use the provided config.php within PhpStorm.

For a quick start, you can use the following PhpStorm code style to comply with PSR-12, which is the most recent recommendation at the time of this writing that PhpStorm provides a preset for:

PHP files

Set Predefined Style in PhpStorm: File > Settings > Editor > Code Style > PHP > Set From > Predefined Style

Choose PSR-12.

In order to test this, use Code: Reformat Code to reformat a PHP file.

More information

You can find more information on the Coding Guidelines section in the Appendix.

Install plugins in PhpStorm

1. Open Settings: File > Settings (ctrl + alt + s)
2. Select Plugins
3. Start typing name of plugin and select a match
4. Click on Install.

Recommended Plugins

• EditorConfig plugin
• DynamicReturnTypePlugin : With this Plugin, return types for some functions can be configured dynamically. For example, if you use GeneralUtility::makeInstance, the expected return type is determined from the first parameter passed to the function. The configuration file for this plugin is dynamicReturnTypeMeta.json
• Php Inspections (EA Extended) : Static Code Analysis tool for PHP
• reStructuredText plugin: This will show you errors in your reStructuredText files (file ending .rst) when you are editing the core changelog or are updating the documentation for a system extension.
• PHPUnit Enhancement This helps with code-completion and navigation in combination with unit tests and Prophecy (among other things).
• CSV Editor Allows to easily inspect and edit CSV formatted files in a table (for example used in testing fixture files).

Optional Plugins

• Fluid plugin (sgalinski)
• TypoScript plugin (sgalinski)

* `Gerrit plugin

<https://plugins.jetbrains.com/plugin/7272-gerrit>`__

* `TYPO3 CMS Plugin

<https://plugins.jetbrains.com/plugin/9496-typo3-cms-plugin>`__

* `TYPO3 XLIFF Utility

<https://plugins.jetbrains.com/plugin/8098-typo3-xliff-utility>`__