[AllBundles] Cleanup adminlist configurator getBundleName/getEntityNa…

…me deprecations
Kunstmaan · Mar 23, 2024 · 4d0376e · 4d0376e
1 parent 76ba43f
commit 4d0376e
Show file tree

Hide file tree

Showing 39 changed files with 20 additions and 655 deletions.
diff --git a/src/Kunstmaan/AdminBundle/AdminList/ExceptionAdminListConfigurator.php b/src/Kunstmaan/AdminBundle/AdminList/ExceptionAdminListConfigurator.php
@@ -103,20 +103,6 @@ public function canView($item)
         return false;
     }
 
-    public function getBundleName()
-    {
-        trigger_deprecation('kunstmaan/admin-bundle', '6.4', 'The "%s" method is deprecated and will be removed in 7.0. Use the "getEntityClass" method instead.', __METHOD__);
-
-        return 'KunstmaanAdminBundle';
-    }
-
-    public function getEntityName()
-    {
-        trigger_deprecation('kunstmaan/admin-bundle', '6.4', 'The "%s" method is deprecated and will be removed in 7.0. Use the "getEntityClass" method instead.', __METHOD__);
-
-        return 'Exception';
-    }
-
     public function getEntityClass(): string
     {
         return Exception::class;

diff --git a/src/Kunstmaan/AdminListBundle/AdminList/Configurator/AbstractAdminListConfigurator.php b/src/Kunstmaan/AdminListBundle/AdminList/Configurator/AbstractAdminListConfigurator.php
@@ -19,8 +19,6 @@
 /**
  * Abstract admin list configurator, this implements the most common functionality from the
  * AdminListConfiguratorInterface and ExportListConfiguratorInterface
- *
- * @method string getEntityClass()
  */
 abstract class AbstractAdminListConfigurator implements AdminListConfiguratorInterface, ExportListConfiguratorInterface
 {
@@ -111,30 +109,9 @@ abstract class AbstractAdminListConfigurator implements AdminListConfiguratorInt
     protected $orderDirection = '';
 
     /**
-     * @deprecated since 6.4 and will be removed in 7.0. Implement the `getEntityClass` method instead.
-     *
-     * Return current bundle name.
-     *
-     * @return string
+     * @return class-string
      */
-    public function getBundleName()
-    {
-        // No-op
-        throw new \RuntimeException(sprintf('The "%s" method is no-op since 6.4 and will be removed in 7.0. Implement the `getEntityClass` method instead.', __METHOD__));
-    }
-
-    /**
-     * @deprecated since 6.4 and will be removed in 7.0. Implement the `getEntityClass` method instead.
-     *
-     * Return current entity name.
-     *
-     * @return string
-     */
-    public function getEntityName()
-    {
-        // No-op
-        throw new \RuntimeException(sprintf('The "%s" method is no-op since 6.4 and will be removed in 7.0. Implement the `getEntityClass` method instead.', __METHOD__));
-    }
+    abstract public function getEntityClass(): string;
 
     /**
      * Return default repository name.
@@ -143,12 +120,6 @@ public function getEntityName()
      */
     public function getRepositoryName()
     {
-        if (!method_exists($this, 'getEntityClass')) {
-            trigger_deprecation('kunstmaan/adminlist-bundle', '6.4', 'Relying on "getBundleName" and "getEntityName" in your adminlist configurator is deprecated and will be removed in 7.0. Implement the "getEntityClass" method in your adminlist configurator instead.');
-
-            return sprintf('%s:%s', $this->getBundleName(), $this->getEntityName());
-        }
-
         return $this->getEntityClass();
     }
 
@@ -216,7 +187,7 @@ public function getAddUrlFor(array $params = [])
     {
         $params = array_merge($params, $this->getExtraParameters());
 
-        $friendlyName = explode('\\', method_exists($this, 'getEntityClass') ? $this->getEntityClass() : $this->getEntityName());
+        $friendlyName = explode('\\', $this->getEntityClass());
         $friendlyName = array_pop($friendlyName);
         $re = '/(?<=[a-z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])/';
         $a = preg_split($re, $friendlyName);
@@ -843,19 +814,6 @@ public function getOrderDirection()
      */
     public function getPathByConvention($suffix = null)
     {
-        // NEXT_MAJOR Remove if
-        if (!method_exists($this, 'getEntityClass')) {
-            trigger_deprecation('kunstmaan/adminlist-bundle', '6.4', 'Relying on "getBundleName" and "getEntityName" in your adminlist configurator is deprecated and will be removed in 7.0. Implement the "getEntityClass" method in your adminlist configurator instead.');
-
-            $entityName = strtolower($this->getEntityName());
-            $entityName = str_replace('\\', '_', $entityName);
-            if (empty($suffix)) {
-                return sprintf('%s_admin_%s', strtolower($this->getBundleName()), $entityName);
-            }
-
-            return sprintf('%s_admin_%s_%s', strtolower($this->getBundleName()), $entityName, $suffix);
-        }
-
         $rootNamespace = strtolower(EntityDetails::getRootNamespace($this->getEntityClass()));
         $rootNamespace = str_replace('\\bundle\\', '', $rootNamespace);
         $entityPart = EntityDetails::getEntityPart($this->getEntityClass());
@@ -869,18 +827,6 @@ public function getPathByConvention($suffix = null)
         return sprintf('%s_admin_%s_%s', $rootNamespace, $entityName, $suffix);
     }
 
-    /**
-     * @deprecated since 6.4 and will be removed in 7.0. There is no replacement for this method.
-     *
-     * @return string
-     */
-    public function getControllerPath()
-    {
-        trigger_deprecation('kunstmaan/adminlist-bundle', '6.4', 'Method deprecated and will be removed in 7.0. There is no replacement for this method.');
-
-        return sprintf('%s:%s', $this->getBundleName(), $this->getEntityName());
-    }
-
     /**
      * Return extra parameters for use in list actions.
      *

diff --git a/src/Kunstmaan/AdminListBundle/AdminList/Configurator/AbstractPageAdminListConfigurator.php b/src/Kunstmaan/AdminListBundle/AdminList/Configurator/AbstractPageAdminListConfigurator.php
@@ -167,21 +167,6 @@ private function getOtherLocalesResults(QueryBuilder $qb)
         }
     }
 
-    /**
-     * Return default repository name.
-     *
-     * @return string
-     */
-    public function getRepositoryName()
-    {
-        // NEXT_MAJOR remove if and old sprintf return
-        if (!method_exists($this, 'getEntityClass')) {
-            return parent::getRepositoryName();
-        }
-
-        return sprintf('%s:%s\%s', $this->getBundleName(), 'Pages', $this->getEntityName());
-    }
-
     /**
      * @return EntityInterface
      */

diff --git a/src/Kunstmaan/AdminListBundle/Controller/AbstractAdminListController.php b/src/Kunstmaan/AdminListBundle/Controller/AbstractAdminListController.php
@@ -345,7 +345,7 @@ protected function doDeleteAction(AdminListConfiguratorInterface $configurator,
         /** @var SlugifierInterface $slugifier */
         $slugifier = $this->container->get('kunstmaan_utilities.slugifier');
 
-        if (!$this->isCsrfTokenValid('delete-' . $slugifier->slugify(method_exists($configurator, 'getEntityClass') ? $configurator->getEntityClass() : $configurator->getEntityName()), $request->request->get('token'))) {
+        if (!$this->isCsrfTokenValid('delete-' . $slugifier->slugify($configurator->getEntityClass()), $request->request->get('token'))) {
             $indexUrl = $configurator->getIndexUrl();
 
             return new RedirectResponse($this->generateUrl($indexUrl['path'], $indexUrl['params'] ?? []));

diff --git a/src/Kunstmaan/AdminListBundle/Resources/doc/AdminListBundle.md b/src/Kunstmaan/AdminListBundle/Resources/doc/AdminListBundle.md
@@ -75,12 +75,12 @@ The first parameter of the addField() method is the fieldname, second one is the
     }
 ```
 
-And at last we add our Entity name
+And at last we add our Entity class
 
 ```PHP
-    public function getEntityName()
+    public function getEntityClass(): string
     {
-        return 'Document';
+        return App\Entity\Document::class;
     }
 }
 ```

diff --git a/src/Kunstmaan/AdminListBundle/Resources/views/AdminListTwigExtension/sure-modal.html.twig b/src/Kunstmaan/AdminListBundle/Resources/views/AdminListTwigExtension/sure-modal.html.twig
@@ -12,7 +12,7 @@
                 </h3>
             </div>
             <form action="{{ path(adminlist.getDeleteUrlFor(item)["path"], adminlist.getDeleteUrlFor(item)[("params")] ) }}" method="POST">
-                <input type="hidden" name="token" value="{{ csrf_token('delete-'~(attribute(adminlist.configurator, 'getEntityClass') ? adminlist.configurator.entityClass : adminlist.configurator.entityName)|slugify) }}"/>
+                <input type="hidden" name="token" value="{{ csrf_token('delete-'~adminlist.configurator.entityClass|slugify) }}"/>
 
                 <!-- Body -->
                 <div class="modal-body">

diff --git a/src/Kunstmaan/AdminListBundle/Resources/views/Default/list.html.twig b/src/Kunstmaan/AdminListBundle/Resources/views/Default/list.html.twig
@@ -6,7 +6,7 @@
             {% if adminmenu.current %}
                 {{ adminmenu.current.label | trans }} {% block page_header_addition %}{% endblock %}
             {% else %}
-                {{ attribute(adminlist.configurator, 'getEntityClass') ? adminlist.configurator.getEntityClass() : adminlist.configurator.getEntityName() }}
+                {{ adminlist.configurator.getEntityClass() }}
             {% endif %}
         </h1>
     </div>

diff --git a/...stmaan/AdminListBundle/Tests/AdminList/Configurator/AbstractAdminListConfiguratorTest.php b/...stmaan/AdminListBundle/Tests/AdminList/Configurator/AbstractAdminListConfiguratorTest.php
@@ -13,14 +13,11 @@
 use Kunstmaan\AdminListBundle\AdminList\ItemAction\ItemActionInterface;
 use Kunstmaan\AdminListBundle\AdminList\ListAction\ListActionInterface;
 use PHPUnit\Framework\TestCase;
-use Symfony\Bridge\PhpUnit\ExpectDeprecationTrait;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Session\Session;
 
 class AbstractAdminListConfiguratorTest extends TestCase
 {
-    use ExpectDeprecationTrait;
-
     /** @var AbstractAdminListConfigurator */
     private $adminListConfigurator;
 
@@ -67,16 +64,6 @@ public function getEntityClass(): string
             {
                 return \App\Entity\News::class;
             }
-
-            public function getBundleName()
-            {
-                return 'App';
-            }
-
-            public function getEntityName()
-            {
-                return 'News';
-            }
         };
     }
 
@@ -521,16 +508,6 @@ public function testGetPathByConvention()
         $this->assertEquals('app_admin_news_test', $this->adminListConfigurator->getPathByconvention('test'));
     }
 
-    /**
-     * @group legacy
-     */
-    public function testGetControllerPath()
-    {
-        $this->expectDeprecation('Since kunstmaan/adminlist-bundle 6.4: Method deprecated and will be removed in 7.0. There is no replacement for this method.');
-
-        $this->assertEquals('App:News', $this->adminListConfigurator->getControllerPath());
-    }
-
     public function testGetExtraParameters()
     {
         $this->assertIsArray($this->adminListConfigurator->getExtraParameters());

diff --git a/...ListBundle/Tests/AdminList/Configurator/AbstractDoctrineDBALAdminListConfiguratorTest.php b/...ListBundle/Tests/AdminList/Configurator/AbstractDoctrineDBALAdminListConfiguratorTest.php
@@ -138,16 +138,6 @@ public function getEntityClass(): string
             {
                 return \App\Entity\User::class;
             }
-
-            public function getBundleName()
-            {
-                return 'App';
-            }
-
-            public function getEntityName()
-            {
-                return 'User';
-            }
         };
     }
 }

diff --git a/...nListBundle/Tests/AdminList/Configurator/AbstractDoctrineORMAdminListConfiguratorTest.php b/...nListBundle/Tests/AdminList/Configurator/AbstractDoctrineORMAdminListConfiguratorTest.php
@@ -238,16 +238,6 @@ public function getEntityClass(): string
             {
                 return \App\Entity\Blog::class;
             }
-
-            public function getBundleName()
-            {
-                return 'App';
-            }
-
-            public function getEntityName()
-            {
-                return 'Blog';
-            }
         };
     }
 }

diff --git a/src/Kunstmaan/ArticleBundle/AdminList/AbstractArticleAuthorAdminListConfigurator.php b/src/Kunstmaan/ArticleBundle/AdminList/AbstractArticleAuthorAdminListConfigurator.php
@@ -32,34 +32,6 @@ public function __construct(EntityManagerInterface $em, AclHelper $aclHelper, $l
         $this->locale = $locale;
     }
 
-    /**
-     * @deprecated since 6.4. Use the `getEntityClass` method instead.
-     *
-     * Return current bundle name.
-     *
-     * @return string
-     */
-    public function getBundleName()
-    {
-        trigger_deprecation('kunstmaan/article-bundle', '6.4', 'Method "%s" deprecated and will be removed in 7.0. Use the "getEntityClass" method instead.', __METHOD__);
-
-        return 'KunstmaanArticleBundle';
-    }
-
-    /**
-     * @deprecated since 6.4. Use the `getEntityClass` method instead.
-     *
-     * Return current entity name.
-     *
-     * @return string
-     */
-    public function getEntityName()
-    {
-        trigger_deprecation('kunstmaan/article-bundle', '6.4', 'Method "%s" deprecated and will be removed in 7.0. Use the "getEntityClass" method instead.', __METHOD__);
-
-        return 'AbstractArticleAuthor';
-    }
-
     public function getEntityClass(): string
     {
         return AbstractAuthor::class;

diff --git a/src/Kunstmaan/ArticleBundle/AdminList/AbstractArticleCategoryAdminListConfigurator.php b/src/Kunstmaan/ArticleBundle/AdminList/AbstractArticleCategoryAdminListConfigurator.php
@@ -19,34 +19,6 @@ public function __construct(EntityManagerInterface $em, AclHelper $aclHelper)
         parent::__construct($em, $aclHelper);
     }
 
-    /**
-     * @deprecated since 6.4. Use the `getEntityClass` method instead.
-     *
-     * Return current bundle name.
-     *
-     * @return string
-     */
-    public function getBundleName()
-    {
-        trigger_deprecation('kunstmaan/article-bundle', '6.4', 'Method "%s" deprecated and will be removed in 7.0. Use the "getEntityClass" method instead.', __METHOD__);
-
-        return 'KunstmaanArticleBundle';
-    }
-
-    /**
-     * @deprecated since 6.4. Use the `getEntityClass` method instead.
-     *
-     * Return current entity name.
-     *
-     * @return string
-     */
-    public function getEntityName()
-    {
-        trigger_deprecation('kunstmaan/article-bundle', '6.4', 'Method "%s" deprecated and will be removed in 7.0. Use the "getEntityClass" method instead.', __METHOD__);
-
-        return 'AbstractArticleCategory';
-    }
-
     public function getEntityClass(): string
     {
         return AbstractCategory::class;

diff --git a/src/Kunstmaan/ArticleBundle/AdminList/AbstractArticlePageAdminListConfigurator.php b/src/Kunstmaan/ArticleBundle/AdminList/AbstractArticlePageAdminListConfigurator.php
@@ -43,34 +43,6 @@ public function __construct(EntityManagerInterface $em, AclHelper $aclHelper, $l
         );
     }
 
-    /**
-     * @deprecated since 6.4. Use the `getEntityClass` method instead.
-     *
-     * Return current bundle name.
-     *
-     * @return string
-     */
-    public function getBundleName()
-    {
-        trigger_deprecation('kunstmaan/article-bundle', '6.4', 'Method "%s" deprecated and will be removed in 7.0. Use the "getEntityClass" method instead.', __METHOD__);
-
-        return 'KunstmaanArticleBundle';
-    }
-
-    /**
-     * @deprecated since 6.4. Use the `getEntityClass` method instead.
-     *
-     * Return current entity name.
-     *
-     * @return string
-     */
-    public function getEntityName()
-    {
-        trigger_deprecation('kunstmaan/article-bundle', '6.4', 'Method "%s" deprecated and will be removed in 7.0. Use the "getEntityClass" method instead.', __METHOD__);
-
-        return 'AbstractArticlePage';
-    }
-
     public function getEntityClass(): string
     {
         return AbstractArticlePage::class;