Rule ``phpdoc_no_alias_tag``
No alias PHPDoc tags should be used.
Configuration
``replacements`` ~~~~~~~~~~~~~~~~
Mapping between replaced annotations with new ones.
Allowed types: ``array``
Default value: ``['property-read' => 'property', 'property-write' => 'property', 'type' => 'var', 'link' => 'see']``
Examples
Example #1 ~~~~~~~~~~
*Default* configuration.
.. code-block:: diff
--- Original +++ New @@ -1,10 +1,10 @@ <?php /** * @property string $foo - * @property-read string $bar + * @property string $bar * - * @link baz + * @see baz */ final class Example { }
Example #2 ~~~~~~~~~~
With configuration: ``['replacements' => ['link' => 'website']]``.
.. code-block:: diff
--- Original +++ New @@ -3,8 +3,8 @@ * @property string $foo * @property-read string $bar * - * @link baz + * @website baz */ final class Example { }
Rule sets
The rule is part of the following rule sets
@PhpCsFixer Using the `@PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>`_ rule set will enable the ``phpdoc_no_alias_tag`` rule with the default config.
@Symfony Using the `@Symfony <./../../ruleSets/Symfony.rst>`_ rule set will enable the ``phpdoc_no_alias_tag`` rule with the default config.