Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[AllBundles] Migration path for controller extending deprecated controller class #2946

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions UPGRADE-5.9.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,66 @@ 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\ExceptionController
* Kunstmaan\AdminBundle\Controller\ModulesController
* Kunstmaan\AdminBundle\Controller\SettingsController
* Kunstmaan\AdminListBundle\Controller\EntityLockCheckController
* Kunstmaan\CacheBundle\Controller\VarnishController
* Kunstmaan\ConfigBundle\Controller\ConfigController
* Kunstmaan\DashboardBundle\Controller\DashboardController
* Kunstmaan\DashboardBundle\Controller\GoogleAnalyticsAJAXController
* Kunstmaan\DashboardBundle\Controller\GoogleAnalyticsController
* Kunstmaan\FormBundle\Controller\FormSubmissionsController
* Kunstmaan\LeadGenerationBundle\Controller\PopupsAdminListController
* Kunstmaan\LeadGenerationBundle\Controller\RulesAdminListController
* Kunstmaan\MediaBundle\Controller\ChooserController
* Kunstmaan\MediaBundle\Controller\FolderController
* Kunstmaan\MediaBundle\Controller\IconFontController
* Kunstmaan\MediaBundle\Controller\MediaController
* Kunstmaan\MenuBundle\Controller\MenuAdminListController
* Kunstmaan\MenuBundle\Controller\MenuItemAdminListController
* Kunstmaan\MultiDomainBundle\Controller\SiteSwitchController
* Kunstmaan\NodeBundle\Controller\NodeAdminController
* Kunstmaan\NodeBundle\Controller\SlugController
* Kunstmaan\NodeBundle\Controller\UrlReplaceController
* Kunstmaan\NodeBundle\Controller\WidgetsController
* Kunstmaan\PagePartBundle\Controller\PagePartAdminController
* Kunstmaan\RedirectBundle\Controller\RedirectAdminListController
* Kunstmaan\SeoBundle\Controller\Admin\SettingsController
* Kunstmaan\SeoBundle\Controller\RobotsController
* Kunstmaan\SitemapBundle\Controller\SitemapController
* Kunstmaan\TaggingBundle\Controller\TagAdminListController
* Kunstmaan\TranslatorBundle\Controller\TranslatorCommandController
* Kunstmaan\TranslatorBundle\Controller\TranslatorController
* Kunstmaan\UserManagementBundle\Controller\GroupsController
* Kunstmaan\UserManagementBundle\Controller\RolesController
* Kunstmaan\UserManagementBundle\Controller\UsersController
* Kunstmaan\VotingBundle\Controller\VotingController

#### 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`.
If you use symfony 3.4 make sure to register the controller extending `Kunstmaan\AdminListBundle\Controller\AbstractAdminListController` as a service and add the `container.service_subscriber` tag.

#### 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
------------

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
}
2 changes: 2 additions & 0 deletions src/Kunstmaan/AdminBundle/Controller/DefaultController.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
3 changes: 3 additions & 0 deletions src/Kunstmaan/AdminBundle/Controller/ExceptionController.php
Original file line number Diff line number Diff line change
Expand Up @@ -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 */
Expand Down
2 changes: 2 additions & 0 deletions src/Kunstmaan/AdminBundle/Controller/ModulesController.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@

/**
* The modules home controller
*
* @final since 5.9
*/
class ModulesController extends Controller
{
Expand Down
2 changes: 2 additions & 0 deletions src/Kunstmaan/AdminBundle/Controller/SettingsController.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@

/**
* Main settings controller
*
* @final since 5.9
*/
class SettingsController extends BaseSettingsController
{
Expand Down
Loading