• Install now

Rule phpdoc_types_order

Sorts PHPDoc types.

Configuration

case_sensitive

Whether the sorting should be case sensitive.

Allowed types: bool

Default value: false

null_adjustment

Forces the position of null (overrides sort_algorithm).

Allowed values: 'always_first', 'always_last' and 'none'

Default value: 'always_first'

sort_algorithm

The sorting algorithm to apply.

Allowed values: 'alpha' and 'none'

Default value: 'alpha'

Examples

Example #1

Default configuration.

--- Original
+++ New
 <?php
 /**
- * @param string|null $bar
+ * @param null|string $bar
  */

Example #2

With configuration: ['null_adjustment' => 'always_last'].

--- Original
+++ New
 <?php
 /**
- * @param null|string $bar
+ * @param string|null $bar
  */

Example #3

With configuration: ['sort_algorithm' => 'alpha'].

--- Original
+++ New
 <?php
 /**
- * @param null|string|int|\Foo $bar
+ * @param null|\Foo|int|string $bar
  */

Example #4

With configuration: ['sort_algorithm' => 'alpha', 'null_adjustment' => 'always_last'].

--- Original
+++ New
 <?php
 /**
- * @param null|string|int|\Foo $bar
+ * @param \Foo|int|string|null $bar
  */

Example #5

With configuration: ['sort_algorithm' => 'alpha', 'null_adjustment' => 'none'].

--- Original
+++ New
 <?php
 /**
- * @param null|string|int|\Foo $bar
+ * @param \Foo|int|null|string $bar
  */

Example #6

With configuration: ['case_sensitive' => true].

--- Original
+++ New
 <?php
 /**
- * @param Aaa|AA $bar
+ * @param AA|Aaa $bar
  */

Rule sets

The rule is part of the following rule sets:

• @PhpCsFixer

• @Symfony with config:

  ['null_adjustment' => 'always_last', 'sort_algorithm' => 'none']

References

• Fixer class: PhpCsFixer\Fixer\Phpdoc\PhpdocTypesOrderFixer

• Test class: PhpCsFixer\Tests\Fixer\Phpdoc\PhpdocTypesOrderFixerTest

The test class defines officially supported behaviour. Each test case is a part of our backward compatibility promise.