Travailler avec YAML en PHP : la bibliothèque Symfony Yaml…

Travailler avec YAML en PHP : la bibliothèque Symfony Yaml

\n\n

YAML (YAML Ain't Markup Language) est un format de sérialisation de données souvent utilisé pour les fichiers de configuration, la description de structures de données et l'échange d'informations entre services. En PHP, il existe plusieurs solutions pour travailler avec YAML, mais le composant le plus populaire et le plus fonctionnel est Symfony Yaml. Il fournit des méthodes pratiques pour l'analyse (lecture) et le dump (écriture) de données YAML, prend en charge toutes les spécifications YAML 1.2 et est intégré dans de nombreux frameworks, notamment Laravel et Symfony.

\n\n

Dans cet article, nous allons détailler l'installation, les opérations de base et les fonctionnalités avancées de la bibliothèque Symfony Yaml. Vous apprendrez à convertir du YAML en tableaux PHP et vice versa, ainsi qu'à traiter des structures complexes.

\n\n

Installation de la bibliothèque

\n\n

Symfony Yaml s'installe via Composer. Exécutez la commande à la racine de votre projet :

\n\n

composer require symfony/yaml

\n\n

Après l'installation, incluez l'autoloader de Composer et importez les classes nécessaires :

\n\n

require 'vendor/autoload.php';\n\nuse Symfony\\Component\\Yaml\\Yaml;\nuse Symfony\\Component\\Yaml\\Exception\\ParseException;

\n\n

Opérations de base

\n\n

Analyse d'une chaîne YAML

\n\n

La méthode Yaml::parse() convertit une chaîne YAML en tableau PHP. Prenons un exemple avec une configuration simple :

\n\n

$yamlString = "\ndatabase:\n    host: localhost\n    port: 3306\n    name: mydb\n    user: admin\n    password: secret\n";\n\ntry {\n    $data = Yaml::parse($yamlString);\n    print_r($data);\n} catch (ParseException $e) {\n    echo 'Erreur d'analyse YAML : ' . $e->getMessage();\n}

\n\n

Résultat de l'exécution :

\n\n

Array\n(\n    [database] => Array\n        (\n            [host] => localhost\n            [port] => 3306\n            [name] => mydb\n            [user] => admin\n            [password] => secret\n        )\n)

\n\n

Analyse d'un fichier YAML

\n\n

Le plus souvent, le YAML est stocké dans des fichiers. Pour les lire, utilisez file_get_contents() avec l'analyseur :

\n\n

$yamlFile = __DIR__ . '/config.yaml';\nif (!file_exists($yamlFile)) {\n    die('Fichier de configuration introuvable');\n}\n\ntry {\n    $config = Yaml::parse(file_get_contents($yamlFile));\n    echo 'Hôte de la base de données : ' . $config['database']['host'];\n} catch (ParseException $e) {\n    echo 'Erreur de lecture du fichier : ' . $e->getMessage();\n}

\n\n

Dump (écriture) en YAML

\n\n

La méthode Yaml::dump() convertit un tableau PHP en chaîne YAML. C'est utile pour générer des configurations ou exporter des données :

\n\n

$data = [\n    'app' => [\n        'name' => 'MyApp',\n        'version' => '1.0.0',\n        'debug' => true,\n        'modules' => ['auth', 'api', 'admin']\n    ]\n];\n\n$yamlOutput = Yaml::dump($data, 3); // Deuxième paramètre — niveau d'imbrication\nfile_put_contents('app_config.yaml', $yamlOutput);\necho $yamlOutput;

\n\n

Résultat dans le fichier :

\n\n

app:\n    name: MyApp\n    version: '1.0.0'\n    debug: true\n    modules:\n        - auth\n        - api\n        - admin

\n\n

Fonctionnalités avancées

\n\n

Traitement des structures imbriquées et des types spéciaux

\n\n

Symfony Yaml prend en charge l'imbrication à n'importe quelle profondeur, ainsi que des types de données spéciaux tels que les dates, null et les valeurs booléennes :

\n\n

$complexYaml = "\nserver:\n    host: 192.168.1.1\n    ports:\n        - 80\n        - 443\n        - 8080\n    settings:\n        timeout: 30\n        enabled: true\n        description: ~\n        created_at: 2024-01-15\n";\n\n$parsed = Yaml::parse($complexYaml);\nvar_dump($parsed['server']['settings']['enabled']); // bool(true)\nvar_dump($parsed['server']['settings']['description']); // NULL\nvar_dump($parsed['server']['settings']['created_at']); // string(10) "2024-01-15"

\n\n