• Install now

Rule phpdoc_types

The correct case must be used for standard PHP types in PHPDoc.

Configuration

groups

Type groups to fix.

Allowed values: a subset of ['alias', 'meta', 'simple']

Default value: ['simple', 'alias', 'meta']

Examples

Example #1

Default configuration.

--- Original
+++ New
 <?php
 /**
- * @param STRING|String[] $bar
+ * @param string|string[] $bar
  *
- * @return inT[]
+ * @return int[]
  */

Example #2

With configuration: ['groups' => ['simple', 'alias']].

--- Original
+++ New
 <?php
 /**
- * @param BOOL $foo
+ * @param bool $foo
  *
  * @return MIXED
  */

Rule sets

The rule is part of the following rule sets:

• @PhpCsFixer

• @Symfony

References

• Fixer class: PhpCsFixer\Fixer\Phpdoc\PhpdocTypesFixer

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

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