Browse Source

Deprecate ClassKeywordRemoveFixer

Kuba Werłos 3 years ago
parent
commit
1ab48e2d39

+ 1 - 1
doc/rules/index.rst

@@ -277,7 +277,7 @@ Import
 Language Construct
 ------------------
 
-- `class_keyword_remove <./language_construct/class_keyword_remove.rst>`_
+- `class_keyword_remove <./language_construct/class_keyword_remove.rst>`_ *(deprecated)*
     Converts ``::class`` keywords to FQCN strings.
 - `combine_consecutive_issets <./language_construct/combine_consecutive_issets.rst>`_
     Using ``isset($var) &&`` multiple times should be done in one call.

+ 2 - 0
doc/rules/language_construct/class_keyword_remove.rst

@@ -2,6 +2,8 @@
 Rule ``class_keyword_remove``
 =============================
 
+.. warning:: This rule is deprecated and will be removed on next major version.
+
 Converts ``::class`` keywords to FQCN strings.
 
 Examples

+ 12 - 1
src/Fixer/LanguageConstruct/ClassKeywordRemoveFixer.php

@@ -15,6 +15,7 @@ declare(strict_types=1);
 namespace PhpCsFixer\Fixer\LanguageConstruct;
 
 use PhpCsFixer\AbstractFixer;
+use PhpCsFixer\Fixer\DeprecatedFixerInterface;
 use PhpCsFixer\FixerDefinition\CodeSample;
 use PhpCsFixer\FixerDefinition\FixerDefinition;
 use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
@@ -25,9 +26,11 @@ use PhpCsFixer\Tokenizer\Tokens;
 use PhpCsFixer\Tokenizer\TokensAnalyzer;
 
 /**
+ * @deprecated
+ *
  * @author Sullivan Senechal <soullivaneuh@gmail.com>
  */
-final class ClassKeywordRemoveFixer extends AbstractFixer
+final class ClassKeywordRemoveFixer extends AbstractFixer implements DeprecatedFixerInterface
 {
     /**
      * @var string[]
@@ -54,6 +57,14 @@ $className = Baz::class;
         );
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function getSuccessorsNames(): array
+    {
+        return [];
+    }
+
     /**
      * {@inheritdoc}
      *