Buy Access to Course
05.

Fix My Deprecations

Share this awesome video!

|

Keep on Learning!

The last step is to find and eliminate the final deprecation warnings. Since the changes to the form system are some of the biggest, navigate to a page with a form. Woh, error!

The type name specified for the service "app.form.type.datetimepicker" does not match the actual name.

Because the way forms are named has changed, I know this has something to do with that. The stack trace points us to BlogController line 149:

// ... lines 1 - 70
public function newAction(Request $request)
{
// ... lines 73 - 76
$form = $this->createForm(new PostType(), $post)
// ... lines 78 - 109
}
// ... lines 111 - 220

And that line points us to PostType. A-ha! The publishedAt field type is still app_datetimepicker:

80 lines | src/AppBundle/Form/PostType.php
// ... lines 1 - 25
class PostType extends AbstractType
{
// ... lines 28 - 30
public function buildForm(FormBuilderInterface $builder, array $options)
{
// ... lines 33 - 42
$builder
// ... lines 44 - 53
->add('publishedAt', 'app_datetimepicker', array(
'label' => 'label.published_at',
))
;
}
// ... lines 59 - 78
}

The upgrade fixer did not fix this type name, because it's custom. Change this to DateTimePickerType::class. Then go back, hit option+enter, and click "Import class" to add the use statement:

71 lines | src/AppBundle/Form/PostType.php
// ... lines 1 - 31
public function buildForm(FormBuilderInterface $builder, array $options)
{
// ... lines 34 - 54
->add('publishedAt', DateTimePickerType::class, array(
// ... line 56
))
;
}
// ... lines 60 - 71

While we're here, BlogController has a problem too. Instead of saying new PostType(), you need to say PostType::class:

// ... lines 1 - 220

Refresh! It works! Open the deprecation notices. There are still 3: one for the problematic AsseticBundle, one for unquoted @ symbols and another because the global _self variable in Twig is deprecated. The _self usage comes from the Symfony Demo itself: it's used in the "Show Code" functionality. Since that's specific to the Symfony Demo, I'll ignore that one.

Finding Unquoted @'s

So let's keep going. Open up app/config/services.yml. Starting in 2.8, you need to surround any string that starts with @ with quotes. Yea, it turns out that @ is a special character, so it was always illegal to have unquoted @ symbols, but the YAML parser was nice and worked anyways. Well, now the YAML parser is super strict, so surround @markdown with single quotes. Do the same around @router:

51 lines | app/config/services.yml
services:
// ... lines 2 - 11
app.twig.app_extension:
// ... lines 13 - 14
arguments: ['@markdown', %app_locales%]
// ... lines 16 - 24
app.redirect_to_preferred_locale_listener:
// ... line 26
arguments: ['@router', %app_locales%, %locale%]
// ... lines 28 - 51

And while you're here, remove the alias from the form.type tag: that's not needed in 3.0:

51 lines | app/config/services.yml
services:
// ... lines 2 - 30
app.form.type.datetimepicker:
class: AppBundle\Form\Type\DateTimePickerType
tags:
- { name: form.type }
// ... lines 35 - 51

Let's see what that did. Go back and clear the cache:

rm -rf var/cache/*

Refresh! Now we're down to 4 deprecations, and two are still coming from unquoted YAML files. Hmm. Look at the stack trace. It's not easy to figure out where this problem is coming from. But look: CodeExplorerExtension::load(): that class lives in our code: inside the CodeExplorerBundle. Open that class:

// ... lines 1 - 21
class CodeExplorerExtension extends Extension
{
public function load(array $configs, ContainerBuilder $container)
{
$loader = new YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
$loader->load('services.yml');
}
}

Inside, we load a services.yml file. Ah, I bet there's an @ symbol inside! And there it is: wrap that string in single quotes:

services:
// ... lines 2 - 8
code_explorer.controller_listener:
class: CodeExplorerBundle\EventListener\ControllerListener
arguments: ['@code_explorer.twig.source_code_extension']
// ... lines 12 - 14

Let's do it again: clear the cache and refresh:

rm -rf var/cache/*

But there's still one unwrapped @ symbol. Look really closely. This time, you can see that the trace starts with a Router::getRouteCollection() followed by a YamlFileLoader. This makes me think that this is coming from a routing.yml file. Open the main one. Of course! Put quotes around the @AppBundle string:

28 lines | app/config/routing.yml
// ... lines 1 - 6
app:
resource: '@AppBundle/Controller/'
// ... lines 9 - 28

Configuration Tweaks

Before you refresh, fix one more: the csrf notice. In this case, a config key was renamed from csrf_provider to csrf_token_generator in security.yml. A lot of changes are like this: simple renames:

46 lines | app/config/security.yml
security:
// ... lines 2 - 14
firewalls:
secured_area:
// ... lines 17 - 25
form_login:
// ... lines 27 - 33
csrf_token_generator: security.csrf.token_manager
// ... lines 35 - 46

Clear the cache and refresh:

rm -rf var/cache/*

And boom! The only deprecation left is coming from our code, but I'm going to ignore it because fixing it isn't very interesting. Refresh one more time to simulate using the cached files. We can still see the other problem we have because AsseticBundle isn't yet compatible with 3.0.

In real life, this will block us from continuing to Symfony 3.0. Outside bundles will be the biggest issue with upgrading. But don't worry! Until then, you have all the features you need on 2.8. Be patient.

In your project, continue going through other sections of your site, looking for - and fixing - more deprecated code. And of course, run your tests: if you have the phpunit bridge installed, you'll get a print-out of deprecated calls hit from your tests.

Once the deprecations are gone: you're ready for 3.0.