Skip to content

Latest commit

 

History

History
704 lines (496 loc) · 21.9 KB

UPGRADE-4.0.md

File metadata and controls

704 lines (496 loc) · 21.9 KB
Raw

UPGRADE FROM 3.x to 4.0

ClassLoader

  • The component has been removed. Use Composer instead.

Console

  • Setting unknown style options is not supported anymore and throws an exception.

  • The QuestionHelper::setInputStream() method is removed. Use StreamableInputInterface::setStream() or CommandTester::setInputs() instead.

    Before:

    $input = new ArrayInput();

$questionHelper->setInputStream($stream);
$questionHelper->ask($input, $output, $question);

    After:

    $input = new ArrayInput();
$input->setStream($stream);

$questionHelper->ask($input, $output, $question);

    Before:

    $commandTester = new CommandTester($command);

$stream = fopen('php://memory', 'r+', false);
fputs($stream, "AppBundle\nYes");
rewind($stream);

$command->getHelper('question')->setInputStream($stream);

$commandTester->execute();

    After:

    $commandTester = new CommandTester($command);

$commandTester->setInputs(array('AppBundle', 'Yes'));

$commandTester->execute();

  • The console.exception event and the related ConsoleExceptionEvent class have been removed in favor of the console.error event and the ConsoleErrorEvent class.

Debug

  • The ContextErrorException class has been removed. Use \ErrorException instead.

  • FlattenException::getTrace() now returns additional type descriptions integer and float.

DependencyInjection

  • Autowiring services based on the types they implement is not supported anymore. Rename (or alias) your services to their FQCN id to make them autowirable.

  • _defaults and _instanceof are now reserved service names in Yaml configurations. Please rename any services with that names.

  • Non-numeric keys in methods and constructors arguments have never been supported and are now forbidden. Please remove them if you happen to have one.

  • Service names that start with an underscore are now reserved in Yaml files. Please rename any services with such names.

  • Autowiring-types have been removed, use aliases instead.

    Before:

    <service id="annotations.reader" class="Doctrine\Common\Annotations\AnnotationReader" public="false">
    <autowiring-type>Doctrine\Common\Annotations\Reader</autowiring-type>
</service>

    After:

    <service id="annotations.reader" class="Doctrine\Common\Annotations\AnnotationReader" public="false" />
<service id="Doctrine\Common\Annotations\Reader" alias="annotations.reader" public="false" />

  • Service identifiers are now case sensitive.

  • The Reference and Alias classes do not make service identifiers lowercase anymore.

  • Using the PhpDumper with an uncompiled ContainerBuilder is not supported anymore.

  • Extending the containers generated by PhpDumper is not supported anymore.

  • The DefinitionDecorator class has been removed. Use the ChildDefinition class instead.

  • Using unsupported configuration keys in YAML configuration files raises an exception.

  • Using unsupported options to configure service aliases raises an exception.

  • Setting or unsetting a private service with the Container::set() method is no longer supported. Only public services can be set or unset.

  • Checking the existence of a private service with the Container::has() method is no longer supported and will return false.

  • Requesting a private service with the Container::get() method is no longer supported.

  • The strict attribute in service arguments has been removed. The attribute is ignored since 3.0, so you can simply remove it.

  • Top-level anonymous services in XML are no longer supported.

EventDispatcher

  • The ContainerAwareEventDispatcher class has been removed. Use EventDispatcher with closure factories instead.

ExpressionLanguage

  • The ability to pass a ParserCacheInterface instance to the ExpressionLanguage class has been removed. You should use the CacheItemPoolInterface interface instead.

Finder

  • The ExceptionInterface has been removed.
  • The Symfony\Component\Finder\Iterator\FilterIterator class has been removed as it used to fix a bug which existed before version 5.5.23/5.6.7

