This PR was merged into the 2.8 branch.
Discussion
----------
[Form][Security] update upgrade files with CSRF related option info
| Q | A
| ------------- | ---
| Bug fix? | yes
| New feature? | no
| BC breaks? | no
| Deprecations? | no
| Tests pass? | yes
| Fixed tickets |
| License | MIT
| Doc PR | symfony/symfony-docs#6152
Commits
-------
1ecbb32
update upgrade files with CSRF related option info
42 KiB
UPGRADE FROM 2.x to 3.0
ClassLoader
-
The
UniversalClassLoader
class has been removed in favor ofClassLoader
. The only difference is that some method names are different:Old name New name registerNamespaces()
addPrefixes()
registerPrefixes()
addPrefixes()
registerNamespace()
addPrefix()
registerPrefix()
addPrefix()
getNamespaces()
getPrefixes()
getNamespaceFallbacks()
getFallbackDirs()
getPrefixFallbacks()
getFallbackDirs()
-
The
DebugUniversalClassLoader
class has been removed in favor ofDebugClassLoader
. The difference is that the constructor now takes a loader to wrap.
Config
-
\Symfony\Component\Config\Resource\ResourceInterface::isFresh()
has been removed. Also, cache validation through this method (which was still supported in 2.8 for BC) does no longer work because the\Symfony\Component\Config\Resource\BCResourceInterfaceChecker
helper class has been removed as well. -
The
__toString()
method of the\Symfony\Component\Config\ConfigCache
class was removed in favor of the newgetPath()
method.
Console
-
The
dialog
helper has been removed in favor of thequestion
helper. -
The methods
isQuiet
,isVerbose
,isVeryVerbose
andisDebug
were added toSymfony\Component\Console\Output\OutputInterface
. -
ProgressHelper
has been removed in favor ofProgressBar
.Before:
$h = new ProgressHelper(); $h->start($output, 10); for ($i = 1; $i < 5; $i++) { usleep(200000); $h->advance(); } $h->finish();
After:
$bar = new ProgressBar($output, 10); $bar->start(); for ($i = 1; $i < 5; $i++) { usleep(200000); $bar->advance(); }
-
TableHelper
has been removed in favor ofTable
.Before:
$table = $app->getHelperSet()->get('table'); $table ->setHeaders(array('ISBN', 'Title', 'Author')) ->setRows(array( array('99921-58-10-7', 'Divine Comedy', 'Dante Alighieri'), array('9971-5-0210-0', 'A Tale of Two Cities', 'Charles Dickens'), array('960-425-059-0', 'The Lord of the Rings', 'J. R. R. Tolkien'), array('80-902734-1-6', 'And Then There Were None', 'Agatha Christie'), )) ; $table->render($output);
After:
use Symfony\Component\Console\Helper\Table; $table = new Table($output); $table ->setHeaders(array('ISBN', 'Title', 'Author')) ->setRows(array( array('99921-58-10-7', 'Divine Comedy', 'Dante Alighieri'), array('9971-5-0210-0', 'A Tale of Two Cities', 'Charles Dickens'), array('960-425-059-0', 'The Lord of the Rings', 'J. R. R. Tolkien'), array('80-902734-1-6', 'And Then There Were None', 'Agatha Christie'), )) ; $table->render();
DependencyInjection
-
The concept of scopes was removed, the removed 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 removed.
-
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
was removed, useSymfony\Component\DependencyInjection\ContainerAwareTrait
or implementSymfony\Component\DependencyInjection\ContainerAwareInterface
manually -
The methods
Definition::setFactoryClass()
,Definition::setFactoryMethod()
, andDefinition::setFactoryService()
have been removed in favor ofDefinition::setFactory()
. Services defined using YAML or XML use the same syntax as configurators. -
Synchronized services are deprecated and the following methods have been removed:
ContainerBuilder::synchronize()
,Definition::isSynchronized()
, andDefinition::setSynchronized()
.
DoctrineBridge
-
The
property
option ofDoctrineType
was removed in favor of thechoice_label
option. -
The
loader
option ofDoctrineType
was removed. You now have to override thegetLoader()
method in your custom type. -
The
Symfony\Bridge\Doctrine\Form\ChoiceList\EntityChoiceList
was removed in favor ofSymfony\Bridge\Doctrine\Form\ChoiceList\DoctrineChoiceLoader
. -
Passing a query builder closure to
ORMQueryBuilderLoader
is not supported anymore. You should pass resolved query builders only.Consequently, the arguments
$manager
and$class
ofORMQueryBuilderLoader
have been removed as well.Note that the
query_builder
option ofDoctrineType
does support closures, but the closure is now resolved in the type instead of in the loader.
EventDispatcher
- The interface
Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcherInterface
extendsSymfony\Component\EventDispatcher\EventDispatcherInterface
.
Form
-
The option
options
of theCollectionType
has been removed in favor of theentry_options
option. -
The
cascade_validation
option was removed. Use theconstraints
option together with theValid
constraint instead. -
Type names were removed. Instead of referencing types by name, you must reference them by their fully-qualified class name (FQCN) instead:
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();
If you want to customize the block prefix of a type in Twig, you must now implement
FormTypeInterface::getBlockPrefix()
: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").Type extension must 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; } }
-
The
FormTypeInterface::getName()
method was removed. -
Returning type instances from
FormTypeInterface::getParent()
is not supported anymore. 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
type
of theCollectionType
has been removed in favor of theentry_type
option. The value for theentry_type
option must be the fully-qualified class name (FQCN). -
Passing type instances to
Form::add()
,FormBuilder::add()
and theFormFactory::create*()
methods is not supported anymore. Pass the fully-qualified class name of the type instead.Before:
$form = $this->createForm(new MyType());
After:
$form = $this->createForm(MyType::class);
-
The alias option of the
form.type_extension
tag was removed 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
ChoiceToBooleanArrayTransformer
,ChoicesToBooleanArrayTransformer
,FixRadioInputListener
, andFixCheckboxInputListener
classes were removed. -
The
choice_list
option ofChoiceType
was removed. -
The option "precision" was renamed to "scale".
Before:
use Symfony\Component\Form\Extension\Core\Type\NumberType; $builder->add('length', NumberType::class, array( 'precision' => 3, ));
After:
use Symfony\Component\Form\Extension\Core\Type\NumberType; $builder->add('length', NumberType::class, array( 'scale' => 3, ));
-
The option "
virtual
" was renamed to "inherit_data
".Before:
use Symfony\Component\Form\Extension\Core\Type\FormType; $builder->add('address', FormType::class, array( 'virtual' => true, ));
After:
use Symfony\Component\Form\Extension\Core\Type\FormType; $builder->add('address', FormType::class, array( 'inherit_data' => true, ));
-
The method
AbstractType::setDefaultOptions(OptionsResolverInterface $resolver)
andAbstractTypeExtension::setDefaultOptions(OptionsResolverInterface $resolver)
have been renamed. You should useAbstractType::configureOptions(OptionsResolver $resolver)
andAbstractTypeExtension::configureOptions(OptionsResolver $resolver)
instead. -
The methods
Form::bind()
andForm::isBound()
were removed. You should useForm::submit()
andForm::isSubmitted()
instead.Before:
$form->bind(array(...));
After:
$form->submit(array(...));
-
Passing a
Symfony\Component\HttpFoundation\Request
instance, as was supported byFormInterface::bind()
, is not possible withFormInterface::submit()
anymore. You should useFormInterface::handleRequest()
instead.Before:
if ('POST' === $request->getMethod()) { $form->bind($request); if ($form->isValid()) { // ... } }
After:
$form->handleRequest($request); if ($form->isValid()) { // ... }
If you want to test whether the form was submitted separately, you can use the method
isSubmitted()
:$form->handleRequest($request); if ($form->isSubmitted()) { // ... if ($form->isValid()) { // ... } }
-
The events
PRE_BIND
,BIND
andPOST_BIND
were renamed toPRE_SUBMIT
,SUBMIT
andPOST_SUBMIT
.Before:
$builder->addEventListener(FormEvents::PRE_BIND, function (FormEvent $event) { // ... });
After:
$builder->addEventListener(FormEvents::PRE_SUBMIT, function (FormEvent $event) { // ... });
-
The class
VirtualFormAwareIterator
was renamed toInheritDataAwareIterator
.Before:
use Symfony\Component\Form\Util\VirtualFormAwareIterator; $iterator = new VirtualFormAwareIterator($forms);
After:
use Symfony\Component\Form\Util\InheritDataAwareIterator; $iterator = new InheritDataAwareIterator($forms);
-
The
TypeTestCase
class was moved from theSymfony\Component\Form\Tests\Extension\Core\Type
namespace to theSymfony\Component\Form\Test
namespace.Before:
use Symfony\Component\Form\Tests\Extension\Core\Type\TypeTestCase class MyTypeTest extends TypeTestCase { // ... }
After:
use Symfony\Component\Form\Test\TypeTestCase; class MyTypeTest extends TypeTestCase { // ... }
-
The option "options" of the CollectionType has been renamed to "entry_options".
-
The option "type" of the CollectionType has been renamed to "entry_type". As a value for the option you must provide the fully-qualified class name (FQCN) now as well.
-
The
FormIntegrationTestCase
andFormPerformanceTestCase
classes were moved form theSymfony\Component\Form\Tests
namespace to theSymfony\Component\Form\Test
namespace. -
The constants
ROUND_HALFEVEN
,ROUND_HALFUP
andROUND_HALFDOWN
in classNumberToLocalizedStringTransformer
were renamed toROUND_HALF_EVEN
,ROUND_HALF_UP
andROUND_HALF_DOWN
. -
The
Symfony\Component\Form\Extension\Core\ChoiceList\ChoiceListInterface
was removed in favor ofSymfony\Component\Form\ChoiceList\ChoiceListInterface
. -
Symfony\Component\Form\Extension\Core\View\ChoiceView
was removed in favor ofSymfony\Component\Form\ChoiceList\View\ChoiceView
. -
The interface
Symfony\Component\Form\Extension\Csrf\CsrfProvider\CsrfProviderInterface
and all of its implementations were removed. Use the new interfaceSymfony\Component\Security\Csrf\CsrfTokenManagerInterface
instead. -
The options "
csrf_provider
" and "intention
" were renamed to "csrf_token_generator
" and "csrf_token_id
". -
The method
Form::getErrorsAsString()
was removed. UseForm::getErrors()
instead with the argument$deep
set to true and$flatten
set to false and cast the returned iterator to a string (if not done implicitly by PHP).Before:
echo $form->getErrorsAsString();
After:
echo $form->getErrors(true, false);
-
The
Symfony\Component\Form\Extension\Core\ChoiceList\ChoiceList
class has been removed in favor ofSymfony\Component\Form\ChoiceList\ArrayChoiceList
. -
The
Symfony\Component\Form\Extension\Core\ChoiceList\LazyChoiceList
class has been removed in favor ofSymfony\Component\Form\ChoiceList\LazyChoiceList
. -
The
Symfony\Component\Form\Extension\Core\ChoiceList\ObjectChoiceList
class has been removed in favor ofSymfony\Component\Form\ChoiceList\ArrayChoiceList
. -
The
Symfony\Component\Form\Extension\Core\ChoiceList\SimpleChoiceList
class has been removed in favor ofSymfony\Component\Form\ChoiceList\ArrayChoiceList
. -
The
TimezoneType::getTimezones()
method was removed. You should not use this method. -
The
Symfony\Component\Form\ChoiceList\ArrayKeyChoiceList
class has been removed in favor ofSymfony\Component\Form\ChoiceList\ArrayChoiceList
.
FrameworkBundle
-
The
config:debug
,container:debug
,router:debug
,translation:debug
andyaml:lint
commands have been deprecated since Symfony 2.7 and will be removed in Symfony 3.0. Use thedebug:config
,debug:container
,debug:router
,debug:translation
andlint:yaml
commands instead. -
The
getRequest
method of the baseController
class has been deprecated since Symfony 2.4 and must be therefore removed in 3.0. The only reliable way to get theRequest
object is to inject it in the action method.Before:
namespace Acme\FooBundle\Controller; class DemoController { public function showAction() { $request = $this->getRequest(); // ... } }
After:
namespace Acme\FooBundle\Controller; use Symfony\Component\HttpFoundation\Request; class DemoController { public function showAction(Request $request) { // ... } }
-
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:
$form->add('status', 'choice', array( 'choices' => array( 'Enabled' => Status::ENABLED, 'Disabled' => Status::DISABLED, 'Ignored' => Status::IGNORED, ), // choices_as_values defaults to true in Symfony 3.0 // and setting it to anything else is deprecated as of 3.0 '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:
$form->add('status', ChoiceType::class, array( 'choices' => array( 'Enabled' => Status::ENABLED, 'Disabled' => Status::DISABLED, 'Ignored' => Status::IGNORED, ) ));
-
The
request
service was removed. You must inject therequest_stack
service instead. -
The
enctype
method of theform
helper was removed. You should use the new methodstart
instead.Before:
<form method="post" action="http://example.com" <?php echo $view['form']->enctype($form) ?>> ... </form>
After:
<?php echo $view['form']->start($form) ?> ... <?php echo $view['form']->end($form) ?>
The method and action of the form default to "POST" and the current document. If you want to change these values, you can set them explicitly in the controller.
Alternative 1:
$form = $this->createForm('my_form', $formData, array( 'method' => 'PUT', 'action' => $this->generateUrl('target_route'), ));
Alternative 2:
$form = $this->createFormBuilder($formData) // ... ->setMethod('PUT') ->setAction($this->generateUrl('target_route')) ->getForm();
It is also possible to override the method and the action in the template:
<?php echo $view['form']->start($form, array('method' => 'GET', 'action' => 'http://example.com')) ?> ... <?php echo $view['form']->end($form) ?>
-
The
RouterApacheDumperCommand
was removed. -
The
templating.helper.router
service was moved totemplating_php.xml
. You have to ensure that the PHP templating engine is enabled to be able to use it:framework: templating: engines: ['php']
-
The
form.csrf_provider
service is removed as it implements an adapter for the new token manager to the deprecatedSymfony\Component\Form\Extension\Csrf\CsrfProvider\CsrfProviderInterface
interface. Thesecurity.csrf.token_manager
should be used instead. -
The
validator.mapping.cache.apc
service has been removed in favor of thevalidator.mapping.cache.doctrine.apc
one. -
The ability to pass
apc
as theframework.validation.cache
configuration key value has been removed. Usevalidator.mapping.cache.doctrine.apc
instead:Before:
framework: validation: cache: apc
After:
framework: validation: cache: validator.mapping.cache.doctrine.apc
HttpKernel
-
The
Symfony\Component\HttpKernel\Log\LoggerInterface
has been removed in favor ofPsr\Log\LoggerInterface
. The only difference is that some method names are different:Old name New name emerg()
emergency()
crit()
critical()
err()
error()
warn()
warning()
The previous method renames also happened to the following classes:
Symfony\Bridge\Monolog\Logger
Symfony\Component\HttpKernel\Log\NullLogger
-
The
Symfony\Component\HttpKernel\Kernel::init()
method has been removed. -
The following classes have been renamed as they have been moved to the Debug component:
Old name New name Symfony\Component\HttpKernel\Debug\ErrorHandler
Symfony\Component\Debug\ErrorHandler
Symfony\Component\HttpKernel\Debug\ExceptionHandler
Symfony\Component\Debug\ExceptionHandler
Symfony\Component\HttpKernel\Exception\FatalErrorException
Symfony\Component\Debug\Exception\FatalErrorException
Symfony\Component\HttpKernel\Exception\FlattenException
Symfony\Component\Debug\Exception\FlattenException
-
The
Symfony\Component\HttpKernel\EventListener\ExceptionListener
now passes the Request format as the_format
argument instead offormat
. -
The
Symfony\Component\HttpKernel\DependencyInjection\RegisterListenersPass
has been renamed toSymfony\Component\EventDispatcher\DependencyInjection\RegisterListenersPass
and moved to the EventDispatcher component.
Locale
- The Locale component was removed and replaced by the Intl component.
Instead of the methods in
Symfony\Component\Locale\Locale
, you should use these equivalent methods inSymfony\Component\Intl\Intl
now:Old way New way Locale::getDisplayCountries()
Intl::getRegionBundle()->getCountryNames()
Locale::getCountries()
array_keys(Intl::getRegionBundle()->getCountryNames())
Locale::getDisplayLanguages()
Intl::getLanguageBundle()->getLanguageNames()
Locale::getLanguages()
array_keys(Intl::getLanguageBundle()->getLanguageNames())
Locale::getDisplayLocales()
Intl::getLocaleBundle()->getLocaleNames()
Locale::getLocales()
array_keys(Intl::getLocaleBundle()->getLocaleNames())
PropertyAccess
-
Renamed
PropertyAccess::getPropertyAccessor
tocreatePropertyAccessor
.Before:
use Symfony\Component\PropertyAccess\PropertyAccess; $accessor = PropertyAccess::getPropertyAccessor();
After:
use Symfony\Component\PropertyAccess\PropertyAccess; $accessor = PropertyAccess::createPropertyAccessor();
Routing
-
Some route settings have been renamed:
- The
pattern
setting has been removed in favor ofpath
- The
_scheme
and_method
requirements have been moved to theschemes
andmethods
settings
Before:
article_edit: pattern: /article/{id} requirements: { '_method': 'POST|PUT', '_scheme': 'https', 'id': '\d+' }
<route id="article_edit" pattern="/article/{id}"> <requirement key="_method">POST|PUT</requirement> <requirement key="_scheme">https</requirement> <requirement key="id">\d+</requirement> </route>
$route = new Route(); $route->setPattern('/article/{id}'); $route->setRequirement('_method', 'POST|PUT'); $route->setRequirement('_scheme', 'https');
After:
article_edit: path: /article/{id} methods: [POST, PUT] schemes: https requirements: { 'id': '\d+' }
<route id="article_edit" path="/article/{id}" methods="POST PUT" schemes="https"> <requirement key="id">\d+</requirement> </route>
$route = new Route(); $route->setPath('/article/{id}'); $route->setMethods(array('POST', 'PUT')); $route->setSchemes('https');
- The
-
The
ApacheMatcherDumper
andApacheUrlMatcher
were removed since the performance gains were minimal and it's hard to replicate the behaviour of PHP implementation. -
The
getMatcherDumperInstance()
andgetGeneratorDumperInstance()
methods in theSymfony\Component\Routing\Router
have been changed frompublic
toprotected
.
Security
-
The
AbstractVoter
class was removed in favor of the newVoter
class. -
The
VoterInterface::supportsClass
andsupportsAttribute
methods were removed from the interface. -
The
Resources/
directory was moved toCore/Resources/
-
The
key
settings ofanonymous
,remember_me
andhttp_digest
are renamed tosecret
.Before:
security: # ... firewalls: default: # ... anonymous: { key: "%secret%" } remember_me: key: "%secret%" http_digest: key: "%secret%"
<!-- ... --> <config> <!-- ... --> <firewall> <!-- ... --> <anonymous key="%secret%"/> <remember-me key="%secret%"/> <http-digest key="%secret%"/> </firewall> </config>
// ... $container->loadFromExtension('security', array( // ... 'firewalls' => array( // ... 'anonymous' => array('key' => '%secret%'), 'remember_me' => array('key' => '%secret%'), 'http_digest' => array('key' => '%secret%'), ), ));
After:
security: # ... firewalls: default: # ... anonymous: { secret: "%secret%" } remember_me: secret: "%secret%" http_digest: secret: "%secret%"
<!-- ... --> <config> <!-- ... --> <firewall> <!-- ... --> <anonymous secret="%secret%"/> <remember-me secret="%secret%"/> <http-digest secret="%secret%"/> </firewall> </config>
// ... $container->loadFromExtension('security', array( // ... 'firewalls' => array( // ... 'anonymous' => array('secret' => '%secret%'), 'remember_me' => array('secret' => '%secret%'), 'http_digest' => array('secret' => '%secret%'), ), ));
* The `AbstractVoter::getSupportedAttributes()` and `AbstractVoter::getSupportedClasses()`
methods have been removed in favor of `AbstractVoter::supports()`.
Before:
```php
class MyVoter extends AbstractVoter
{
protected function getSupportedAttributes()
{
return array('CREATE', 'EDIT');
}
protected function getSupportedClasses()
{
return array('AppBundle\Entity\Post');
}
// ...
}
After:
class MyVoter extends AbstractVoter
{
protected function supports($attribute, $object)
{
return $object instanceof Post && in_array($attribute, array('CREATE', 'EDIT'));
}
// ...
}
-
The
intention
option was renamed tocsrf_token_id
for all the authentication listeners. -
The
csrf_provider
option was renamed tocsrf_token_generator
for all the authentication listeners.
SecurityBundle
-
The
intention
firewall listener setting was renamed tocsrf_token_id
. -
The
csrf_provider
firewall listener setting was renamed tocsrf_token_generator
.
Serializer
-
The
setCamelizedAttributes()
method of theSymfony\Component\Serializer\Normalizer\GetSetMethodNormalizer
andSymfony\Component\Serializer\Normalizer\PropertyNormalizer
classes was removed. -
The
Symfony\Component\Serializer\Exception\Exception
interface was removed in favor of the newSymfony\Component\Serializer\Exception\ExceptionInterface
.
Translator
-
The
Translator::setFallbackLocale()
method has been removed in favor ofTranslator::setFallbackLocales()
. -
The
getMessages()
method of theSymfony\Component\Translation\Translator
class was removed. You should use thegetCatalogue()
method of theSymfony\Component\Translation\TranslatorBagInterface
.
Twig Bridge
-
The
twig:lint
command has been deprecated since Symfony 2.7 and will be removed in Symfony 3.0. Use thelint:twig
command instead. -
The
render
tag is deprecated in favor of therender
function. -
The
form_enctype
helper was removed. You should use the newform_start
function instead.Before:
<form method="post" action="http://example.com" {{ form_enctype(form) }}> ... </form>
After:
{{ form_start(form) }} ... {{ form_end(form) }}
The method and action of the form default to "POST" and the current document. If you want to change these values, you can set them explicitly in the controller.
Alternative 1:
$form = $this->createForm('my_form', $formData, array( 'method' => 'PUT', 'action' => $this->generateUrl('target_route'), ));
Alternative 2:
$form = $this->createFormBuilder($formData) // ... ->setMethod('PUT') ->setAction($this->generateUrl('target_route')) ->getForm();
It is also possible to override the method and the action in the template:
{{ form_start(form, {'method': 'GET', 'action': 'http://example.com'}) }} ... {{ form_end(form) }}
TwigBundle
-
The
Symfony\Bundle\TwigBundle\TwigDefaultEscapingStrategy
was removed in favor ofTwig_FileExtensionEscapingStrategy
. -
The
twig:debug
command has been deprecated since Symfony 2.7 and will be removed in Symfony 3.0. Use thedebug:twig
command instead.
Validator
-
The PHP7-incompatible constraints (
Null
,True
,False
) and their related validators (NullValidator
,TrueValidator
,FalseValidator
) have been removed in favor of theirIs
-prefixed equivalent. -
The class
Symfony\Component\Validator\Mapping\Cache\ApcCache
has been removed in favor ofSymfony\Component\Validator\Mapping\Cache\DoctrineCache
.Before:
use Symfony\Component\Validator\Mapping\Cache\ApcCache; $cache = new ApcCache('symfony.validator');
After:
use Symfony\Component\Validator\Mapping\Cache\DoctrineCache; use Doctrine\Common\Cache\ApcCache; $apcCache = new ApcCache(); $apcCache->setNamespace('symfony.validator'); $cache = new DoctrineCache($apcCache);
-
The constraints
Optional
andRequired
were moved to theSymfony\Component\Validator\Constraints\
namespace. You should adapt the path wherever you used them.Before:
use Symfony\Component\Validator\Constraints as Assert; /** * @Assert\Collection({ * "foo" = @Assert\Collection\Required(), * "bar" = @Assert\Collection\Optional(), * }) */ private $property;
After:
use Symfony\Component\Validator\Constraints as Assert; /** * @Assert\Collection({ * "foo" = @Assert\Required(), * "bar" = @Assert\Optional(), * }) */ private $property;
-
The option "
methods
" of theCallback
constraint was removed. You should use the option "callback
" instead. If you have multiple callbacks, add multiple callback constraints instead.Before (YAML):
constraints: - Callback: [firstCallback, secondCallback]
After (YAML):
constraints: - Callback: firstCallback - Callback: secondCallback
When using annotations, you can now put the
Callback
constraint directly on the method that should be executed.Before (Annotations):
use Symfony\Component\Validator\Constraints as Assert; use Symfony\Component\Validator\ExecutionContextInterface; /** * @Assert\Callback({"callback"}) */ class MyClass { public function callback(ExecutionContextInterface $context) { // ... } }
After (Annotations):
use Symfony\Component\Validator\Constraints as Assert; use Symfony\Component\Validator\ExecutionContextInterface; class MyClass { /** * @Assert\Callback */ public function callback(ExecutionContextInterface $context) { // ... } }
-
The interface
ValidatorInterface
was replaced by the more powerful interfaceValidator\ValidatorInterface
. The signature of thevalidate()
method is slightly different in that interface and accepts a value, zero or more constraints and validation group. It replaces bothvalidate()
andvalidateValue()
in the previous interface.Before:
$validator->validate($object, 'Strict'); $validator->validateValue($value, new NotNull());
After:
$validator->validate($object, null, 'Strict'); $validator->validate($value, new NotNull());
Apart from this change, the new methods
startContext()
andinContext()
were added. The first of them allows to run multiple validations in the same context and aggregate their violations:$violations = $validator->startContext() ->atPath('firstName')->validate($firstName, new NotNull()) ->atPath('age')->validate($age, new Type('integer')) ->getViolations();
The second allows to run validation in an existing context. This is especially useful when calling the validator from within constraint validators:
$validator->inContext($context)->validate($object);
Instead of a
Validator
, the validator builder now returns aValidator\RecursiveValidator
instead. -
The interface
ValidationVisitorInterface
and its implementationValidationVisitor
were removed. The implementation of the visitor pattern was flawed. Fixing that implementation would have drastically slowed down the validator execution, so the visitor was removed completely instead.Along with the visitor, the method
accept()
was removed fromMetadataInterface
. -
The interface
MetadataInterface
was moved to theMapping
namespace.Before:
use Symfony\Component\Validator\MetadataInterface;
After:
use Symfony\Component\Validator\Mapping\MetadataInterface;
The methods
getCascadingStrategy()
andgetTraversalStrategy()
were added to the interface. The first method should return a bit mask of the constants in classCascadingStrategy
. The second should return a bit mask of the constants inTraversalStrategy
.Example:
use Symfony\Component\Validator\Mapping\TraversalStrategy; public function getTraversalStrategy() { return TraversalStrategy::TRAVERSE; }
-
The interface
PropertyMetadataInterface
was moved to theMapping
namespace.Before:
use Symfony\Component\Validator\PropertyMetadataInterface;
After:
use Symfony\Component\Validator\Mapping\PropertyMetadataInterface;
-
The interface
PropertyMetadataContainerInterface
was moved to theMapping
namespace and renamed toClassMetadataInterface
.Before:
use Symfony\Component\Validator\PropertyMetadataContainerInterface;
After:
use Symfony\Component\Validator\Mapping\ClassMetadataInterface;
The interface now contains four additional methods:
getConstrainedProperties()
hasGroupSequence()
getGroupSequence()
isGroupSequenceProvider()
See the inline documentation of these methods for more information.
-
The interface
ClassBasedInterface
was removed. You should useMapping\ClassMetadataInterface
instead:Before:
use Symfony\Component\Validator\ClassBasedInterface; class MyClassMetadata implements ClassBasedInterface { // ... }
After:
use Symfony\Component\Validator\Mapping\ClassMetadataInterface; class MyClassMetadata implements ClassMetadataInterface { // ... }
-
The class
ElementMetadata
was renamed toGenericMetadata
.Before:
use Symfony\Component\Validator\Mapping\ElementMetadata; class MyMetadata extends ElementMetadata { }
After:
use Symfony\Component\Validator\Mapping\GenericMetadata; class MyMetadata extends GenericMetadata { }
-
The interface
ExecutionContextInterface
and its implementationExecutionContext
were moved to theContext
namespace.Before:
use Symfony\Component\Validator\ExecutionContextInterface;
After:
use Symfony\Component\Validator\Context\ExecutionContextInterface;
The interface now contains the following additional methods:
getValidator()
getObject()
setNode()
setGroup()
markGroupAsValidated()
isGroupValidated()
markConstraintAsValidated()
isConstraintValidated()
See the inline documentation of these methods for more information.
The method
addViolationAt()
was removed. You should usebuildViolation()
instead.Before:
$context->addViolationAt('property', 'The value {{ value }} is invalid.', array( '{{ value }}' => $invalidValue, ));
After:
$context->buildViolation('The value {{ value }} is invalid.') ->atPath('property') ->setParameter('{{ value }}', $invalidValue) ->addViolation();
The methods
validate()
andvalidateValue()
were removed. You should usegetValidator()
together withinContext()
instead.Before:
$context->validate($object);
After:
$context->getValidator() ->inContext($context) ->validate($object);
The parameters
$invalidValue
,$plural
and$code
were removed fromaddViolation()
. You should usebuildViolation()
instead. See above for an example.The method
getMetadataFactory()
was removed. You can usegetValidator()
instead and use the methodsgetMetadataFor()
orhasMetadataFor()
on the validator instance.Before:
$metadata = $context->getMetadataFactory()->getMetadataFor($myClass);
After:
$metadata = $context->getValidator()->getMetadataFor($myClass);
-
The interface
GlobalExecutionContextInterface
was removed. Most of the information provided by that interface can be queried fromContext\ExecutionContextInterface
instead. -
The interface
MetadataFactoryInterface
was moved to theMapping\Factory
namespace along with its implementationsBlackholeMetadataFactory
andClassMetadataFactory
. These classes were furthermore renamed toBlackHoleMetadataFactory
andLazyLoadingMetadataFactory
.Before:
use Symfony\Component\Validator\Mapping\ClassMetadataFactory; $factory = new ClassMetadataFactory($loader);
After:
use Symfony\Component\Validator\Mapping\Factory\LazyLoadingMetadataFactory; $factory = new LazyLoadingMetadataFactory($loader);
-
The option
$deep
was removed from the constraintValid
. When traversing arrays, nested arrays are always traversed (same behavior as before). When traversing nested objects, their traversal strategy is used. -
The method
ValidatorBuilder::setPropertyAccessor()
was removed. The validator now functions without a property accessor. -
The methods
getMessageParameters()
andgetMessagePluralization()
inConstraintViolation
were renamed togetParameters()
andgetPlural()
.Before:
$parameters = $violation->getMessageParameters(); $plural = $violation->getMessagePluralization();
After:
$parameters = $violation->getParameters(); $plural = $violation->getPlural();
-
The class
Symfony\Component\Validator\DefaultTranslator
was removed. You should useSymfony\Component\Translation\IdentityTranslator
instead.Before:
$translator = new \Symfony\Component\Validator\DefaultTranslator();
After:
$translator = new \Symfony\Component\Translation\IdentityTranslator(); $translator->setLocale('en');
Yaml
-
Using a colon in an unquoted mapping value leads to a
ParseException
. -
Starting an unquoted string with
@
,`
,|
, or>
leads to aParseException
. -
When surrounding strings with double-quotes, you must now escape
\
characters. Not escaping those characters (when surrounded by double-quotes) leads to aParseException
.Before:
class: "Foo\Var"
After:
class: "Foo\\Var"
-
The ability to pass file names to
Yaml::parse()
has been removed.Before:
Yaml::parse($fileName);
After:
Yaml::parse(file_get_contents($fileName));
WebProfiler
-
The
profiler:import
andprofiler:export
commands have been deprecated and will be removed in 3.0. -
All the profiler storages different than
FileProfilerStorage
have been removed. The removed 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
Process
Process::setStdin()
andProcess::getStdin()
have been removed. UseProcess::setInput()
andProcess::getInput()
that works the same way.Process::setInput()
andProcessBuilder::setInput()
do not accept non-scalar types.