Deprecate BCLabelTranslatorStrategy

sonata-project · Sep 13, 2022 · a314ab2 · a314ab2
1 parent 7854513
commit a314ab2
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/src/Resources/config/core.php b/src/Resources/config/core.php
@@ -92,6 +92,7 @@
 
         // Services used to format the label, default is sonata.admin.label.strategy.noop
 
+        // NEXT_MAJOR: Remove this line.
         ->set('sonata.admin.label.strategy.bc', BCLabelTranslatorStrategy::class)
 
         ->set('sonata.admin.label.strategy.native', NativeLabelTranslatorStrategy::class)

diff --git a/src/Translator/BCLabelTranslatorStrategy.php b/src/Translator/BCLabelTranslatorStrategy.php
@@ -15,11 +15,21 @@
 
 /**
  * @author Thomas Rabaix <[email protected]>
+ *
+ * NEXT_MAJOR: Remove this class.
+ *
+ * @deprecated since sonata-project/admin-bundle 4.x, will be removed in 5.0.
  */
 final class BCLabelTranslatorStrategy implements LabelTranslatorStrategyInterface
 {
     public function getLabel(string $label, string $context = '', string $type = ''): string
     {
+        @trigger_error(sprintf(
+            'The "%s" class is deprecated since sonata-project/admin-bundle version 4.x and will be'
+            .' removed in 5.0 version.',
+            self::class
+        ), \E_USER_DEPRECATED);
+
         if ('breadcrumb' === $context) {
             return sprintf('%s.%s_%s', $context, $type, strtolower($label));
         }

diff --git a/tests/Translator/BCLabelTranslatorStrategyTest.php b/tests/Translator/BCLabelTranslatorStrategyTest.php
@@ -16,6 +16,11 @@
 use PHPUnit\Framework\TestCase;
 use Sonata\AdminBundle\Translator\BCLabelTranslatorStrategy;
 
+/**
+ * NEXT_MAJOR: Remove this class.
+ *
+ * @group legacy
+ */
 final class BCLabelTranslatorStrategyTest extends TestCase
 {
     public function testLabel(): void