Form

  • The choices_as_values option of the ChoiceType has been removed.

  • Support for data objects that implements both Traversable and ArrayAccess in ResizeFormListener::preSubmit method has been removed.

  • Using callable strings as choice options in ChoiceType is not supported anymore in favor of passing PropertyPath instances.

    Before:

    'choice_value' => new PropertyPath('range'),
'choice_label' => 'strtoupper',

    After:

    'choice_value' => 'range',
'choice_label' => function ($choice) {
    return strtoupper($choice);
},

  • Caching of the loaded ChoiceListInterface in the LazyChoiceList has been removed, it must be cached in the ChoiceLoaderInterface implementation instead.

  • Calling isValid() on a Form instance before submitting it is not supported anymore and raises an exception.

    Before:

    if ($form->isValid()) {
    // ...
}

    After:

    if ($form->isSubmitted() && $form->isValid()) {
    // ...
}

  • Using the "choices" option in CountryType, CurrencyType, LanguageType, LocaleType, and TimezoneType without overriding the choice_loader option is now ignored.

    Before:

    $builder->add('custom_locales', LocaleType::class, array(
    'choices' => $availableLocales,
));

    After:

    $builder->add('custom_locales', LocaleType::class, array(
    'choices' => $availableLocales,
    'choice_loader' => null,
));
// or
$builder->add('custom_locales', LocaleType::class, array(
    'choice_loader' => new CallbackChoiceLoader(function () {
        return $this->getAvailableLocales();
    }),
));

FrameworkBundle

  • The validator.mapping.cache.doctrine.apc service has been removed.

  • The cache:clear command does not warmup the cache anymore. Warmup should be done via the cache:warmup command.

  • The "framework.trusted_proxies" configuration option and the corresponding "kernel.trusted_proxies" parameter have been removed. Use the Request::setTrustedProxies() method in your front controller instead.

  • The default value of the framework.workflows.[name].type configuration options is now state_machine.

  • Support for absolute template paths has been removed.

  • The following form types registered as services have been removed; use their fully-qualified class name instead:

    • "form.type.birthday"
    • "form.type.checkbox"
    • "form.type.collection"
    • "form.type.country"
    • "form.type.currency"
    • "form.type.date"
    • "form.type.datetime"
    • "form.type.email"
    • "form.type.file"
    • "form.type.hidden"
    • "form.type.integer"
    • "form.type.language"
    • "form.type.locale"
    • "form.type.money"
    • "form.type.number"
    • "form.type.password"
    • "form.type.percent"
    • "form.type.radio"
    • "form.type.range"
    • "form.type.repeated"
    • "form.type.search"
    • "form.type.textarea"
    • "form.type.text"
    • "form.type.time"
    • "form.type.timezone"
    • "form.type.url"
    • "form.type.button"
    • "form.type.submit"
    • "form.type.reset"

  • The framework.serializer.cache option and the services serializer.mapping.cache.apc and serializer.mapping.cache.doctrine.apc have been removed. APCu should now be automatically used when available.

  • The Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\CompilerDebugDumpPass has been removed.

  • The Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\AddConsoleCommandPass has been removed. Use Symfony\Component\Console\DependencyInjection\AddConsoleCommandPass instead.

  • The Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\SerializerPass class has been removed. Use the Symfony\Component\Serializer\DependencyInjection\SerializerPass class instead.

  • The Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\FormPass class has been removed. Use the Symfony\Component\Form\DependencyInjection\FormPass class instead.

  • The Symfony\Bundle\FrameworkBundle\EventListener\SessionListener class has been removed. Use the Symfony\Component\HttpKernel\EventListener\SessionListener class instead.

  • The Symfony\Bundle\FrameworkBundle\EventListener\TestSessionListener class has been removed. Use the Symfony\Component\HttpKernel\EventListener\TestSessionListener class instead.

  • The Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\ConfigCachePass class has been removed. Use Symfony\Component\Config\DependencyInjection\ConfigCachePass class instead.

  • The Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\PropertyInfoPass class has been removed. Use the Symfony\Component\PropertyInfo\DependencyInjection\PropertyInfoPass class instead.

  • Class parameters related to routing have been removed

    • router.options.generator_class
    • router.options.generator_base_class
    • router.options.generator_dumper_class
    • router.options.matcher_class
    • router.options.matcher_base_class
    • router.options.matcher_dumper_class
    • router.options.matcher.cache_class
    • router.options.generator.cache_class

  • The Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\ControllerArgumentValueResolverPass class has been removed. Use the Symfony\Component\HttpKernel\DependencyInjection\ControllerArgumentValueResolverPass class instead.

  • The Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\RoutingResolverPass class has been removed. Use the Symfony\Component\Routing\DependencyInjection\RoutingResolverPass class instead.

  • The Symfony\Bundle\FrameworkBundle\Translation\Translator constructor now takes the default locale as mandatory 3rd argument.

  • The Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\AddValidatorInitializersPass class has been removed. Use the Symfony\Component\Validator\DependencyInjection\AddValidatorInitializersPass class instead.

  • The Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\AddConstraintValidatorsPass class has been removed. Use the Symfony\Component\Validator\DependencyInjection\AddConstraintValidatorsPass class instead.

  • The Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\ValidateWorkflowsPass class has been removed. Use the Symfony\Component\Workflow\DependencyInjection\ValidateWorkflowsPass class instead.

  • Using the KERNEL_DIR environment variable and the automatic guessing based on the phpunit.xml file location have been removed from the KernelTestCase::getKernelClass() method implementation. Set the KERNEL_CLASS environment variable to the fully-qualified class name of your Kernel or override the KernelTestCase::createKernel() or KernelTestCase::getKernelClass() method instead.

  • The methods KernelTestCase::getPhpUnitXmlDir() and KernelTestCase::getPhpUnitCliConfigArgument() have been removed.

  • The Symfony\Bundle\FrameworkBundle\Validator\ConstraintValidatorFactory class has been removed. Use Symfony\Component\Validator\ContainerConstraintValidatorFactory instead.

  • The --no-prefix option of the translation:update command has been removed.

