UPGRADE-4.4.md

UPGRADE FROM 4.3 to 4.4

Cache

• Added argument $prefix to AdapterInterface::clear()

Debug

• Deprecated the Debug class, use the one from the ErrorRenderer component instead
• Deprecated the FlattenException class, use the one from the ErrorRenderer component instead
• Deprecated the component in favor of the ErrorHandler component

DependencyInjection

• Deprecated support for short factories and short configurators in Yaml

  Before:

  services:
    my_service:
      factory: factory_service:method

  After:

  services:
    my_service:
      factory: ['@factory_service', method]

• Deprecated tagged in favor of tagged_iterator

  Before:

  services:
      App\Handler:
          tags: ['app.handler']
  
      App\HandlerCollection:
          arguments: [!tagged app.handler]

  After:

  services:
      App\Handler:
      tags: ['app.handler']
  
  App\HandlerCollection:
      arguments: [!tagged_iterator app.handler]

• Passing an instance of Symfony\Component\DependencyInjection\Parameter as class name to Symfony\Component\DependencyInjection\Definition is deprecated.

  Before:

  new Definition(new Parameter('my_class'));

  After:

  new Definition('%my_class%');

DoctrineBridge

• Deprecated injecting ClassMetadataFactory in DoctrineExtractor, an instance of EntityManagerInterface should be injected instead.
• Deprecated passing an IdReader to the DoctrineChoiceLoader when the query cannot be optimized with single id field.
• Deprecated not passing an IdReader to the DoctrineChoiceLoader when the query can be optimized with single id field.
• Deprecated RegistryInterface, use Doctrine\Common\Persistence\ManagerRegistry.

Filesystem

• Support for passing a null value to Filesystem::isAbsolutePath() is deprecated.

Form

• Using different values for the "model_timezone" and "view_timezone" options of the TimeType without configuring a reference date is deprecated.
• Using int or float as data for the NumberType when the input option is set to string is deprecated.
• Overriding the methods FormIntegrationTestCase::setUp(), TypeTestCase::setUp() and TypeTestCase::tearDown() without the void return-type is deprecated.

FrameworkBundle

• Deprecated booting the kernel before running WebTestCase::createClient().
• Deprecated support for templating engine in TemplateController, use Twig instead
• The $parser argument of ControllerResolver::__construct() and DelegatingLoader::__construct() has been deprecated.
• The ControllerResolver and DelegatingLoader classes have been marked as final.
• The controller_name_converter and resolve_controller_name_subscriber services have been deprecated.
• Deprecated routing.loader.service, use routing.loader.container instead.
• Not tagging service route loaders with routing.route_loader has been deprecated.
• Overriding the methods KernelTestCase::tearDown() and WebTestCase::tearDown() without the void return-type is deprecated.

HttpClient

• Added method cancel() to ResponseInterface

HttpFoundation

• ApacheRequest is deprecated, use Request class instead.
• Passing a third argument to HeaderBag::get() is deprecated since Symfony 4.4, use method all() instead

HttpKernel

• The DebugHandlersListener class has been marked as final

• Added new Bundle directory convention consistent with standard skeletons:

  └── MyBundle/
      ├── config/
      ├── public/
      ├── src/
      │   └── MyBundle.php
      ├── templates/
      └── translations/

  To make this work properly, it is necessary to change the root path of the bundle:

  class MyBundle extends Bundle
  {
      public function getPath(): string
      {
          return \dirname(__DIR__);
      }
  }

  As many bundles must be compatible with a range of Symfony versions, the current directory convention is not deprecated yet, but it will be in the future.

Lock

• Deprecated Symfony\Component\Lock\StoreInterface in favor of Symfony\Component\Lock\BlockingStoreInterface and Symfony\Component\Lock\PersistingStoreInterface.
• Factory is deprecated, use LockFactory instead

Messenger

• Deprecated passing a ContainerInterface instance as first argument of the ConsumeMessagesCommand constructor, pass a RoutableMessageBus instance instead.

MonologBridge

• The RouteProcessor has been marked final.

Process

• Deprecated the Process::inheritEnvironmentVariables() method: env variables are always inherited.

PropertyAccess

• Deprecated passing null as 2nd argument of PropertyAccessor::createCache() method ($defaultLifetime), pass 0 instead.

Routing

• Deprecated ServiceRouterLoader in favor of ContainerLoader.
• Deprecated ObjectRouteLoader in favor of ObjectLoader.

Security

• The LdapUserProvider class has been deprecated, use Symfony\Component\Ldap\Security\LdapUserProvider instead.
• Implementations of PasswordEncoderInterface and UserPasswordEncoderInterface should add a new needsRehash() method

Stopwatch

• Deprecated passing null as 1st ($id) argument of Section::get() method, pass a valid child section identifier instead.

TwigBridge

• Deprecated to pass $rootDir and $fileLinkFormatter as 5th and 6th argument respectively to the DebugCommand::__construct() method, swap the variables position.

TwigBundle

• Deprecated default value twig.controller.exception::showAction of the twig.exception_controller configuration option, set it to null instead. This will also change the default error response format according to https://tools.ietf.org/html/rfc7807 for json, xml, atom and txt formats:

  Before:

  { 
      "error": { 
          "code": 404, 
          "message": "Sorry, the page you are looking for could not be found" 
      } 
  }

  After:

  { 
      "title": "Not Found",
      "status": 404, 
      "detail": "Sorry, the page you are looking for could not be found"
  }

• Deprecated the ExceptionController and all built-in error templates, use the error renderer mechanism of the ErrorRenderer component

• Deprecated loading custom error templates in non-html formats. Custom HTML error pages based on Twig keep working as before:

  Before (templates/bundles/TwigBundle/Exception/error.jsonld.twig):

  { 
    "@id": "https://example.com",
    "@type": "error",
    "@context": {
        "title": "{{ status_text }}",
        "code": {{ status_code }},
        "message": "{{ exception.message }}"
    }
  }

  After (App\ErrorRenderer\JsonLdErrorRenderer):

  class JsonLdErrorRenderer implements ErrorRendererInterface
  {
    public static function getFormat(): string
    {
        return 'jsonld';
    }
  
    public function render(FlattenException $exception): string
    {
        return json_encode([
            '@id' => 'https://example.com',
            '@type' => 'error',
            '@context' => [
                'title' => $exception->getTitle(),
                'code' => $exception->getStatusCode(),
                'message' => $exception->getMessage(),
            ],
        ]);
    }
  }

Configure your rendering service tagging it with error_renderer.renderer.

Validator

• Deprecated passing an ExpressionLanguage instance as the second argument of ExpressionValidator::__construct().
• Deprecated using anything else than a string as the code of a ConstraintViolation, a string type-hint will be added to the constructor of the ConstraintViolation class and to the ConstraintViolationBuilder::setCode() method in 5.0.
• Deprecated passing an ExpressionLanguage instance as the second argument of ExpressionValidator::__construct(). Pass it as the first argument instead.
• The Length constraint expects the allowEmptyString option to be defined when the min option is used. Set it to true to keep the current behavior and false to reject empty strings. In 5.0, it'll become optional and will default to false.
• Overriding the methods ConstraintValidatorTestCase::setUp() and ConstraintValidatorTestCase::tearDown() without the void return-type is deprecated.

WebProfilerBundle

• Deprecated the ExceptionController class in favor of ExceptionErrorController
• Deprecated the TemplateManager::templateExists() method

WebServerBundle

• The bundle is deprecated and will be removed in 5.0.