doc/rules/php_unit/php_unit_internal_class.rst
php_unit_internal_classAll PHPUnit test classes should be marked as internal.
This rule is CONFIGURABLE
You can configure this rule using the following option: ``types``.
Configuration
-------------
``types``
~~~~~~~~~
What types of classes to mark as internal.
Allowed values: a subset of ``['abstract', 'final', 'normal']``
Default value: ``['normal', 'final']``
Examples
--------
Example #1
~~~~~~~~~~
*Default* configuration.
.. code-block:: diff
--- Original
+++ New
<?php
+
+/**
+ * @internal
+ */
class MyTest extends TestCase {}
Example #2
~~~~~~~~~~
With configuration: ``['types' => ['final']]``.
.. code-block:: diff
--- Original
+++ New
<?php
class MyTest extends TestCase {}
+/**
+ * @internal
+ */
final class FinalTest extends TestCase {}
abstract class AbstractTest extends TestCase {}
Rule sets
---------
The rule is part of the following rule set:
- `@PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>`_
References
----------
- Fixer class: `PhpCsFixer\\Fixer\\PhpUnit\\PhpUnitInternalClassFixer <./../../../src/Fixer/PhpUnit/PhpUnitInternalClassFixer.php>`_
- Test class: `PhpCsFixer\\Tests\\Fixer\\PhpUnit\\PhpUnitInternalClassFixerTest <./../../../tests/Fixer/PhpUnit/PhpUnitInternalClassFixerTest.php>`_
The test class defines officially supported behaviour. Each test case is a part of our backward compatibility promise.