2013-01-15 07:06:36 +00:00
UPGRADE FROM 2.x to 3.0
=======================
2013-02-08 13:02:12 +00:00
### ClassLoader
2013-03-20 17:09:46 +00:00
* The `UniversalClassLoader` class has been removed in favor of
`ClassLoader` . The only difference is that some method names are different:
2013-02-08 13:02:12 +00:00
2014-11-18 08:38:51 +00:00
| Old name | New name
| -------- | ---
| `registerNamespaces()` | `addPrefixes()`
| `registerPrefixes()` | `addPrefixes()`
| `registerNamespaces()` | `addPrefix()`
| `registerPrefixes()` | `addPrefix()`
| `getNamespaces()` | `getPrefixes()`
| `getNamespaceFallbacks()` | `getFallbackDirs()`
| `getPrefixFallbacks()` | `getFallbackDirs()`
2013-02-08 13:02:12 +00:00
* The `DebugUniversalClassLoader` class has been removed in favor of
`DebugClassLoader` . The difference is that the constructor now takes a
loader to wrap.
2014-02-07 16:08:27 +00:00
### Console
2013-12-13 13:43:58 +00:00
* The `dialog` helper has been removed in favor of the `question` helper.
2014-02-07 16:08:27 +00:00
* The methods `isQuiet` , `isVerbose` , `isVeryVerbose` and `isDebug` were added
2014-02-24 15:17:08 +00:00
to `Symfony\Component\Console\Output\OutputInterface` .
2014-02-07 16:08:27 +00:00
2014-03-01 04:11:27 +00:00
* `ProgressHelper` has been removed in favor of `ProgressBar` .
Before:
2014-11-18 08:38:51 +00:00
```php
2014-03-01 04:11:27 +00:00
$h = new ProgressHelper();
$h->start($output, 10);
for ($i = 1; $i < 5 ; $ i + + ) {
usleep(200000);
$h->advance();
}
$h->finish();
```
After:
2014-11-18 08:38:51 +00:00
```php
2014-03-01 04:11:27 +00:00
$bar = new ProgressBar($output, 10);
$bar->start();
for ($i = 1; $i < 5 ; $ i + + ) {
usleep(200000);
$bar->advance();
}
```
2014-03-03 10:06:26 +00:00
* `TableHelper` has been removed in favor of `Table` .
Before:
2014-11-18 08:38:51 +00:00
```php
2014-03-03 10:06:26 +00:00
$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:
2014-11-18 08:38:51 +00:00
```php
2014-03-03 10:06:26 +00:00
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();
```
2014-11-18 08:38:51 +00:00
### DependencyInjection
* The methods `Definition::setFactoryClass()` ,
`Definition::setFactoryMethod()` , and `Definition::setFactoryService()` have
been removed in favor of `Definition::setFactory()` . Services defined using
YAML or XML use the same syntax as configurators.
2013-12-28 19:36:11 +00:00
### EventDispatcher
* The interface `Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcherInterface`
extends `Symfony\Component\EventDispatcher\EventDispatcherInterface` .
2013-04-17 17:47:21 +01:00
### Form
2013-04-20 16:32:55 +01:00
* The methods `Form::bind()` and `Form::isBound()` were removed. You should
use `Form::submit()` and `Form::isSubmitted()` instead.
Before:
2014-09-26 11:51:50 +01:00
```php
2013-04-20 16:32:55 +01:00
$form->bind(array(...));
```
After:
2014-09-26 11:51:50 +01:00
```php
2013-04-20 16:32:55 +01:00
$form->submit(array(...));
```
* Passing a `Symfony\Component\HttpFoundation\Request` instance, as was
supported by `FormInterface::bind()` , is not possible with
`FormInterface::submit()` anymore. You should use `FormInterface::handleRequest()`
instead.
2013-04-17 17:47:21 +01:00
Before:
2014-09-26 11:51:50 +01:00
```php
2013-04-17 17:47:21 +01:00
if ('POST' === $request->getMethod()) {
$form->bind($request);
if ($form->isValid()) {
// ...
}
}
```
After:
2014-09-26 11:51:50 +01:00
```php
2013-04-20 16:32:55 +01:00
$form->handleRequest($request);
2013-04-20 14:56:42 +01:00
if ($form->isValid()) {
2013-04-17 17:47:21 +01:00
// ...
}
```
If you want to test whether the form was submitted separately, you can use
2013-04-20 16:32:55 +01:00
the method `isSubmitted()` :
2013-04-17 17:47:21 +01:00
2014-09-26 11:51:50 +01:00
```php
2013-04-20 16:32:55 +01:00
$form->handleRequest($request);
2013-04-20 14:56:42 +01:00
2013-04-20 16:32:55 +01:00
if ($form->isSubmitted()) {
2013-04-17 17:47:21 +01:00
// ...
if ($form->isValid()) {
// ...
}
}
```
2014-11-18 08:38:51 +00:00
* The events `PRE_BIND` , `BIND` and `POST_BIND` were renamed to `PRE_SUBMIT` , `SUBMIT`
and `POST_SUBMIT` .
2013-04-20 16:32:55 +01:00
Before:
2014-09-26 11:51:50 +01:00
```php
2013-04-20 16:32:55 +01:00
$builder->addEventListener(FormEvents::PRE_BIND, function (FormEvent $event) {
// ...
});
```
After:
2014-09-26 11:51:50 +01:00
```php
2013-04-20 16:32:55 +01:00
$builder->addEventListener(FormEvents::PRE_SUBMIT, function (FormEvent $event) {
// ...
});
```
2014-11-18 08:38:51 +00:00
* The option "`virtual`" was renamed to "`inherit_data`".
2013-01-04 15:34:38 +00:00
Before:
2014-09-26 11:51:50 +01:00
```php
2013-01-04 15:34:38 +00:00
$builder->add('address', 'form', array(
'virtual' => true,
));
```
After:
2014-09-26 11:51:50 +01:00
```php
2013-01-04 15:34:38 +00:00
$builder->add('address', 'form', array(
'inherit_data' => true,
));
```
2014-11-18 08:38:51 +00:00
* The class `VirtualFormAwareIterator` was renamed to `InheritDataAwareIterator` .
2013-01-04 15:34:38 +00:00
Before:
2014-09-26 11:51:50 +01:00
```php
2013-01-04 15:34:38 +00:00
use Symfony\Component\Form\Util\VirtualFormAwareIterator;
$iterator = new VirtualFormAwareIterator($forms);
```
After:
2014-09-26 11:51:50 +01:00
```php
2013-01-04 15:34:38 +00:00
use Symfony\Component\Form\Util\InheritDataAwareIterator;
$iterator = new InheritDataAwareIterator($forms);
```
2013-04-28 10:04:40 +01:00
* The `TypeTestCase` class was moved from the `Symfony\Component\Form\Tests\Extension\Core\Type` namespace to the `Symfony\Component\Form\Test` namespace.
2013-09-10 13:28:39 +01:00
2013-04-28 10:04:40 +01:00
Before:
2014-09-26 11:51:50 +01:00
```php
2013-04-28 10:04:40 +01:00
use Symfony\Component\Form\Tests\Extension\Core\Type\TypeTestCase
class MyTypeTest extends TypeTestCase
{
// ...
}
```
After:
2014-09-26 11:51:50 +01:00
```php
2013-04-28 10:04:40 +01:00
use Symfony\Component\Form\Test\TypeTestCase;
class MyTypeTest extends TypeTestCase
{
// ...
}
```
2013-08-23 22:58:13 +01:00
* The `FormIntegrationTestCase` and `FormPerformanceTestCase` classes were moved form the `Symfony\Component\Form\Tests` namespace to the `Symfony\Component\Form\Test` namespace.
2013-04-28 10:04:40 +01:00
2013-08-01 14:31:18 +01:00
* The constants `ROUND_HALFEVEN` , `ROUND_HALFUP` and `ROUND_HALFDOWN` in class
`NumberToLocalizedStringTransformer` were renamed to `ROUND_HALF_EVEN` ,
`ROUND_HALF_UP` and `ROUND_HALF_DOWN` .
2013-09-10 13:28:39 +01:00
* The methods `ChoiceListInterface::getIndicesForChoices()` and
`ChoiceListInterface::getIndicesForValues()` were removed. No direct
replacement exists, although in most cases
`ChoiceListInterface::getChoicesForValues()` and
`ChoiceListInterface::getValuesForChoices()` should be sufficient.
2013-09-27 08:37:01 +01:00
* The interface `Symfony\Component\Form\Extension\Csrf\CsrfProvider\CsrfProviderInterface`
and all of its implementations were removed. Use the new interface
2013-10-04 14:25:38 +01:00
`Symfony\Component\Security\Csrf\CsrfTokenManagerInterface` instead.
2013-09-27 08:37:01 +01:00
2014-11-20 13:22:25 +00:00
* The options "`csrf_provider`" and "`intention`" were renamed to "`csrf_token_generator`"
2014-11-18 08:38:51 +00:00
and "`csrf_token_id`".
2013-09-27 08:37:01 +01:00
2013-12-31 16:24:28 +00:00
* The method `Form::getErrorsAsString()` was removed. Use `Form::getErrors()`
2014-01-10 12:53:52 +00:00
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).
2013-12-31 16:24:28 +00:00
Before:
2014-11-18 08:38:51 +00:00
```php
2013-12-31 16:24:28 +00:00
echo $form->getErrorsAsString();
```
After:
2014-11-18 08:38:51 +00:00
```php
2014-01-10 12:53:52 +00:00
echo $form->getErrors(true, false);
2013-12-31 16:24:28 +00:00
```
2014-11-20 13:22:25 +00:00
```php
echo $form->getErrors(true, false);
```
2013-04-28 10:04:40 +01:00
2013-04-17 17:47:21 +01:00
### FrameworkBundle
2013-11-20 15:09:21 +00:00
* The `getRequest` method of the base `Controller` class has been deprecated
since Symfony 2.4 and must be therefore removed in 3.0. The only reliable
way to get the `Request` object is to inject it in the action method.
Before:
2014-11-18 08:38:51 +00:00
```php
2013-11-20 15:09:21 +00:00
namespace Acme\FooBundle\Controller;
class DemoController
{
public function showAction()
{
$request = $this->getRequest();
// ...
}
}
```
After:
2014-11-18 08:38:51 +00:00
```php
2013-11-20 15:09:21 +00:00
namespace Acme\FooBundle\Controller;
use Symfony\Component\HttpFoundation\Request;
class DemoController
{
public function showAction(Request $request)
{
// ...
}
}
```
2013-10-09 07:28:55 +01:00
* The `request` service was removed. You must inject the `request_stack`
service instead.
2013-04-17 17:47:21 +01:00
* The `enctype` method of the `form` helper was removed. You should use the
new method `start` instead.
Before:
2014-09-26 11:51:50 +01:00
```php
2013-04-17 17:47:21 +01:00
< form method = "post" action = "http://example.com" < ? php echo $ view [ ' form ' ] - > enctype($form) ?>>
...
< / form >
```
After:
2014-09-26 11:51:50 +01:00
```php
2013-04-17 17:47:21 +01:00
<?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:
2014-09-26 11:51:50 +01:00
```php
2013-04-17 17:47:21 +01:00
$form = $this->createForm('my_form', $formData, array(
'method' => 'PUT',
'action' => $this->generateUrl('target_route'),
));
```
Alternative 2:
2014-09-26 11:51:50 +01:00
```php
2013-04-17 17:47:21 +01:00
$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:
2014-09-26 11:51:50 +01:00
```php
2013-04-17 17:47:21 +01:00
<?php echo $view['form']->start($form, array('method' => 'GET', 'action' => 'http://example.com')) ?>
...
<?php echo $view['form']->end($form) ?>
```
2014-01-08 22:03:56 +00:00
* The `RouterApacheDumperCommand` was removed.
2014-11-29 10:54:37 +00:00
* The `createEsi` method of `Symfony\Bundle\FrameworkBundle\HttpCache\HttpCache` was removed. Use `createSurrogate` instead.
2013-01-16 22:09:43 +00:00
### HttpKernel
* The `Symfony\Component\HttpKernel\Log\LoggerInterface` has been removed in
favor of `Psr\Log\LoggerInterface` . The only difference is that some method
names are different:
2014-11-18 08:38:51 +00:00
| Old name | New name
| -------- | ---
| `emerg()` | `emergency()`
| `crit()` | `critical()`
| `err()` | `error()`
| `warn()` | `warning()`
2013-01-16 22:09:43 +00:00
The previous method renames also happened to the following classes:
2013-01-17 14:01:21 +00:00
* `Symfony\Bridge\Monolog\Logger`
* `Symfony\Component\HttpKernel\Log\NullLogger`
2013-01-16 22:09:43 +00:00
2013-03-20 17:09:46 +00:00
* 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:
2014-11-18 08:38:51 +00:00
| 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`
2013-03-20 17:09:46 +00:00
2013-08-22 04:08:01 +01:00
* The `Symfony\Component\HttpKernel\EventListener\ExceptionListener` now
passes the Request format as the `_format` argument instead of `format` .
2013-12-16 17:44:05 +00:00
* The `Symfony\Component\HttpKernel\DependencyInjection\RegisterListenersPass` has been renamed to
`Symfony\Component\EventDispatcher\DependencyInjection\RegisterListenersPass` and moved to the EventDispatcher component.
2013-04-28 10:04:40 +01:00
### Locale
2013-04-12 16:49:02 +01:00
2013-04-28 10:04:40 +01:00
* 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 in `Symfony\Component\Intl\Intl` now:
2013-09-10 13:28:39 +01:00
2014-11-18 08:38:51 +00:00
| 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())`
2013-04-19 13:16:57 +01:00
2013-04-25 17:28:27 +01:00
### PropertyAccess
* Renamed `PropertyAccess::getPropertyAccessor` to `createPropertyAccessor` .
Before:
2014-09-26 11:51:50 +01:00
```php
2013-04-25 17:28:27 +01:00
use Symfony\Component\PropertyAccess\PropertyAccess;
$accessor = PropertyAccess::getPropertyAccessor();
```
After:
2014-09-26 11:51:50 +01:00
```php
2013-04-25 17:28:27 +01:00
use Symfony\Component\PropertyAccess\PropertyAccess;
$accessor = PropertyAccess::createPropertyAccessor();
```
2013-01-15 07:06:36 +00:00
### Routing
* Some route settings have been renamed:
2013-01-17 14:01:21 +00:00
* The `pattern` setting for a route has been deprecated in favor of `path`
* The `_scheme` and `_method` requirements have been moved to the `schemes` and `methods` settings
2013-01-15 07:06:36 +00:00
Before:
2014-09-26 11:51:50 +01:00
```yaml
2013-01-15 07:06:36 +00:00
article_edit:
pattern: /article/{id}
requirements: { '_method': 'POST|PUT', '_scheme': 'https', 'id': '\d+' }
2014-09-26 11:51:50 +01:00
```
2013-01-15 07:06:36 +00:00
2014-09-26 11:51:50 +01:00
```xml
2013-01-15 07:06:36 +00:00
< route id = "article_edit" pattern = "/article/{id}" >
< requirement key = "_method" > POST|PUT< / requirement >
< requirement key = "_scheme" > https< / requirement >
< requirement key = "id" > \d+</ requirement >
< / route >
2014-09-26 11:51:50 +01:00
```
2013-01-15 07:06:36 +00:00
2014-09-26 11:51:50 +01:00
```php
2013-01-15 07:06:36 +00:00
$route = new Route();
$route->setPattern('/article/{id}');
$route->setRequirement('_method', 'POST|PUT');
$route->setRequirement('_scheme', 'https');
```
After:
2014-09-26 11:51:50 +01:00
```yaml
2013-01-15 07:06:36 +00:00
article_edit:
path: /article/{id}
methods: [POST, PUT]
schemes: https
requirements: { 'id': '\d+' }
2014-09-26 11:51:50 +01:00
```
2013-01-15 07:06:36 +00:00
2014-09-26 11:51:50 +01:00
```xml
2013-01-15 18:31:20 +00:00
< route id = "article_edit" path = "/article/{id}" methods = "POST PUT" schemes = "https" >
2013-01-15 07:06:36 +00:00
< requirement key = "id" > \d+</ requirement >
< / route >
2014-09-26 11:51:50 +01:00
```
2013-01-15 07:06:36 +00:00
2014-09-26 11:51:50 +01:00
```php
2013-01-15 07:06:36 +00:00
$route = new Route();
$route->setPath('/article/{id}');
$route->setMethods(array('POST', 'PUT'));
$route->setSchemes('https');
```
2013-01-17 14:01:21 +00:00
2014-01-08 22:03:56 +00:00
* The `ApacheMatcherDumper` and `ApacheUrlMatcher` were removed since
the performance gains were minimal and it's hard to replicate the behaviour
of PHP implementation.
2013-09-18 08:24:07 +01:00
### Security
* The `Resources/` directory was moved to `Core/Resources/`
2013-02-17 17:30:02 +00:00
### Translator
* The `Translator::setFallbackLocale()` method has been removed in favor of
`Translator::setFallbackLocales()` .
2013-01-28 17:29:00 +00:00
### Twig Bridge
* The `render` tag is deprecated in favor of the `render` function.
2013-04-17 17:47:21 +01:00
* The `form_enctype` helper was removed. You should use the new `form_start`
function instead.
Before:
2014-09-26 11:51:50 +01:00
```php
2013-04-17 17:47:21 +01:00
< form method = "post" action = "http://example.com" { { form_enctype ( form ) } } >
...
< / form >
```
After:
2014-09-26 11:51:50 +01:00
```jinja
2013-04-17 17:47:21 +01:00
{{ 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:
2014-09-26 11:51:50 +01:00
```php
2013-04-17 17:47:21 +01:00
$form = $this->createForm('my_form', $formData, array(
'method' => 'PUT',
'action' => $this->generateUrl('target_route'),
));
```
Alternative 2:
2014-09-26 11:51:50 +01:00
```php
2013-04-17 17:47:21 +01:00
$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:
2014-09-26 11:51:50 +01:00
```jinja
2013-04-17 17:47:21 +01:00
{{ form_start(form, {'method': 'GET', 'action': 'http://example.com'}) }}
...
{{ form_end(form) }}
```
2013-04-17 17:02:12 +01:00
### Validator
2013-12-29 20:44:38 +00:00
* The class `Symfony\Component\Validator\Mapping\Cache\ApcCache` has been removed in favor
of `Symfony\Component\Validator\Mapping\Cache\DoctrineCache` .
Before:
2014-11-18 08:38:51 +00:00
```php
2013-12-29 20:44:38 +00:00
use Symfony\Component\Validator\Mapping\Cache\ApcCache;
$cache = new ApcCache('symfony.validator');
```
After:
2014-11-18 08:38:51 +00:00
```php
2013-12-29 20:44:38 +00:00
use Symfony\Component\Validator\Mapping\Cache\DoctrineCache;
use Doctrine\Common\Cache\ApcCache;
$apcCache = new ApcCache();
$apcCache->setNamespace('symfony.validator');
$cache = new DoctrineCache($apcCache);
```
2013-04-17 17:02:12 +01:00
* The constraints `Optional` and `Required` were moved to the
`Symfony\Component\Validator\Constraints\` namespace. You should adapt
the path wherever you used them.
Before:
2014-09-26 11:51:50 +01:00
```php
2013-04-17 17:02:12 +01:00
use Symfony\Component\Validator\Constraints as Assert;
/**
* @Assert \Collection({
* "foo" = @Assert \Collection\Required(),
* "bar" = @Assert \Collection\Optional(),
* })
*/
private $property;
```
After:
2014-09-26 11:51:50 +01:00
```php
2013-04-17 17:02:12 +01:00
use Symfony\Component\Validator\Constraints as Assert;
/**
* @Assert \Collection({
* "foo" = @Assert \Required(),
* "bar" = @Assert \Optional(),
* })
*/
private $property;
```
2013-04-28 10:04:40 +01:00
2014-11-18 08:38:51 +00:00
* The option "`methods`" of the `Callback` constraint was removed. You should
use the option "`callback`" instead. If you have multiple callbacks, add
2013-09-26 10:03:13 +01:00
multiple callback constraints instead.
Before (YAML):
2014-11-18 08:38:51 +00:00
```yaml
2013-09-26 10:03:13 +01:00
constraints:
- Callback: [firstCallback, secondCallback]
```
After (YAML):
2014-11-18 08:38:51 +00:00
```yaml
2013-09-26 10:03:13 +01:00
constraints:
- Callback: firstCallback
- Callback: secondCallback
```
2014-11-18 08:38:51 +00:00
When using annotations, you can now put the `Callback` constraint directly on
2013-09-26 10:03:13 +01:00
the method that should be executed.
Before (Annotations):
2014-11-18 08:38:51 +00:00
```php
2013-09-26 10:03:13 +01:00
use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Component\Validator\ExecutionContextInterface;
/**
* @Assert \Callback({"callback"})
*/
class MyClass
{
public function callback(ExecutionContextInterface $context)
{
// ...
}
}
```
After (Annotations):
2014-11-18 08:38:51 +00:00
```php
2013-09-26 10:03:13 +01:00
use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Component\Validator\ExecutionContextInterface;
class MyClass
{
/**
* @Assert \Callback
*/
public function callback(ExecutionContextInterface $context)
{
// ...
}
}
```
2014-03-30 19:03:32 +01:00
* The interface `ValidatorInterface` was replaced by the more powerful
interface `Validator\ValidatorInterface` . The signature of the `validate()`
method is slightly different in that interface and accepts a value, zero
or more constraints and validation group. It replaces both
`validate()` and `validateValue()` in the previous interface.
Before:
2014-11-18 08:38:51 +00:00
```php
2014-03-30 19:03:32 +01:00
$validator->validate($object, 'Strict');
$validator->validateValue($value, new NotNull());
```
After:
2014-11-18 08:38:51 +00:00
```php
2014-03-30 19:03:32 +01:00
$validator->validate($object, null, 'Strict');
$validator->validate($value, new NotNull());
```
Apart from this change, the new methods `startContext()` and `inContext()`
were added. The first of them allows to run multiple validations in the
same context and aggregate their violations:
2014-11-18 08:38:51 +00:00
```php
2014-03-30 19:03:32 +01:00
$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:
2014-11-18 08:38:51 +00:00
```php
2014-03-30 19:03:32 +01:00
$validator->inContext($context)->validate($object);
```
Instead of a `Validator` , the validator builder now returns a
`Validator\RecursiveValidator` instead.
* The interface `ValidationVisitorInterface` and its implementation
`ValidationVisitor` 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 from
`MetadataInterface` .
* The interface `MetadataInterface` was moved to the `Mapping` namespace.
Before:
2014-11-18 08:38:51 +00:00
```php
2014-03-30 19:03:32 +01:00
use Symfony\Component\Validator\MetadataInterface;
```
After:
2014-11-18 08:38:51 +00:00
```php
2014-03-30 19:03:32 +01:00
use Symfony\Component\Validator\Mapping\MetadataInterface;
```
The methods `getCascadingStrategy()` and `getTraversalStrategy()` were
added to the interface. The first method should return a bit mask of the
constants in class `CascadingStrategy` . The second should return a bit
mask of the constants in `TraversalStrategy` .
Example:
2014-11-18 08:38:51 +00:00
```php
2014-03-30 19:03:32 +01:00
use Symfony\Component\Validator\Mapping\TraversalStrategy;
public function getTraversalStrategy()
{
return TraversalStrategy::TRAVERSE;
}
```
* The interface `PropertyMetadataInterface` was moved to the `Mapping`
namespace.
Before:
2014-11-18 08:38:51 +00:00
```php
2014-03-30 19:03:32 +01:00
use Symfony\Component\Validator\PropertyMetadataInterface;
```
After:
2014-11-18 08:38:51 +00:00
```php
2014-03-30 19:03:32 +01:00
use Symfony\Component\Validator\Mapping\PropertyMetadataInterface;
```
* The interface `PropertyMetadataContainerInterface` was moved to the `Mapping`
namespace and renamed to `ClassMetadataInterface` .
Before:
2014-11-18 08:38:51 +00:00
```php
2014-03-30 19:03:32 +01:00
use Symfony\Component\Validator\PropertyMetadataContainerInterface;
```
After:
2014-11-18 08:38:51 +00:00
```php
2014-03-30 19:03:32 +01:00
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 use
`Mapping\ClassMetadataInterface` instead:
Before:
2014-11-18 08:38:51 +00:00
```php
2014-03-30 19:03:32 +01:00
use Symfony\Component\Validator\ClassBasedInterface;
class MyClassMetadata implements ClassBasedInterface
{
// ...
}
```
After:
2014-11-18 08:38:51 +00:00
```php
2014-03-30 19:03:32 +01:00
use Symfony\Component\Validator\Mapping\ClassMetadataInterface;
class MyClassMetadata implements ClassMetadataInterface
{
// ...
}
```
* The class `ElementMetadata` was renamed to `GenericMetadata` .
Before:
2014-11-18 08:38:51 +00:00
```php
2014-03-30 19:03:32 +01:00
use Symfony\Component\Validator\Mapping\ElementMetadata;
class MyMetadata extends ElementMetadata
{
}
```
After:
2014-11-18 08:38:51 +00:00
```php
2014-03-30 19:03:32 +01:00
use Symfony\Component\Validator\Mapping\GenericMetadata;
class MyMetadata extends GenericMetadata
{
}
```
* The interface `ExecutionContextInterface` and its implementation
`ExecutionContext` were moved to the `Context` namespace.
Before:
2014-11-18 08:38:51 +00:00
```php
2014-03-30 19:03:32 +01:00
use Symfony\Component\Validator\ExecutionContextInterface;
```
After:
2014-11-18 08:38:51 +00:00
```php
2014-03-30 19:03:32 +01:00
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 use `buildViolation()`
instead.
Before:
2014-11-18 08:38:51 +00:00
```php
2014-03-30 19:03:32 +01:00
$context->addViolationAt('property', 'The value {{ value }} is invalid.', array(
'{{ value }}' => $invalidValue,
));
```
After:
2014-11-18 08:38:51 +00:00
```php
2014-03-30 19:03:32 +01:00
$context->buildViolation('The value {{ value }} is invalid.')
->atPath('property')
->setParameter('{{ value }}', $invalidValue)
->addViolation();
```
The methods `validate()` and `validateValue()` were removed. You should use
`getValidator()` together with `inContext()` instead.
Before:
2014-11-18 08:38:51 +00:00
```php
2014-03-30 19:03:32 +01:00
$context->validate($object);
```
After:
2014-11-18 08:38:51 +00:00
```php
2014-03-30 19:03:32 +01:00
$context->getValidator()
->inContext($context)
->validate($object);
```
The parameters `$invalidValue` , `$plural` and `$code` were removed from
`addViolation()` . You should use `buildViolation()` instead. See above for
an example.
The method `getMetadataFactory()` was removed. You can use `getValidator()`
instead and use the methods `getMetadataFor()` or `hasMetadataFor()` on the
validator instance.
Before:
2014-11-18 08:38:51 +00:00
```php
2014-03-30 19:03:32 +01:00
$metadata = $context->getMetadataFactory()->getMetadataFor($myClass);
```
After:
2014-11-18 08:38:51 +00:00
```php
2014-03-30 19:03:32 +01:00
$metadata = $context->getValidator()->getMetadataFor($myClass);
```
* The interface `GlobalExecutionContextInterface` was removed. Most of the
information provided by that interface can be queried from
`Context\ExecutionContextInterface` instead.
* The interface `MetadataFactoryInterface` was moved to the `Mapping\Factory`
namespace along with its implementations `BlackholeMetadataFactory` and
`ClassMetadataFactory` . These classes were furthermore renamed to
`BlackHoleMetadataFactory` and `LazyLoadingMetadataFactory` .
Before:
2014-11-18 08:38:51 +00:00
```php
2014-03-30 19:03:32 +01:00
use Symfony\Component\Validator\Mapping\ClassMetadataFactory;
$factory = new ClassMetadataFactory($loader);
```
After:
2014-11-18 08:38:51 +00:00
```php
2014-03-30 19:03:32 +01:00
use Symfony\Component\Validator\Mapping\Factory\LazyLoadingMetadataFactory;
$factory = new LazyLoadingMetadataFactory($loader);
```
* The option `$deep` was removed from the constraint `Valid` . 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()` and `getMessagePluralization()` in
`ConstraintViolation` were renamed to `getParameters()` and `getPlural()` .
Before:
2014-11-18 08:38:51 +00:00
```php
2014-03-30 19:03:32 +01:00
$parameters = $violation->getMessageParameters();
$plural = $violation->getMessagePluralization();
```
After:
2014-11-18 08:38:51 +00:00
```php
2014-03-30 19:03:32 +01:00
$parameters = $violation->getParameters();
$plural = $violation->getPlural();
```
2013-04-28 10:04:40 +01:00
### Yaml
* The ability to pass file names to `Yaml::parse()` has been removed.
Before:
2014-09-26 11:51:50 +01:00
```php
2013-04-28 10:04:40 +01:00
Yaml::parse($fileName);
```
After:
2014-09-26 11:51:50 +01:00
```php
2013-04-28 10:04:40 +01:00
Yaml::parse(file_get_contents($fileName));
2014-10-12 17:43:03 +01:00
```
2014-05-17 19:36:38 +01:00
### Process
2014-11-18 08:38:51 +00:00
* `Process::setStdin()` and `Process::getStdin()` have been removed. Use
`Process::setInput()` and `Process::getInput()` that works the same way.
* `Process::setInput()` and `ProcessBuilder::setInput()` do not accept non-scalar types.
2014-11-29 12:38:54 +00:00
### Monolog Bridge
* `Symfony\Bridge\Monolog\Logger::emerg()` was removed. Use `emergency()` which is PSR-3 compatible.
* `Symfony\Bridge\Monolog\Logger::crit()` was removed. Use `critical()` which is PSR-3 compatible.
* `Symfony\Bridge\Monolog\Logger::err()` was removed. Use `error()` which is PSR-3 compatible.
* `Symfony\Bridge\Monolog\Logger::warn()` was removed. Use `warning()` which is PSR-3 compatible.
2014-12-20 00:11:36 +00:00
### Swiftmailer Bridge
* `Symfony\Bridge\Swiftmailer\DataCollector\MessageDataCollector` was removed. Use the `Symfony\Bundle\SwiftmailerBundle\DataCollector\MessageDataCollector` class instead.