[AllBundle] Prepare migration path for Controller base class deprecat…

…ions
Kunstmaan · Sep 24, 2021 · 3d2b84f · 3d2b84f
1 parent 6a7d41d
commit 3d2b84f
Show file tree

Hide file tree

Showing 42 changed files with 738 additions and 12 deletions.
diff --git a/UPGRADE-5.9.md b/UPGRADE-5.9.md
@@ -12,6 +12,65 @@ General
 * The abandoned package `fzaninotto/faker` is replaced with the `fakerphp/faker` package. If you use the abandoned package
   in your project, replace it with `fakerphp/faker` to allow upgrading to v5.9.
 
+### Controllers
+
+Controllers are changing their base class in 6.0 so there a specific changes applied to a set of controllers
+
+#### Final
+
+These controllers are marked as final and will be registered as services in 6.0.
+
+* Kunstmaan\AdminBundle\Controller\DefaultController
+* Kunstmaan\AdminBundle\Controller\ModulesController
+* Kunstmaan\AdminListBundle\Controller\EntityLockCheckController
+* Kunstmaan\CacheBundle\Controller\VarnishController
+* Kunstmaan\DashboardBundle\Controller\DashboardController
+* Kunstmaan\DashboardBundle\Controller\GoogleAnalyticsAJAXController
+* Kunstmaan\DashboardBundle\Controller\GoogleAnalyticsController
+* Kunstmaan\FormBundle\Controller\FormSubmissionsController
+* Kunstmaan\MediaBundle\Controller\ChooserController
+* Kunstmaan\MediaBundle\Controller\FolderController
+* Kunstmaan\MediaBundle\Controller\IconFontController
+* Kunstmaan\MediaBundle\Controller\MediaController
+* Kunstmaan\MultiDomainBundle\Controller\SiteSwitchController
+* Kunstmaan\NodeBundle\Controller\NodeAdminController
+* Kunstmaan\NodeBundle\Controller\SlugController
+* Kunstmaan\NodeBundle\Controller\WidgetsController
+* Kunstmaan\PagePartBundle\Controller\PagePartAdminController
+* Kunstmaan\SeoBundle\Controller\RobotsController
+* Kunstmaan\SitemapBundle\Controller\SitemapController
+* Kunstmaan\TranslatorBundle\Controller\TranslatorCommandController
+* Kunstmaan\VotingBundle\Controller\VotingController
+* Kunstmaan\AdminBundle\Controller\ExceptionController
+* Kunstmaan\LeadGenerationBundle\Controller\PopupsAdminListController
+* Kunstmaan\MenuBundle\Controller\MenuAdminListController
+* Kunstmaan\MenuBundle\Controller\MenuItemAdminListController
+* Kunstmaan\RedirectBundle\Controller\RedirectAdminListController
+* Kunstmaan\LeadGenerationBundle\Controller\RulesAdminListController
+* Kunstmaan\TaggingBundle\Controller\TagAdminListController
+* Kunstmaan\TranslatorBundle\Controller\TranslatorController
+* Kunstmaan\AdminBundle\Controller\SettingsController
+* Kunstmaan\ConfigBundle\Controller\ConfigController
+* Kunstmaan\NodeBundle\Controller\UrlReplaceController
+* Kunstmaan\SeoBundle\Controller\Admin\SettingsController
+* Kunstmaan\UserManagementBundle\Controller\UsersController
+* Kunstmaan\UserManagementBundle\Controller\GroupsController
+* Kunstmaan\UserManagementBundle\Controller\RolesController
+
+#### Deprecated
+
+* Kunstmaan\AdminBundle\Controller\BaseSettingsController is deprecated with no replacement.
+* Kunstmaan\AdminListBundle\Controller\AdminListController is deprecated and replaced by Kunstmaan\AdminListBundle\Controller\AbstractAdminListController. There are
+  no changes in available methods except that the class now extends from `Symfony\Bundle\FrameworkBundle\Controller\AbstractController`.
+
+#### Base class switched to AbstractController
+
+These controllers will switch their base class to `Symfony\Bundle\FrameworkBundle\Controller\AbstractController`, inject 
+services you need in your controllers and make sure the controllers are registered as services.
+
+* Kunstmaan\LeadGenerationBundle\Controller\AbstractNewsletterController
+* Kunstmaan\LeadGenerationBundle\Controller\AbstractRedirectController
+
 AdminBundle
 ------------
 

diff --git a/src/Kunstmaan/AdminBundle/Controller/BaseSettingsController.php b/src/Kunstmaan/AdminBundle/Controller/BaseSettingsController.php
@@ -4,6 +4,9 @@
 
 use Symfony\Bundle\FrameworkBundle\Controller\Controller;
 
+/**
+ * @deprecated since KunstmaanAdminBundle 5.9 and will be removed in KunstmaanAdminBundle 6.0.
+ */
 class BaseSettingsController extends Controller
 {
 }
diff --git a/src/Kunstmaan/AdminBundle/Controller/DefaultController.php b/src/Kunstmaan/AdminBundle/Controller/DefaultController.php
@@ -14,6 +14,8 @@
 
 /**
  * The default controller is used to render the main screen the users see when they log in to the admin
+ *
+ * @final since 5.9
  */
 class DefaultController extends Controller
 {

diff --git a/src/Kunstmaan/AdminBundle/Controller/ExceptionController.php b/src/Kunstmaan/AdminBundle/Controller/ExceptionController.php
@@ -10,6 +10,9 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\Routing\Annotation\Route;
 
+/**
+ * @final since 5.9
+ */
 class ExceptionController extends AdminListController
 {
     /** @var ExceptionAdminListConfigurator */

diff --git a/src/Kunstmaan/AdminBundle/Controller/ModulesController.php b/src/Kunstmaan/AdminBundle/Controller/ModulesController.php
@@ -8,6 +8,8 @@
 
 /**
  * The modules home controller
+ *
+ * @final since 5.9
  */
 class ModulesController extends Controller
 {

diff --git a/src/Kunstmaan/AdminBundle/Controller/SettingsController.php b/src/Kunstmaan/AdminBundle/Controller/SettingsController.php
@@ -8,6 +8,8 @@
 
 /**
  * Main settings controller
+ *
+ * @final since 5.9
  */
 class SettingsController extends BaseSettingsController
 {