HttpFoundation

  • The Request::setTrustedProxies() method takes a new $trustedHeaderSet argument. See http://symfony.com/doc/current/components/http_foundation/trusting_proxies.html for more info.

  • The Request::setTrustedHeaderName() and Request::getTrustedHeaderName() methods have been removed.

  • Extending the following methods of Response is no longer possible (these methods are now final):

    • setDate/getDate
    • setExpires/getExpires
    • setLastModified/getLastModified
    • setProtocolVersion/getProtocolVersion
    • setStatusCode/getStatusCode
    • setCharset/getCharset
    • setPrivate/setPublic
    • getAge
    • getMaxAge/setMaxAge
    • setSharedMaxAge
    • getTtl/setTtl
    • setClientTtl
    • getEtag/setEtag
    • hasVary/getVary/setVary
    • isInvalid/isSuccessful/isRedirection/isClientError/isServerError
    • isOk/isForbidden/isNotFound/isRedirect/isEmpty

  • The ability to check only for cacheable HTTP methods using Request::isMethodSafe() is not supported anymore, use Request::isMethodCacheable() instead.

HttpKernel

  • Removed the kernel.root_dir parameter. Use the kernel.project_dir parameter instead.

  • Removed the Kernel::getRootDir() method. Use the Kernel::getProjectDir() method instead.

  • The Extension::addClassesToCompile() and Extension::getClassesToCompile() methods have been removed.

  • Possibility to pass non-scalar values as URI attributes to the ESI and SSI renderers has been removed. The inline fragment renderer should be used with non-scalar attributes.

  • The ControllerResolver::getArguments() method has been removed. If you have your own ControllerResolverInterface implementation, you should inject an ArgumentResolverInterface instance.

  • The DataCollector::varToString() method has been removed in favor of cloneVar().

  • The Psr6CacheClearer::addPool() method has been removed. Pass an array of pools indexed by name to the constructor instead.

  • The LazyLoadingFragmentHandler::addRendererService() method has been removed.

  • The X-Status-Code header method of setting a custom status code in the response when handling exceptions has been removed. There is now a new GetResponseForExceptionEvent::allowCustomResponseCode() method instead, which will tell the Kernel to use the response code set on the event's response object.

  • The Kernel::getEnvParameters() method has been removed.

  • The SYMFONY__ environment variables are no longer processed automatically by Symfony. Use the %env()% syntax to get the value of any environment variable from configuration files instead.

