Deprecate Pool::setTemplateRegistry (#6794)

sonata-project · Jan 21, 2021 · 8a48504 · 8a48504
1 parent c422007
commit 8a48504
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 3 deletions.
diff --git a/UPGRADE-3.x.md b/UPGRADE-3.x.md
@@ -1,6 +1,13 @@
 UPGRADE 3.x
 ===========
 
+UPGRADE FROM 3.xx to 3.xx
+=========================
+
+### Deprecated `Sonata\AdminBundle\Admin\Pool::setTemplateRegistry()` method.
+
+This method has been deprecated without replacement.
+
 UPGRADE FROM 3.86 to 3.87
 =========================
 

diff --git a/src/Admin/Pool.php b/src/Admin/Pool.php
@@ -117,7 +117,9 @@ class Pool
     protected $propertyAccessor;
 
     /**
-     * NEXT_MAJOR: change to TemplateRegistryInterface.
+     * NEXT_MAJOR: Remove this property.
+     *
+     * @deprecated since sonata-project/admin-bundle 3.x and will be removed in 4.0.
      *
      * @var MutableTemplateRegistryInterface
      */
@@ -649,10 +651,19 @@ public function getAdminClasses()
     }
 
     /**
-     * NEXT_MAJOR: change to TemplateRegistryInterface.
+     * NEXT_MAJOR: Remove this method.
+     *
+     * @deprecated since sonata-project/admin-bundle 3.x and will be removed in 4.0.
      */
     final public function setTemplateRegistry(MutableTemplateRegistryInterface $templateRegistry): void
     {
+        if ('sonata_deprecation_mute' !== (\func_get_args()[1] ?? null)) {
+            @trigger_error(sprintf(
+                'The "%s()" method is deprecated since version 3.x and will be removed in 4.0.',
+                __METHOD__,
+            ), \E_USER_DEPRECATED);
+        }
+
         $this->templateRegistry = $templateRegistry;
     }
 

diff --git a/src/Resources/config/core.php b/src/Resources/config/core.php
@@ -56,8 +56,10 @@
                 [], // admin service groups
                 [], // admin service classes
             ])
+            // NEXT_MAJOR: Remove this call.
             ->call('setTemplateRegistry', [
                 new ReferenceConfigurator('sonata.admin.global_template_registry'),
+                'sonata_deprecation_mute',
             ])
 
         ->alias(Pool::class, 'sonata.admin.pool')

diff --git a/tests/Action/DashboardActionTest.php b/tests/Action/DashboardActionTest.php
@@ -42,7 +42,6 @@ protected function setUp(): void
         $this->templateRegistry = $this->createStub(MutableTemplateRegistryInterface::class);
 
         $pool = new Pool($container);
-        $pool->setTemplateRegistry($this->templateRegistry);
 
         $twig = $this->createMock(Environment::class);