Table of contents
Introduction Config Transformer
Config Transformer is a powerful tool that automates the conversion of YAML configuration files to PHP format for Symfony projects. It facilitates the transition to PHP-based configuration, resulting in better performance, IDE support and type safety.
Installation and setup of Config Transformer
Install Config Transformer via Composer:
composer require symplify/config-transformer --dev
After installation, the tool is immediately ready for use.
Configuration and customisation of Config Transformer
As a rule, Config Transformer does not require any special configuration. It automatically adapts to your project structure. However, you can customise some aspects if required:
Create a rector.php file in the root directory of your project for custom rules.
Use command line options for specific conversion tasks.
Use of Config Transformer
Basic commands:
Convert all configuration files in the /config directory:
vendor/bin/config-transformer
Convert specific files or directories:
vendor/bin/config-transformer convert config/packages
Dry run for a preview of the changes:
vendor/bin/config-transformer convert config --dry-run
Convert with specific sets:
vendor/bin/config-transformer convert config --use-set symfony-52
Integration in CI/CD-Pipelines
Integrate Config Transformer into your CI/CD pipeline for automated configuration conversions:
# .gitlab-ci.yml Beispiel
stages:
- transform_config
transform_config:
stage: transform_config
script:
- composer install --no-dev
- vendor/bin/config-transformer convert config
only:
- main
Reach our PHP Consultant specialists
We are experts in PHP and help you to master your digital challenges. Our experienced team supports you with PHP updates, PHP refactoring and advises you remotely on all questions relating to PHP. With our fully automated CI/CD deployments and a robust Docker infrastructure, we take your PHP projects to the next level. Rely on our expertise for reliable and scalable PHP solutions.
Frequently asked questions (FAQ)
Why should I switch from YAML to PHP configurations?
PHP configurations offer better performance, IDE support and type safety.
Will my original YAML files be deleted when converting?
Yes, the original files are deleted by default. Use --dry-run for a secure preview.
Does Config Transformer support all Symfony versions?
Yes, it supports a wide range of Symfony versions, from 2.8 to the latest releases.
Can I undo the conversion process?
There is no direct "Undo" function. Use version control for security.
How do I deal with customised YAML structures?
Config Transformer recognises most structures automatically. For complex cases, you can create customised rules.
Does the tool also support XML configurations?
No, Config Transformer focusses on the conversion from YAML to PHP.
How does Config Transformer handle environment variables in configurations?
Environment variables are recognised correctly and transferred to the PHP format.
Can I only convert certain parts of my configuration?
Yes, you can select specific files or directories for conversion.
How does the conversion affect the performance of my application?
PHP configurations can lead to improved loading time and overall performance.
Is Config Transformer safe for production environments?
Yes, but test the conversion thoroughly in a development environment before using it in production.
Conclusion
Config Transformer is an indispensable tool for Symfony developers who want to modernise their projects and benefit from the advantages of PHP-based configuration. It automates the migration process, saves time and reduces potential errors during manual conversion.
Further resources
Config-Transformer Bildergallerie
Willkommen in unserer Bildergalerie zum Config Transformer, einem leistungsstarken Tool, das Symfony YML-Konfigurationen nahtlos in PHP-Dateien umwandelt. Ob Sie Ihre Codebasis modernisieren oder die Performance Ihrer Symfony-Projekte optimieren möchten – Config Transformer macht es einfach, YAML-Dateien effizient und präzise zu migrieren.
Ein weiterer Vergleich zwischen YAML- und PHP-Konfigurationen, der die automatische Konvertierung von Konfigurationsdateien demonstriert. Oben ist die PHP-Version zu sehen, darunter die ursprüngliche YAML-Datei.
Screenshot des GitHub-Repositories „symplify/config-transformer“. Die Beschreibung lautet „Convert Symfony YAML configs to PHP format“. Zu sehen sind Details wie 212 Sterne, 11 Forks und 10 Mitwirkende.
Ein Vergleich zwischen einer YAML- und PHP-Datei. Die YAML-Datei definiert Parameter, die in der PHP-Datei mit der entsprechenden Struktur und Syntax umgewandelt werden. Der Unterschied wird in einer „begin diff“- und „end diff“-Darstellung gezeigt.
