doc/rules/doctrine_annotation/doctrine_annotation_indentation.rst
doctrine_annotation_indentationDoctrine annotations must be indented with four spaces.
This rule is CONFIGURABLE
You can configure this rule using the following options: ``ignored_tags``,
``indent_mixed_lines``.
Configuration
-------------
``ignored_tags``
~~~~~~~~~~~~~~~~
List of tags that must not be treated as Doctrine Annotations.
Allowed types: ``list<string>``
Default value: ``['abstract', 'access', 'code', 'deprec', 'encode', 'exception', 'final', 'ingroup', 'inheritdoc', 'inheritDoc', 'magic', 'name', 'toc', 'tutorial', 'private', 'static', 'staticvar', 'staticVar', 'throw', 'api', 'author', 'category', 'copyright', 'deprecated', 'example', 'filesource', 'global', 'ignore', 'internal', 'license', 'link', 'method', 'package', 'param', 'property', 'property-read', 'property-write', 'return', 'see', 'since', 'source', 'subpackage', 'throws', 'todo', 'TODO', 'usedBy', 'uses', 'var', 'version', 'after', 'afterClass', 'backupGlobals', 'backupStaticAttributes', 'before', 'beforeClass', 'codeCoverageIgnore', 'codeCoverageIgnoreStart', 'codeCoverageIgnoreEnd', 'covers', 'coversDefaultClass', 'coversNothing', 'dataProvider', 'depends', 'expectedException', 'expectedExceptionCode', 'expectedExceptionMessage', 'expectedExceptionMessageRegExp', 'group', 'large', 'medium', 'preserveGlobalState', 'requires', 'runTestsInSeparateProcesses', 'runInSeparateProcess', 'small', 'test', 'testdox', 'ticket', 'uses', 'SuppressWarnings', 'noinspection', 'package_version', 'enduml', 'startuml', 'psalm', 'phpstan', 'template', 'fix', 'FIXME', 'fixme', 'override']``
``indent_mixed_lines``
~~~~~~~~~~~~~~~~~~~~~~
Whether to indent lines that have content before closing parenthesis.
Allowed types: ``bool``
Default value: ``false``
Examples
--------
Example #1
~~~~~~~~~~
*Default* configuration.
.. code-block:: diff
--- Original
+++ New
<?php
/**
- * @Foo(
- * foo="foo"
- * )
+ * @Foo(
+ * foo="foo"
+ * )
*/
class Bar {}
Example #2
~~~~~~~~~~
With configuration: ``['indent_mixed_lines' => true]``.
.. code-block:: diff
--- Original
+++ New
<?php
/**
- * @Foo({@Bar,
- * @Baz})
+ * @Foo({@Bar,
+ * @Baz})
*/
class Bar {}
Rule sets
---------
The rule is part of the following rule set:
- `@DoctrineAnnotation <./../../ruleSets/DoctrineAnnotation.rst>`_
References
----------
- Fixer class: `PhpCsFixer\\Fixer\\DoctrineAnnotation\\DoctrineAnnotationIndentationFixer <./../../../src/Fixer/DoctrineAnnotation/DoctrineAnnotationIndentationFixer.php>`_
- Test class: `PhpCsFixer\\Tests\\Fixer\\DoctrineAnnotation\\DoctrineAnnotationIndentationFixerTest <./../../../tests/Fixer/DoctrineAnnotation/DoctrineAnnotationIndentationFixerTest.php>`_
The test class defines officially supported behaviour. Each test case is a part of our backward compatibility promise.