How to Switch from YAML/XML Configs to PHP Today with Symplify

2020-07-27

Break-Even Automation

With legacy migrations, we have to handle a lot of processes that are automated. If you work on 1 project for many years, it's a matter of habit to handle it manually. But handling 3 projects a month makes you think, how to automated any repeated work. It's cheaper, faster, and more reliable. The same way the writing tests are.

We made symplify/config-transformer to handle this work for us.

Credit for inspiration first reported bugs, feature feedback, and exceptional test cases goes to archeoprog and Ryan Weaver. Their input helped get the Symplify package to high quality and covered Symfony features I didn't even know. Thank you, guys!

1. Install symplify/config-transformer

composer require symplify/config-transformer --dev

2. Run switch-format Command

This command takes 1 argument - paths to files or directories to convert:

vendor/bin/config-transformer switch-format app/config

This is how my real workflow looks like: from low hanging fruit of 1 file to the main config, to all packages. Each followed by a separated commit, so it's easier to review and fix in case of regression.

vendor/bin/config-transformer switch-format ecs.yaml
# commit

vendor/bin/config-transformer switch-format rector.yaml
# commit

vendor/bin/config-transformer switch-format app/packages
# commit

vendor/bin/config-transformer switch-format app/config/config.yaml
# commit

3. Upgrade paths to PHP in Extensions and Kernel

The config format switch is one part; the next is to update loaders in PHP code. Again, it's valid to handle it manually with search & replace in PHPStorm.

 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
-use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
+use Symfony\Component\DependencyInjection\Loader\PhplFileLoader;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;

 final class SomeExtension extends Extension
 {
     public function load(array $configs, ContainerBuilder $container)
     {
-        $loader = new YamlFileLoader($container, new FileLocator());
+        $loader = new PhplFileLoader($container, new FileLocator());
-        $loader->load(__DIR__ . '/../Resources/config/controller.yaml');
+        $loader->load(__DIR__ . '/../Resources/config/controller.php');
-        $loader->load(__DIR__ . '/../Resources/config/events.yaml');
+        $loader->load(__DIR__ . '/../Resources/config/events.php');
     }
 }

But in case your code is not standard and can't be bothered with correct regular expressions, Rector got you covered:

composer require rector/rector --dev

Setup rector.php:

use Rector\Symfony\Rector\Class_\ChangeFileLoaderInExtensionAndKernelRector;
use Rector\Config\RectorConfig;

return function (RectorConfig $rectorConfig): void {
    $rectorConfig->ruleWithConfiguration(ChangeFileLoaderInExtensionAndKernelRector::class, [
        ChangeFileLoaderInExtensionAndKernelRector::FROM => 'yaml',
        ChangeFileLoaderInExtensionAndKernelRector::TO => 'php',
    ]);
};

And let Rector handle the boring work:

vendor/bin/rector process app src

That's it! One little tool for you, one big leap for a PHP programmer-kind.

Supported Features

• imports
• services
• parameters
• autodiscovery
• instance of
• extensions, e.g. framework, doctrine or twig
• routing

Let Us Know, Help You Grow

Is something broken? Have you found a space for improvement?

Create an issue and let us know. We'd love to hear it.

Happy coding!