This PR was merged into the master branch. Discussion ---------- [2.3] [Form] Renamed option "virtual" to "inherit_data" and improved handling of such forms Bug fix: yes Feature addition: yes Backwards compatibility break: yes Symfony2 tests pass: yes Fixes the following tickets: #5899, #5720, #5578 Todo: - License of the code: MIT Documentation PR: symfony/symfony-docs#2107 This PR renames the option "virtual" to "inherit_data" for more clarity (the old option is deprecated and usable until 2.3). It also fixes the behavior of forms having that option set. Forms with that option set will now correctly return their parents' data from `getData()`, `getNormData()` and `getViewData()`. Furthermore, `getPropertyPath()` was fixed for forms that inherit their parent data. Commits -------1290b80
[Form] Fixed the deprecation notes for the "virtual" optionac2ca44
[Form] Moved parent data inheritance from data mappers to Form8ea5e1a
[Form] Renamed option "virtual" to "inherit_data"
8.2 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:registerNamespaces()
->addPrefixes()
registerPrefixes()
->addPrefixes()
registerNamespaces()
->addPrefix()
registerPrefixes()
->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.
Form
-
Passing a
Symfony\Component\HttpFoundation\Request
instance toFormInterface::bind()
was disabled. You should useFormInterface::process()
instead.Before:
if ('POST' === $request->getMethod()) { $form->bind($request); if ($form->isValid()) { // ... } }
After:
if ($form->process($request)->isValid()) { // ... }
If you want to test whether the form was submitted separately, you can use the method
isBound()
:if ($form->process($request)->isBound()) { // ... if ($form->isValid()) { // ... } }
-
The option "virtual" was renamed to "inherit_data".
Before:
$builder->add('address', 'form', array( 'virtual' => true, ));
After:
$builder->add('address', 'form', array( 'inherit_data' => true, ));
-
The class VirtualFormAwareIterator was renamed to InheritDataAwareIterator.
Before:
use Symfony\Component\Form\Util\VirtualFormAwareIterator; $iterator = new VirtualFormAwareIterator($forms);
After:
use Symfony\Component\Form\Util\InheritDataAwareIterator; $iterator = new InheritDataAwareIterator($forms);
FrameworkBundle
-
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) ?>
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: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:
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
Form
-
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
FormItegrationTestCase
andFormPerformanceTestCase
classes were moved form theSymfony\Component\Form\Tests
namespace to theSymfony\Component\Form\Test
namespace.
Routing
-
Some route settings have been renamed:
- The
pattern
setting for a route has been deprecated 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
Translator
- The
Translator::setFallbackLocale()
method has been removed in favor ofTranslator::setFallbackLocales()
.
Twig Bridge
-
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) }}
Yaml
-
The ability to pass file names to
Yaml::parse()
has been removed.Before:
Yaml::parse($fileName);
After:
Yaml::parse(file_get_contents($fileName));
Validator
-
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;