Skip to content

Latest commit

 

History

History
243 lines (188 loc) · 10.6 KB

UPGRADE-5.9.md

File metadata and controls

243 lines (188 loc) · 10.6 KB
Raw

UPGRADE FROM 5.8 to 5.9

General

  • All event classes are marked as final.
  • If you still require the kunstmaan/bundles-cms package, update you composer.json to require babdev/pagerfanta-bundle instead of white-october/pagerfanta-bundle. All specific bundle packages that use pagerfanta functionality are now requiring the specifc pagerfanta packages. Newer skeleton installs will require the correct pagerfanta bundle package but old projects or projects using the white-october package are encouraged to switch their dependencies.
  • 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

  • The kunstmaan_admin.admin_exception_excludes option is deprecated. Use kunstmaan_admin.exception_logging.exclude_patterns instead.
  • Exception logging in by the cms (and the linked exception module) can now be disabled with kunstmaan_admin.exception_logging: false or kunstmaan_admin.exception_logging.enabled: false.
  • Using FosUserBundle as the authentication system for the cms login is deprecated and usages will be removed in 6.0. Use the replacement authentication system instead. To enable the new authentication (and disable any FosUserBundle usages) set the kunstmaan_admin.authentication.enable_new_authentication config to true (this option will always default to true in 6.0).

If you previously did an override of the user or group class, your config should be updated.

From:

fos_user:
    user_class: App\Entity\User
    group_class: App\Entity\Group

To:

kunstmaan_admin:
    authentication:
        user_class: App\Entity\User
        group_class: App\Entity\Group

Your security.yaml will also need an update after enabling the new authentication system. Adapt your config according to the following example, which is the default security.yaml that ships with a new installation.

security:
    encoders:
        Kunstmaan\AdminBundle\Entity\UserInterface: bcrypt
    ...

    providers:
        cms_users:
          entity: { class: Kunstmaan\AdminBundle\Entity\User, property: username }

    firewalls:
        main:
            pattern: .*
            form_login:
                login_path: kunstmaan_admin_login
                check_path: kunstmaan_admin_login
                provider: cms_users
            logout:
                path: kunstmaan_admin_logout
                target: KunstmaanAdminBundle_homepage
            ...

    access_control:
        ...
        - { path: ^/([^/]*)/admin/reset.*, role: IS_AUTHENTICATED_ANONYMOUSLY }
        ...
  • The constructor arguments of Kunstmaan\AdminBundle\Helper\VersionCheck\VersionChecker have changed, inject the correct/required services/parameters.

AdminlistBundle

  • Using the setObjectManager, setThreshold and setLockEnabled methods of Kunstmaan\AdminListBundle\Service\EntityVersionLockService is deprecated, use the constructor to inject the required values instead.

DashboardBundle

  • Passing a command classname for the "$command" argument in Kunstmaan\DashboardBundle\Widget\DashboardWidget::__construct is deprecated and will not be allowed 6.0. Pass a command name instead.
  • Using the kunstmaan_dashboard.widget.googleanalytics.command parameter to modify the kunstmaan_dashboard.widget.googleanalytics service is deprecated and the parameter will be removed in 6.0. Use service decoration or a service alias instead.
  • Not passing a value for the $configHelper or $queryHelper parameters in Kunstmaan\DashboardBundle\Command\GoogleAnalyticsDataCollectCommand::__construct is deprecated and the parameters will be required. Inject the required services instead.

GeneratorBundle

  • The "kuma:generate:bundle" command and related classes is deprecated and will be removed in 6.0
  • The "kuma:generate:entity" command and related classes is deprecated and will be removed in 6.0, use the "make:entity" command of the symfony/maker-bundle.

NodeBundle

  • Kunstmaan\NodeBundle\Controller\SlugActionInterface is deprecated and will be removed in 6.0. Implement the Kunstmaan\NodeBundle\Entity\CustomViewDataProviderInterface interface on your page entity and provide page render service id. That service should implement Kunstmaan\NodeBundle\Entity\PageViewDataProviderInterface and will allow you to customize the twig view and variables.

Before:

<?php

use Kunstmaan\NodeBundle\Controller\SlugActionInterface
use Kunstmaan\NodeBundle\Entity\AbstractPage

class BlogOverviewPage extends AbstractPage implements SlugActionInterface
{
    // ...
    public function getControllerAction()
    {
        return 'App\Controller\BlogOverviewController::serviceAction';
    }

}

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;

class BlogOverviewController extends AbstractController
{
    public function serviceAction(){
        // Custom render logic
    }

}

After:

<?php

use App\PageRenderer\BlogOverviewPageRenderer;
use Kunstmaan\NodeBundle\Entity\AbstractPage
use Kunstmaan\NodeBundle\Entity\CustomViewDataProviderInterface

class BlogOverviewPage extends AbstractPage implements CustomViewDataProviderInterface
{
    // ...
    public function getViewDataProviderServiceId(): string
    {
        return BlogOverviewPageRenderer::class;
    }

}

use Kunstmaan\NodeBundle\Entity\PageViewDataProviderInterface;
use Kunstmaan\NodeBundle\Helper\RenderContext;
use Symfony\Component\HttpFoundation\RedirectResponse;

class BlogOverviewPageViewDataProvider implements PageViewDataProviderInterface
{
    public function provideViewData(RenderContext $renderContext): void
    {
        // Set a variable to be used in the twig template
        $renderContext['custom_var'] = 'text';

        // Or return a response and stop the twig render
        $renderContext->setResponse(new RedirectResponse('/'));
    }
}
  • Not passing the "translator" service as the 6th argument of Kunstmaan\NodeBundle\Helper\NodeAdmin\NodeAdminPublisher::__construct is deprecated and will be required in KunstmaanNodeBundle 6.0. Injected the required service in the constructor.
  • Kunstmaan\NodeBundle\Helper\NodeAdmin\NodeAdminPublisher::chooseHowToPublish is deprecated and replaced by Kunstmaan\NodeBundle\Helper\NodeAdmin\NodeAdminPublisher::handlePublish
  • Kunstmaan\NodeBundle\Helper\NodeAdmin\NodeAdminPublisher::chooseHowToUnpublish is deprecated and replaced by Kunstmaan\NodeBundle\Helper\NodeAdmin\NodeAdminPublisher::handleUnpublish

NodeSearchBundle

  • Instantiating the Kunstmaan\NodeSearchBundle\Entity\AbstractSearchPage class is deprecated and will be made abstract. Extend your implementation from this class instead.

RedirectBundle

  • Overriding the redirect entity class with kunstmaan_redirect.redirect.class is deprecated, use the kunstmaan_redirect.redirect_entity config instead.

UserManagementBundle

  • Overriding the user adminlist configurator class with kunstmaan_user_management.user_admin_list_configurator.class is deprecated, use the kunstmaan_user_management.user.adminlist_configurator config instead.

MediaBundle

  • Not passing a value for the "$mediaPath" parameter of "\Kunstmaan\MediaBundle\Helper\File\FileHelper::__construct" is deprecated, a value will be required.