tbela99/yaml

PHP Yaml Parser and Dumper that preserves comments

v5.2.1 2020-06-24 21:04 UTC

Requires

• php: ^7.4
• ext-json: *
• symfony/deprecation-contracts: ^2.1
• symfony/polyfill-ctype: ~1.8

Requires (Dev)

• symfony/console: ^4.4|^5.0

Suggests

• symfony/console: For validating YAML files using the lint command

Conflicts

• symfony/console: <4.4

MIT

• Thierry Bela
• Fabien Potencier
• Symfony Community

• yaml
• php
• parser
• comments
• dumper

README

Based on the Symphony Yaml Component

Installation

$ composer require tbela99/yaml

Modify Yaml And Preserve Comments

# this is a comment
version: "3.8"
services:
  redis:
    image: redis:alpine
    ports:
      - "6379"
    networks:
      - frontend
    deploy:
      replicas: 2
      update_config:
        parallelism: 2
        delay: 10s
      restart_policy:
        condition: on-failure

  db:
    image: postgres:9.4
    volumes:
      - db-data:/var/lib/postgresql/data
    networks:
      - backend
    deploy:
      placement:
        constraints:
          - "node.role==manager"

networks:
  frontend:
  backend:

volumes:
  db-data:
# this is the last comment

use Symfony\Component\Yaml\Ast\Node;

$ast = new Node();

$data = $ast->parse($yaml);

var_dump(isset($ast['services.redis.image'])); // true

echo $ast['services.redis.image']; // redis:alpine

unset($ast['services']);

echo $ast;

# this is a comment
version: 3.8
networks:
  frontend:
  backend:
volumes:
  db-data:
# this is the last comment

$ast['service.db'] = [
  'image' => 'mariadb',
  'environment' => [
    'NODE' => true,
    'SIZE' => '2G'
  ]
];

$ast['service.db.image']->addComment('mariadb image?');
$ast['service.db.environment']->addComment('environment variables');
$ast['service.db.environment.NODE']->addComment('killer app');
$ast['service.db.environment.SIZE']->addComment('going big here ...');

echo $ast;

# this is a comment
version: 3.8
networks:
  frontend:
  backend:
volumes:
  db-data:
# this is the last comment
service:
  db:
    # mariadb image?
    image: mariadb
    # environment variables
    environment:
      # killer app
      NODE: true
      # going big here ...
      SIZE: 2G

$ast['service.db.environment.NODE'] = false;
$ast['service.db.environment.NODE']->setComments(['killer bee']);
$ast['service.db.environment.SIZE'] = '4G';
$ast['service.db.environment.RANGE'] = '100m';

echo $ast;

# this is a comment
version: 3.8
networks:
  frontend:
  backend:
volumes:
  db-data:
# this is the last comment
service:
  db:
    # mariadb image?
    image: mariadb
    # environment variables
    environment:
      # killer bee
      NODE: false
      # going big here ...
      SIZE: 4G
      RANGE: 100m

// binary value
$ast['service.db.environment.BIN'] = hex2bin('abcf');
// multiline string
$ast['service.db.environment.secret'] = "correct horse
battery staple";

# this is a comment
version: 3.8
networks:
  frontend:
  backend:
volumes:
  db-data:
# this is the last comment
service:
  db:
    # mariadb image?
    image: mariadb
    # environment variables
    environment:
      # killer bee
      NODE: false
      # going big here ...
      SIZE: 4G
      RANGE: 100m
      BIN: !!binary q88=
      secret: "correct horse \nbattery staple"

Get parsed data

/**
 * @var array $data
 */

$data = $ast->getValue();

Manipulate Data

/**
 * @var array $data
 */

$ast['version'] = 3.7;
$ast['author'] = 'a random guy';
$ast['authors.list'] = ['John', 'Raymond', 'Michael'];

# this is a comment
version: 3.7
networks:
  frontend:
  backend:
volumes:
  db-data:
# this is the last comment
service:
  db:
    # mariadb image?
    image: mariadb
    # environment variables
    environment:
      # killer bee
      NODE: false
      # going big here ...
      SIZE: 4G
      RANGE: 100m
      BIN: !!binary s6P2WISy5A2WFdyUiHtxemncqdEBpVT+JQm2g5fCtN8=
      secret: "correct horse \nbattery staple"
author: "a random guy"
authors:
  list:
    - John
    - Raymond
    - Michael

unset($ast['service.db']);
echo $ast;

# this is a comment
version: 3.7
networks:
  frontend:
  backend:
volumes:
  db-data:
# this is the last comment
service:

author: "a random guy"
authors:
  list:
    - John
    - Raymond
    - Michael

Parsing Yaml

use Symfony\Component\Yaml\Ast\Node;
use Symfony\Component\Yaml\Ast\Value;

$ast = new Node();

// parse Yaml string
$ast->parse($yaml);
//or parse Yaml file
$ast->parseFile($file);

// alter the ast
$ast['version'] = '1.0';
$ast['version']->addComment('this comment is associated to the version number');
// or
$ast->appendValue(1.0, 'version', ['this comment is associated to the version number']);
// or
$ast->appendNode(new Value(1.0), 'version', ['this comment is associated to the version number']);

// render the ast
$yaml = (string) $ast;

// do something useful with the output
file_put_contents('configuration.yaml', $yaml);

Using '.' In Key

By default '.' is used and path delimiter. You must escape the key to avoid interpretation

$ast = new Node();

$ast['path.to.data'] = "user name";

// use '.' in the key name
$ast[$ast->escapeKey('v0.1')] = [

  'description' => 'first stable release',
  'download' => 'https://example.com'
];

$ast['versions'] = [
  'v0.1' => [

    'description' => 'first stable release',
    'download' => 'https://example.com'
  ]
];

echo $ast;

result

path:
  to:
    data: "user name"
v0.1:
  description: "first stable release"
  download: "https://example.com"
versions:
  v0.1:
    description: "first stable release"
    download: "https://example.com"

Recursively Merge Two Yaml Nodes

$data = 
'path:
 to:
  name: "John Henry"
versions:
 v0.2:
  description: "second stable release"
  download: "https://example.com/2"';

$node = new Node();

$node->parse($data);

$ast->merge($node);

echo "$ast\n\n";

result

# this comment is associated to the version number
version: '1.0'
path:
  to:
    data: 'user name'
    name: 'John Henry'
v0.1:
  description: 'first stable release'
  download: 'https://example.com'
versions:
  v0.1:
    description: 'first stable release'
    download: 'https://example.com'
  v0.2:
    description: 'second stable release'
    download: 'https://example.com/2'
``