Ldap

  • The RenameEntryInterface has been deprecated, and merged with EntryManagerInterface

Process

  • The Symfony\Component\Process\ProcessBuilder class has been removed, use the Symfony\Component\Process\Process class directly instead.

  • The ProcessUtils::escapeArgument() method has been removed, use a command line array or give env vars to the Process::start/run() method instead.

  • Environment variables are always inherited in sub-processes.

  • Configuring proc_open() options has been removed.

  • Configuring Windows and sigchild compatibility is not possible anymore - they are always enabled.

  • Extending Process::run(), Process::mustRun() and Process::restart() is not supported anymore.

ProxyManager

  • The ProxyDumper class has been made final

Security

  • The RoleInterface has been removed. Extend the Symfony\Component\Security\Core\Role\Role class instead.

  • The LogoutUrlGenerator::registerListener() method expects a 6th string $context = null argument.

  • The AccessDecisionManager::setVoters() method has been removed. Pass the voters to the constructor instead.

SecurityBundle

  • The FirewallContext::getContext() method has been removed, use the getListeners() and/or getExceptionListener() method instead.

  • The FirewallMap::$map and $container properties have been removed.

  • The UserPasswordEncoderCommand class does not allow null as the first argument anymore.

  • UserPasswordEncoderCommand does not implement ContainerAwareInterface anymore.

Serializer

  • The ability to pass a Doctrine Cache instance to the ClassMetadataFactory class has been removed. You should use the CacheClassMetadataFactory class instead.

  • Not defining the 6th argument $format = null of the AbstractNormalizer::instantiateObject() method when overriding it is not supported anymore.

  • Extending ChainDecoder, ChainEncoder, ArrayDenormalizer is not supported anymore.

Translation

  • Removed the backup feature from the file dumper classes.

TwigBundle

  • The ContainerAwareRuntimeLoader class has been removed. Use the Twig Twig_ContainerRuntimeLoader class instead.

TwigBridge

  • Removed the possibility to inject the Form TwigRenderer into the FormExtension. Upgrade Twig to ^1.30, inject the Twig_Environment into the TwigRendererEngine and load the TwigRenderer using the Twig_FactoryRuntimeLoader instead.

    Before:

    use Symfony\Bridge\Twig\Extension\FormExtension;
use Symfony\Bridge\Twig\Form\TwigRenderer;
use Symfony\Bridge\Twig\Form\TwigRendererEngine;

// ...
$rendererEngine = new TwigRendererEngine(array('form_div_layout.html.twig'));
$rendererEngine->setEnvironment($twig);
$twig->addExtension(new FormExtension(new TwigRenderer($rendererEngine, $csrfTokenManager)));

    After:

    $rendererEngine = new TwigRendererEngine(array('form_div_layout.html.twig'), $twig);
$twig->addRuntimeLoader(new \Twig_FactoryRuntimeLoader(array(
    TwigRenderer::class => function () use ($rendererEngine, $csrfTokenManager) {
        return new TwigRenderer($rendererEngine, $csrfTokenManager);
    },
)));
$twig->addExtension(new FormExtension());

  • Removed the TwigRendererEngineInterface interface.

  • The TwigRendererEngine::setEnvironment() method has been removed. Pass the Twig Environment as second argument of the constructor instead.

