• Install now

Rule phpdoc_readonly_class_comment_to_keyword

Converts readonly comment on classes to the readonly keyword.

Warning

Using this rule is risky

If classes marked with @readonly annotation were extended anyway, applying this fixer may break the inheritance for their child classes.

Examples

Example #1

--- Original
+++ New
     <?php
-    /** @readonly */
-    class C {
+
+    readonly class C {
     }

References

• Fixer class: PhpCsFixer\Fixer\ClassNotation\PhpdocReadonlyClassCommentToKeywordFixer

• Test class: PhpCsFixer\Tests\Fixer\ClassNotation\PhpdocReadonlyClassCommentToKeywordFixerTest

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