Mastering Symfony YAML: From Basics to Advanced Configuration in PHP

What is YAML?

YAML (YAML Ain't Markup Language) is a data‑serialization format designed for human readability and easy parsing by programs. Its concise syntax makes it ideal for configuration files and data exchange.

Symfony YAML Component

The Symfony YAML component is a PHP library that parses YAML into PHP arrays and serialises PHP arrays back to YAML.

Use Cases

Configuration files : Clear, readable format for application settings.

Data exchange : Simple representation of structured data between systems.

Object property mapping : Load YAML data directly into PHP object properties.

Features

Ease of use : Straight‑forward API for parsing and dumping.

Flexibility : Supports anchors, aliases, tags and other YAML constructs.

Robust error handling : Detailed exceptions for malformed input.

Compatibility : Works on PHP 5.6+ and integrates with most modern frameworks.

Basic Usage

Installation

composer require symfony/yaml

Example config.yaml

# Redis configuration
redis:
  master:
    host: '127.0.0.1'
    port: 6379
    password: '123456'

Loading a YAML file

<?php
declare(strict_types=1);
require_once __DIR__.'/../vendor/autoload.php';
use Symfony\Component\Yaml\Yaml;

$yamlContent = Yaml::parseFile(__DIR__.'/../config.yaml');
var_dump($yamlContent);

Parsing a YAML string

<?php
use Symfony\Component\Yaml\Yaml;

$yamlString = 'name: Tinywan';
$parsed = Yaml::parse($yamlString);
var_dump($parsed);

Dumping data to YAML and writing to a file

<?php
$data = [
    'name' => 'Tinywan',
    'age'  => 24,
];

// 3 = indentation level, 2 = inline level
$yamlString = Yaml::dump($data, 3, 2);
$yamlPath   = __DIR__.'/../tinywan.yaml';
file_put_contents($yamlPath, $yamlString, LOCK_EX);

Advanced Usage with Webman Framework

Replace a traditional PHP config file with a YAML file and access values through a helper function.

YAML‑based configuration ( config.yaml )

# Redis configuration
redis:
  master:
    host: '127.0.0.1'
    port: 6379
    password: '123456'

PHP config stub ( config/redis.php )

<?php
return [
    'default' => [
        'host'     => yaml('redis.master.host', '127.0.0.1'),
        'port'     => yaml('redis.master.port', '6379'),
        'password' => yaml('redis.master.password', null),
        'database' => 0,
    ],
];

Custom yaml() helper

Place the function in support/helpers.php or a dedicated file such as support/resty.php and autoload it via composer.json.

/**
 * Retrieve a value from a YAML configuration file.
 *
 * @param string|null $key      Dot‑separated key, e.g. "redis.master.host"
 * @param mixed|null  $default  Value returned when the key is missing
 * @param string|null $path     Path to the YAML file (defaults to base_path('config.yaml'))
 * @param bool        $static   When true, the file is parsed only once per request
 * @return mixed
 */
function yaml(?string $key = null, $default = null, ?string $path = null, bool $static = false)
{
    $path = $path ?? base_path() . DIRECTORY_SEPARATOR . 'config.yaml';
    if (!file_exists($path)) {
        return $default;
    }

    if ($static) {
        static $cache;
        if ($cache === null) {
            $cache = \Symfony\Component\Yaml\Yaml::parseFile($path);
        }
        $data = $cache;
    } else {
        $data = \Symfony\Component\Yaml\Yaml::parseFile($path);
    }

    if ($key === null) {
        return $data;
    }

    $segments = explode('.', $key);
    foreach ($segments as $segment) {
        if (!is_array($data) || !array_key_exists($segment, $data)) {
            return $default;
        }
        $data = $data[$segment];
    }
    return $data;
}

Composer autoload configuration

{
    "autoload": {
        "files": [
            "./support/helpers.php",
            "./support/resty.php"
        ]
    }
}

After editing composer.json, run composer dumpautoload to register the helper.

Testing the configuration

<?php
$config = \config('redis.default');
var_dump($config);

The output reflects the values defined in config.yaml. Changing the YAML file automatically updates the configuration without modifying the PHP stub.

Example of updating the YAML file

# Redis configuration
redis:
  master:
    host: 'dnmp-redis'
    port: 6379
    password: '123456'

Running the test code again will show the new host value, confirming that the helper reads the latest YAML content.