Validator

  • The default value of the strict option of the Choice constraint was changed to true. Using any other value will throw an exception.

  • The DateTimeValidator::PATTERN constant was removed.

  • Tests\Constraints\AbstractConstraintValidatorTest has been removed in favor of Test\ConstraintValidatorTestCase.

    Before:

    // ...
use Symfony\Component\Validator\Tests\Constraints\AbstractConstraintValidatorTest;

class MyCustomValidatorTest extends AbstractConstraintValidatorTest
{
    // ...
}

    After:

    // ...
use Symfony\Component\Validator\Test\ConstraintValidatorTestCase;

class MyCustomValidatorTest extends ConstraintValidatorTestCase
{
    // ...
}

  • The default value of the strict option of the Choice Constraint has been changed to true as of 4.0. If you need the previous behaviour ensure to set the option to false.

Workflow

  • Removed class name support in WorkflowRegistry::add() as second parameter.

Yaml

  • Starting an unquoted string with a question mark followed by a space throws a ParseException.

  • Removed support for implicitly parsing non-string mapping keys as strings. Mapping keys that are no strings will result in a ParseException. Use the PARSE_KEYS_AS_STRINGS flag to opt-in for keys to be parsed as strings.

    Before:

    $yaml = <<<YAML
null: null key
true: boolean true
1: integer key
2.0: float key
YAML;

Yaml::parse($yaml);

    After:

    $yaml = <<<YAML
null: null key
true: boolean true
1: integer key
2.0: float key
YAML;

Yaml::parse($yaml, Yaml::PARSE_KEYS_AS_STRINGS);

  • Omitting the key of a mapping is not supported anymore and throws a ParseException.

  • Mappings with a colon (:) that is not followed by a whitespace are not supported anymore and lead to a ParseException(e.g. foo:bar must be foo: bar).

  • Starting an unquoted string with % leads to a ParseException.

  • The Dumper::setIndentation() method was removed. Pass the indentation level to the constructor instead.

  • Removed support for passing true/false as the second argument to the parse() method to trigger exceptions when an invalid type was passed.

    Before:

    Yaml::parse('{ "foo": "bar", "fiz": "cat" }', true);

    After:

    Yaml::parse('{ "foo": "bar", "fiz": "cat" }', Yaml::PARSE_EXCEPTION_ON_INVALID_TYPE);

  • Removed support for passing true/false as the third argument to the parse() method to toggle object support.

    Before:

    Yaml::parse('{ "foo": "bar", "fiz": "cat" }', false, true);

    After:

    Yaml::parse('{ "foo": "bar", "fiz": "cat" }', Yaml::PARSE_OBJECT);

  • Removed support for passing true/false as the fourth argument to the parse() method to parse objects as maps.

    Before:

    Yaml::parse('{ "foo": "bar", "fiz": "cat" }', false, false, true);

    After:

    Yaml::parse('{ "foo": "bar", "fiz": "cat" }', Yaml::PARSE_OBJECT_FOR_MAP);

  • Removed support for passing true/false as the fourth argument to the dump() method to trigger exceptions when an invalid type was passed.

    Before:

    Yaml::dump(array('foo' => new A(), 'bar' => 1), 0, 0, true);

    After:

    Yaml::dump(array('foo' => new A(), 'bar' => 1), 0, 0, Yaml::DUMP_EXCEPTION_ON_INVALID_TYPE);

  • Removed support for passing true/false as the fifth argument to the dump() method to toggle object support.

    Before:

    Yaml::dump(array('foo' => new A(), 'bar' => 1), 0, 0, false, true);

    After:

    Yaml::dump(array('foo' => new A(), 'bar' => 1), 0, 0, false, Yaml::DUMP_OBJECT);

  • The !!php/object tag to indicate dumped PHP objects was removed in favor of the !php/object tag.

  • Duplicate mapping keys lead to a ParseException.

  • The constructor arguments $offset, $totalNumberOfLines and $skippedLineNumbers of the Parser class were removed.