Rule `final_internal_class`¶

Internal classes should be final.

Warning

Using this rule is risky.

Changing classes to final might cause code execution to break.

Configuration¶

Class level annotations tags that must be set in order to fix the class. (case insensitive)

Note

The previous name of this option was annotation-white-list but it is now deprecated and will be removed on next major version.

Allowed types: array

Default value: ['@internal']

Class level annotations tags that must be omitted to fix the class, even if all of the white list ones are used as well. (case insensitive)

Note

The previous name of this option was annotation-black-list but it is now deprecated and will be removed on next major version.

Allowed types: array

Default value: ['@final', '@Entity', '@ORM\\Entity', '@ORM\\Mapping\\Entity', '@Mapping\\Entity']

Should classes without any DocBlock be fixed to final?

Note

The previous name of this option was consider-absent-docblock-as-internal-class but it is now deprecated and will be removed on next major version.

Allowed types: bool

Default value: false

Default configuration.

--- Original
+++ New
@@ -2,6 +2,6 @@
 /**
  * @internal
  */
-class Sample
+final class Sample
 {
 }

With configuration: ['annotation_include' => ['@Custom'], 'annotation_exclude' => ['@not-fix']].

--- Original
+++ New
@@ -2,5 +2,5 @@
 /**
  * @CUSTOM
  */
-class A{}
+final class A{}

The rule is part of the following rule set:

@PhpCsFixer:risky: Using the @PhpCsFixer:risky rule set will enable the final_internal_class rule with the default config.