15 KiB
UPGRADE FROM 2.7 to 2.8
All components
-
Symfony now requires the iconv extension to be present, which is the case by default in most environments. However, if you're not able to ensure this extension to be installed in your target environment, you can add Symfony's iconv polyfill to your project's composer.json file.
"require": { "symfony/polyfill-iconv": "~1.0" }
Form
-
The "cascade_validation" option was deprecated. Use the "constraints" option together with the
Valid
constraint instead. Contrary to "cascade_validation", "constraints" must be set on the respective child forms, not the parent form.Before:
$form = $this->createFormBuilder($article, array('cascade_validation' => true)) ->add('author', new AuthorType()) ->getForm();
After:
use Symfony\Component\Validator\Constraints\Valid; $form = $this->createFormBuilder($article) ->add('author', new AuthorType(), array( 'constraints' => new Valid(), )) ->getForm();
Alternatively, you can set the
Valid
constraint in the model itself:use Symfony\Component\Validator\Constraints as Assert; class Article { /** * @Assert\Valid */ private $author; }
-
Type names were deprecated and will be removed in Symfony 3.0. Instead of referencing types by name, you should reference them by their fully-qualified class name (FQCN) instead. With PHP 5.5 or later, you can use the "class" constant for that:
Before:
$form = $this->createFormBuilder() ->add('name', 'text') ->add('age', 'integer') ->getForm();
After:
use Symfony\Component\Form\Extension\Core\Type\IntegerType; use Symfony\Component\Form\Extension\Core\Type\TextType; $form = $this->createFormBuilder() ->add('name', TextType::class) ->add('age', IntegerType::class) ->getForm();
As a further consequence, the method
FormTypeInterface::getName()
was deprecated and will be removed in Symfony 3.0. You should remove this method from your form types.If you want to customize the block prefix of a type in Twig, you should now implement
FormTypeInterface::getBlockPrefix()
instead:Before:
class UserProfileType extends AbstractType { public function getName() { return 'profile'; } }
After:
class UserProfileType extends AbstractType { public function getBlockPrefix() { return 'profile'; } }
If you don't customize
getBlockPrefix()
, it defaults to the class name without "Type" suffix in underscore notation (here: "user_profile").If you want to create types that are compatible with Symfony 2.3 up to 2.8 and don't trigger deprecation errors, implement both
getName()
andgetBlockPrefix()
:class ProfileType extends AbstractType { public function getName() { return $this->getBlockPrefix(); } public function getBlockPrefix() { return 'profile'; } }
If you define your form types in the Dependency Injection configuration, you should further remove the "alias" attribute:
Before:
<service id="my.type" class="Vendor\Type\MyType"> <tag name="form.type" alias="mytype" /> </service>
After:
<service id="my.type" class="Vendor\Type\MyType"> <tag name="form.type" /> </service>
Type extension should return the fully-qualified class name of the extended type from
FormTypeExtensionInterface::getExtendedType()
now.Before:
class MyTypeExtension extends AbstractTypeExtension { public function getExtendedType() { return 'form'; } }
After:
use Symfony\Component\Form\Extension\Core\Type\FormType; class MyTypeExtension extends AbstractTypeExtension { public function getExtendedType() { return FormType::class; } }
If your extension has to be compatible with Symfony 2.3-2.8, use the following statement:
use Symfony\Component\Form\AbstractType; use Symfony\Component\Form\Extension\Core\Type\FormType; class MyTypeExtension extends AbstractTypeExtension { public function getExtendedType() { return method_exists(AbstractType::class, 'getBlockPrefix') ? FormType::class : 'form'; } }
-
Returning type instances from
FormTypeInterface::getParent()
is deprecated and will not be supported anymore in Symfony 3.0. Return the fully-qualified class name of the parent type class instead.Before:
class MyType { public function getParent() { return new ParentType(); } }
After:
class MyType { public function getParent() { return ParentType::class; } }
-
The option "options" of the CollectionType has been renamed to "entry_options". The usage of the option "options" is deprecated and will be removed in Symfony 3.0.
-
The option "type" of the CollectionType has been renamed to "entry_type". The usage of the option "type" is deprecated and will be removed in Symfony 3.0. As a value for the option you should provide the fully-qualified class name (FQCN) now as well.
-
Passing type instances to
Form::add()
,FormBuilder::add()
and theFormFactory::create*()
methods is deprecated and will not be supported anymore in Symfony 3.0. Pass the fully-qualified class name of the type instead.Before:
$form = $this->createForm(new MyType());
After:
$form = $this->createForm(MyType::class);
-
Registering type extensions as a service with an alias which does not match the type returned by
getExtendedType
is now forbidden. Fix your implementation to define the right type. -
The alias option of the
form.type_extension
tag is deprecated in favor of theextended_type
/extended-type
option.Before:
<service id="app.type_extension" class="Vendor\Form\Extension\MyTypeExtension"> <tag name="form.type_extension" alias="text" /> </service>
After:
<service id="app.type_extension" class="Vendor\Form\Extension\MyTypeExtension"> <tag name="form.type_extension" extended-type="Symfony\Component\Form\Extension\Core\Type\TextType" /> </service>
-
The
TimezoneType::getTimezones()
method was deprecated and will be removed in Symfony 3.0. You should not use this method. -
The class
ArrayKeyChoiceList
was deprecated and will be removed in Symfony 3.0. UseArrayChoiceList
instead.
Translator
-
The
getMessages()
method of theSymfony\Component\Translation\Translator
was deprecated and will be removed in Symfony 3.0. You should use thegetCatalogue()
method of theSymfony\Component\Translation\TranslatorBagInterface
.Before:
$messages = $translator->getMessages();
After:
$catalogue = $translator->getCatalogue($locale); $messages = $catalogue->all(); while ($catalogue = $catalogue->getFallbackCatalogue()) { $messages = array_replace_recursive($catalogue->all(), $messages); }
DependencyInjection
-
The concept of scopes were deprecated, the deprecated methods are:
Symfony\Component\DependencyInjection\ContainerBuilder::getScopes()
Symfony\Component\DependencyInjection\ContainerBuilder::getScopeChildren()
Symfony\Component\DependencyInjection\ContainerInterface::enterScope()
Symfony\Component\DependencyInjection\ContainerInterface::leaveScope()
Symfony\Component\DependencyInjection\ContainerInterface::addScope()
Symfony\Component\DependencyInjection\ContainerInterface::hasScope()
Symfony\Component\DependencyInjection\ContainerInterface::isScopeActive()
Symfony\Component\DependencyInjection\Definition::setScope()
Symfony\Component\DependencyInjection\Definition::getScope()
Symfony\Component\DependencyInjection\Reference::isStrict()
Also, the $scope
and $strict
parameters of Symfony\Component\DependencyInjection\ContainerInterface::set()
and Symfony\Component\DependencyInjection\Reference
respectively were deprecated.
-
A new
shared
flag has been added to the service definition in replacement of theprototype
scope.Before:
use Symfony\Component\DependencyInjection\ContainerBuilder; $container = new ContainerBuilder(); $container ->register('foo', 'stdClass') ->setScope(ContainerBuilder::SCOPE_PROTOTYPE) ;
services: foo: class: stdClass scope: prototype
<services> <service id="foo" class="stdClass" scope="prototype" /> </services>
After:
use Symfony\Component\DependencyInjection\ContainerBuilder; $container = new ContainerBuilder(); $container ->register('foo', 'stdClass') ->setShared(false) ;
services: foo: class: stdClass shared: false
<services> <service id="foo" class="stdClass" shared="false" /> </services>
-
Symfony\Component\DependencyInjection\ContainerAware
has been deprecated, useSymfony\Component\DependencyInjection\ContainerAwareTrait
or implementSymfony\Component\DependencyInjection\ContainerAwareInterface
manually
WebProfiler
-
The
profiler:import
andprofiler:export
commands have been deprecated and will be removed in 3.0. -
The web development toolbar has been completely redesigned. This update has introduced some changes in the HTML markup of the toolbar items.
Before:
Information was wrapped with simple
<span>
elements:{% block toolbar %} {% set icon %} <span> <svg ...></svg> <span>{{ '%.1f'|format(collector.memory / 1024 / 1024) }} MB</span> </span> {% endset %} {% endblock %}
After:
Information is now semantically divided into values and labels according to the
class
attribute of each<span>
element:{% block toolbar %} {% set icon %} <svg ...></svg> <span class="sf-toolbar-value"> {{ '%.1f'|format(collector.memory / 1024 / 1024) }} </span> <span class="sf-toolbar-label">MB</span> {% endset %} {% endblock %}
Most of the blocks designed for the previous toolbar will still be displayed correctly. However, if you want to support both the old and the new toolbar, it's better to make use of the new
profiler_markup_version
variable passed to the toolbar templates:{% block toolbar %} {% set profiler_markup_version = profiler_markup_version|default(1) %} {% set icon %} {% if profiler_markup_version == 1 %} {# code for the original toolbar #} {% else %} {# code for the new toolbar (Symfony 2.8+) #} {% endif %} {% endset %} {% endblock %}
-
All the profiler storages different than
FileProfilerStorage
have been deprecated. The deprecated classes are:Symfony\Component\HttpKernel\Profiler\BaseMemcacheProfilerStorage
Symfony\Component\HttpKernel\Profiler\MemcachedProfilerStorage
Symfony\Component\HttpKernel\Profiler\MemcacheProfilerStorage
Symfony\Component\HttpKernel\Profiler\MongoDbProfilerStorage
Symfony\Component\HttpKernel\Profiler\MysqlProfilerStorage
Symfony\Component\HttpKernel\Profiler\PdoProfilerStorage
Symfony\Component\HttpKernel\Profiler\RedisProfilerStorage
Symfony\Component\HttpKernel\Profiler\SqliteProfilerStorage
The alternative solution is to use the
FileProfilerStorage
or create your own storage implementing theProfileStorageInterface
.
FrameworkBundle
-
The default value of the parameter
session
.cookie_httponly
is nowtrue
. It prevents scripting languages, such as JavaScript to access the cookie, which help to reduce identity theft through XSS attacks. If your application needs to access the session cookie, override this parameter:framework: session: cookie_httponly: false
Security
-
The
object
variable passed to expressions evaluated by theExpressionVoter
is deprecated. Instead use the newsubject
variable. -
The
AbstractVoter
class was deprecated. Instead, extend theVoter
class and move your voting logic in thesupports($attribute, $subject)
andvoteOnAttribute($attribute, $object, TokenInterface $token)
methods. -
The
VoterInterface::supportsClass
andsupportsAttribute
methods were deprecated and will be removed from the interface in 3.0. -
The
intention
option is deprecated for all the authentication listeners, and will be removed in 3.0. Use thecsrf_token_id
option instead.
SecurityBundle
- The
intention
firewall listener setting is deprecated, and will be removed in 3.0. Use thecsrf_token_id
option instead.
Config
-
The
\Symfony\Component\Config\Resource\ResourceInterface::isFresh()
method has been deprecated and will be removed in Symfony 3.0 because it assumes that resource implementations are able to check themselves for freshness.If you have custom resources that implement this method, change them to implement the
\Symfony\Component\Config\Resource\SelfCheckingResourceInterface
sub-interface instead of\Symfony\Component\Config\Resource\ResourceInterface
.Before:
use Symfony\Component\Config\Resource\ResourceInterface; class MyCustomResource implements ResourceInterface { ... }
After:
use Symfony\Component\Config\Resource\SelfCheckingResourceInterface; class MyCustomResource implements SelfCheckingResourceInterface { ... }
Additionally, if you have implemented cache validation strategies using
isFresh()
yourself, you should have a look at the new cache validation system based onResourceChecker
s.
Yaml
-
Deprecated usage of a colon in an unquoted mapping value
-
Deprecated usage of
@
,`
,|
, and>
at the beginning of an unquoted string -
When surrounding strings with double-quotes, you must now escape
\
characters. Not escaping those characters (when surrounded by double-quotes) is deprecated.Before:
class: "Foo\Var"
After:
class: "Foo\\Var"