666 lines
18 KiB
Markdown
666 lines
18 KiB
Markdown
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.
|
|
|
|
```json
|
|
"require": {
|
|
"symfony/polyfill-iconv": "~1.0"
|
|
}
|
|
```
|
|
|
|
Form
|
|
----
|
|
|
|
* The `intention` option was deprecated and will be removed in 3.0 in favor
|
|
of the new `csrf_token_id` option.
|
|
|
|
* The `csrf_provider` option was deprecated and will be removed in 3.0 in favor
|
|
of the new `csrf_token_manager` option.
|
|
|
|
* 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:
|
|
|
|
```php
|
|
$form = $this->createFormBuilder($article, array('cascade_validation' => true))
|
|
->add('author', new AuthorType())
|
|
->getForm();
|
|
```
|
|
|
|
After:
|
|
|
|
```php
|
|
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:
|
|
|
|
```php
|
|
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:
|
|
|
|
```php
|
|
$form = $this->createFormBuilder()
|
|
->add('name', 'text')
|
|
->add('age', 'integer')
|
|
->getForm();
|
|
```
|
|
|
|
After:
|
|
|
|
```php
|
|
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:
|
|
|
|
```php
|
|
class UserProfileType extends AbstractType
|
|
{
|
|
public function getName()
|
|
{
|
|
return 'profile';
|
|
}
|
|
}
|
|
```
|
|
|
|
After:
|
|
|
|
```php
|
|
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()` and
|
|
`getBlockPrefix()`:
|
|
|
|
```php
|
|
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:
|
|
|
|
```xml
|
|
<service id="my.type" class="Vendor\Type\MyType">
|
|
<tag name="form.type" alias="mytype" />
|
|
</service>
|
|
```
|
|
|
|
After:
|
|
|
|
```xml
|
|
<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:
|
|
|
|
```php
|
|
class MyTypeExtension extends AbstractTypeExtension
|
|
{
|
|
public function getExtendedType()
|
|
{
|
|
return 'form';
|
|
}
|
|
}
|
|
```
|
|
|
|
After:
|
|
|
|
```php
|
|
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:
|
|
|
|
```php
|
|
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';
|
|
}
|
|
}
|
|
```
|
|
|
|
* In Symfony 2.7 a small BC break was introduced with the new choices_as_values
|
|
option. In order to have the choice values populated to the html value attribute
|
|
you had to define the choice_value option. This is now not any more needed.
|
|
|
|
Before:
|
|
|
|
```php
|
|
$form->add('status', 'choice', array(
|
|
'choices' => array(
|
|
'Enabled' => Status::ENABLED,
|
|
'Disabled' => Status::DISABLED,
|
|
'Ignored' => Status::IGNORED,
|
|
),
|
|
'choices_as_values' => true,
|
|
// important if you rely on your option value attribute (e.g. for JavaScript)
|
|
// this will keep the same functionality as before
|
|
'choice_value' => function ($choice) {
|
|
return $choice;
|
|
},
|
|
));
|
|
```
|
|
|
|
After (Symfony 2.8+):
|
|
|
|
```php
|
|
$form->add('status', ChoiceType::class, array(
|
|
'choices' => array(
|
|
'Enabled' => Status::ENABLED,
|
|
'Disabled' => Status::DISABLED,
|
|
'Ignored' => Status::IGNORED,
|
|
),
|
|
'choices_as_values' => true
|
|
));
|
|
```
|
|
|
|
* 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:
|
|
|
|
```php
|
|
class MyType
|
|
{
|
|
public function getParent()
|
|
{
|
|
return new ParentType();
|
|
}
|
|
}
|
|
```
|
|
|
|
After:
|
|
|
|
```php
|
|
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 the
|
|
`FormFactory::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:
|
|
|
|
```php
|
|
$form = $this->createForm(new MyType());
|
|
```
|
|
|
|
After:
|
|
|
|
```php
|
|
$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
|
|
the `extended_type`/`extended-type` option.
|
|
|
|
Before:
|
|
```xml
|
|
<service id="app.type_extension" class="Vendor\Form\Extension\MyTypeExtension">
|
|
<tag name="form.type_extension" alias="text" />
|
|
</service>
|
|
```
|
|
|
|
After:
|
|
```xml
|
|
<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. Use `ArrayChoiceList` instead.
|
|
|
|
Translator
|
|
----------
|
|
|
|
* The `getMessages()` method of the `Symfony\Component\Translation\Translator` was deprecated and will be removed in
|
|
Symfony 3.0. You should use the `getCatalogue()` method of the `Symfony\Component\Translation\TranslatorBagInterface`.
|
|
|
|
Before:
|
|
|
|
```php
|
|
$messages = $translator->getMessages();
|
|
```
|
|
|
|
After:
|
|
|
|
```php
|
|
$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 the `prototype` scope.
|
|
|
|
Before:
|
|
|
|
```php
|
|
use Symfony\Component\DependencyInjection\ContainerBuilder;
|
|
|
|
$container = new ContainerBuilder();
|
|
$container
|
|
->register('foo', 'stdClass')
|
|
->setScope(ContainerBuilder::SCOPE_PROTOTYPE)
|
|
;
|
|
```
|
|
|
|
```yml
|
|
services:
|
|
foo:
|
|
class: stdClass
|
|
scope: prototype
|
|
```
|
|
|
|
```xml
|
|
<services>
|
|
<service id="foo" class="stdClass" scope="prototype" />
|
|
</services>
|
|
```
|
|
|
|
After:
|
|
|
|
```php
|
|
use Symfony\Component\DependencyInjection\ContainerBuilder;
|
|
|
|
$container = new ContainerBuilder();
|
|
$container
|
|
->register('foo', 'stdClass')
|
|
->setShared(false)
|
|
;
|
|
```
|
|
|
|
```yml
|
|
services:
|
|
foo:
|
|
class: stdClass
|
|
shared: false
|
|
```
|
|
|
|
```xml
|
|
<services>
|
|
<service id="foo" class="stdClass" shared="false" />
|
|
</services>
|
|
```
|
|
|
|
* `Symfony\Component\DependencyInjection\ContainerAware` has been deprecated, use
|
|
`Symfony\Component\DependencyInjection\ContainerAwareTrait` or implement
|
|
`Symfony\Component\DependencyInjection\ContainerAwareInterface` manually
|
|
|
|
WebProfiler
|
|
-----------
|
|
|
|
* The `profiler:import` and `profiler: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:
|
|
|
|
```twig
|
|
{% 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:
|
|
|
|
```twig
|
|
{% 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:
|
|
|
|
```twig
|
|
{% 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 the `ProfileStorageInterface`.
|
|
|
|
FrameworkBundle
|
|
---------------
|
|
|
|
* The default value of the parameter `session`.`cookie_httponly` is now `true`.
|
|
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:
|
|
|
|
```yaml
|
|
framework:
|
|
session:
|
|
cookie_httponly: false
|
|
```
|
|
|
|
* The `validator.mapping.cache.apc` service is deprecated, and will be removed in 3.0.
|
|
Use `validator.mapping.cache.doctrine.apc` instead.
|
|
|
|
* The ability to pass `apc` as the `framework.validation.cache` configuration key value is deprecated,
|
|
and will be removed in 3.0. Use `validator.mapping.cache.doctrine.apc` instead:
|
|
|
|
Before:
|
|
|
|
```yaml
|
|
framework:
|
|
validation:
|
|
cache: apc
|
|
```
|
|
|
|
After:
|
|
|
|
```yaml
|
|
framework:
|
|
validation:
|
|
cache: validator.mapping.cache.doctrine.apc
|
|
```
|
|
|
|
Security
|
|
--------
|
|
|
|
* The `object` variable passed to expressions evaluated by the `ExpressionVoter`
|
|
is deprecated. Instead use the new `subject` variable.
|
|
|
|
* The `AbstractVoter` class was deprecated. Instead, extend the `Voter` class and
|
|
move your voting logic in the `supports($attribute, $subject)` and
|
|
`voteOnAttribute($attribute, $object, TokenInterface $token)` methods.
|
|
|
|
* The `VoterInterface::supportsClass` and `supportsAttribute` 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 the `csrf_token_id` option instead.
|
|
|
|
* The `csrf_provider` option is deprecated for all the authentication listeners,
|
|
and will be removed in 3.0. Use the `csrf_token_generator` option instead.
|
|
|
|
SecurityBundle
|
|
--------------
|
|
|
|
* The `intention` firewall listener setting is deprecated, and will be removed in 3.0.
|
|
Use the `csrf_token_id` option instead.
|
|
|
|
* The `csrf_provider` firewall listener setting is deprecated, and will be removed in 3.0.
|
|
Use the `csrf_token_generator` 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:
|
|
|
|
```php
|
|
use Symfony\Component\Config\Resource\ResourceInterface;
|
|
|
|
class MyCustomResource implements ResourceInterface { ... }
|
|
```
|
|
|
|
After:
|
|
|
|
```php
|
|
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 on
|
|
`ResourceChecker`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:
|
|
|
|
```yml
|
|
class: "Foo\Var"
|
|
```
|
|
|
|
After:
|
|
|
|
```yml
|
|
class: "Foo\\Var"
|
|
```
|
|
|
|
HttpFoundation
|
|
--------------
|
|
|
|
* Deprecated finding deep items in `ParameterBag::get()`. This may affect you
|
|
when getting parameters from the `Request` class:
|
|
|
|
Before:
|
|
|
|
```php
|
|
$request->query->get('foo[bar]', null, true);
|
|
```
|
|
|
|
After:
|
|
|
|
```php
|
|
$request->query->get('foo')['bar'];
|
|
```
|
|
|
|
Routing
|
|
-------
|
|
|
|
* Deprecated the hardcoded value for the `$referenceType` argument of the `UrlGeneratorInterface::generate` method.
|
|
Use the constants defined in the `UrlGeneratorInterface` instead.
|
|
|
|
Before:
|
|
|
|
```php
|
|
// url generated in controller
|
|
$this->generateUrl('blog_show', array('slug' => 'my-blog-post'), true);
|
|
|
|
// url generated in @router service
|
|
$router->generate('blog_show', array('slug' => 'my-blog-post'), true);
|
|
```
|
|
|
|
After:
|
|
|
|
```php
|
|
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
|
|
|
|
// url generated in controller
|
|
$this->generateUrl('blog_show', array('slug' => 'my-blog-post'), UrlGeneratorInterface::ABSOLUTE_URL);
|
|
|
|
// url generated in @router service
|
|
$router->generate('blog_show', array('slug' => 'my-blog-post'), UrlGeneratorInterface::ABSOLUTE_URL);
|
|
```
|
|
|
|
DoctrineBridge
|
|
--------------
|
|
* Deprecated using the entity provider with a Doctrine repository implementing `UserProviderInterface`.
|
|
Make it implement `UserLoaderInterface` instead.
|