xp-forge/yaml

YAML parser

v8.1.0 2024-03-24 13:48 UTC

Requires

• php: >=7.0.0
• xp-framework/core: ^12.0 | ^11.0 | ^10.0

Requires (Dev)

• xp-framework/test: ^2.0 | ^1.0

BSD-3-Clause

• module
• xp

README

• See https://yaml.org/
• See https://yaml.org/spec/1.2.2/
• See https://yaml.org/type/merge.html

Usage example

use org\yaml\{YamlParser, FileInput};

$result= (new YamlParser())->parse(new FileInput('.travis.yml'));
// [
//   language => "php"
//   php => [7, 7.1, 7.2, 7.3, 7.4, "nightly"]
//   matrix => [
//     allow_failures => [[
//       php => "nightly"
//     ]]
//   ]
//   before_script => ["curl ...", ...]
//   script => ["sh xp-run xp.unittest.TestRunner src/test/php"]
// ]

Inputs

• org.yaml.FileInput(io.File|string $in) - Use file instance or a file name
• org.yaml.ReaderInput(io.streams.TextReader $in) - Reads from a text reader
• org.yaml.StringInput(string $in) - Input from a string

Multiple documents

YAML sources can contain more than one document. The parse() method will only parse the first (or only) document. To retrieve all documents in a given input, use the iterator returned by documents() instead.

use org\yaml\{YamlParser, FileInput};
use util\cmd\Console;

$parser= new YamlParser();
foreach ($parser->documents(new FileInput('objects.yml')) as $i => $document) {
  Console::writeLine('Document #', $i, ': ', $document);
}