get the documentation
| public getDocumentationForNode ( array $keys = [], $unfold_all = false ) | ||
| $keys | array | |
public function testDocumentationRoot()
{
$this->if($yaml_loader = new YamlLoader())->and($schema = $yaml_loader->loadFromFile('test/data/TestTypes/Schema.yml'))->and($object = new testedClass($schema, true))->then->object($object)->isInstanceOf('RomaricDrigon\\MetaYaml\\MetaYaml')->array($object->getDocumentationForNode(array('texte')))->isEqualTo(array('name' => 'texte', 'node' => array('_type' => 'text'), 'prefix' => '_'))->array($object->getDocumentationForNode(array('paragraph')))->isEqualTo(array('name' => 'paragraph', 'node' => array('_type' => 'array', '_children' => array('line_1' => array('_type' => 'text'), 'line_2' => array('_type' => 'text'))), 'prefix' => '_'))->array($object->getDocumentationForNode(array('paragraph', 'line_1')))->isEqualTo(array('name' => 'line_1', 'node' => array('_type' => 'text'), 'prefix' => '_'))->array($object->getDocumentationForNode(array('prototype_bool', '1')))->isEqualTo(array('name' => '1', 'node' => array('_type' => 'boolean'), 'prefix' => '_'))->array($object->getDocumentationForNode(array('test_choice')))->isEqualTo(array('name' => 'test_choice', 'node' => array('_type' => 'choice', '_choices' => array(1 => array('_type' => 'enum', '_values' => array('windows', 'linux')), 2 => array('_type' => 'number'), 3 => array('_type' => 'array', '_children' => array('one_item' => array('_type' => 'number'), 'another_item' => array('_type' => 'text'))))), 'prefix' => '_'))->array($object->getDocumentationForNode(array('test_choice', 'one_item')))->isEqualTo(array('name' => 'one_item', 'node' => array(3 => array('_type' => 'number'), '_is_choice' => 'true'), 'prefix' => '_'))->array($object->getDocumentationForNode(array('choice_of_partial')))->isEqualTo(array('name' => 'choice_of_partial', 'node' => array('_type' => 'choice', '_choices' => array(1 => array('_type' => 'text'), 2 => array('_type' => 'text'))), 'prefix' => '_'))->array($object->getDocumentationForNode(array('array_of_partial')))->isEqualTo(array('name' => 'array_of_partial', 'node' => array('_type' => 'array', '_children' => array(1 => array('_type' => 'text'), 2 => array('_type' => 'text'))), 'prefix' => '_'))->array($object->getDocumentationForNode(array('prototype_partial')))->isEqualTo(array('name' => 'prototype_partial', 'node' => array('_type' => 'prototype', '_prototype' => array('_type' => 'text')), 'prefix' => '_'))->array($object->getDocumentationForNode(array('choice_of_choice', 'a')))->isEqualTo(array('name' => 'a', 'node' => array('_is_choice' => 'true', 0 => array('_type' => 'choice', '_choices' => array(10 => array('_type' => 'array', '_children' => array('b' => array('_type' => 'text')))))), 'prefix' => '_'))->array($object->getDocumentationForNode(array('choice_of_choice', 'a', 'b')))->isEqualTo(array('name' => 'b', 'node' => array(0 => array(10 => array('_type' => 'text'), '_is_choice' => 'true'), '_is_choice' => 'true'), 'prefix' => '_'))->array($object->getDocumentationForNode(array('deep_partial'), true))->isEqualTo(array('name' => 'deep_partial', 'node' => array('_type' => 'array', '_children' => array('a' => array('_type' => 'choice', '_choices' => array(0 => array('_type' => 'text'))), 'b' => array('_type' => 'array', '_children' => array('block' => array('_type' => 'array', '_children' => array('line_1' => array('_type' => 'text'), 'line_2' => array('_type' => 'text'))), 'line' => array('_type' => 'text'), 'protoline' => array('_type' => 'prototype', '_prototype' => array('_type' => 'text')))))), 'prefix' => '_'))->exception(function () use($object) {
$object->getDocumentationForNode(array('paragraph', 'unknown'));
})->hasMessage('Unable to find child unknown')->exception(function () use($object) {
$object->getDocumentationForNode(array('wrong_partial'));
})->hasMessage("You're using a partial but partial 'unknown' is not defined in your schema")->exception(function () use($object) {
$object->getDocumentationForNode(array('loop_partial'), true);
})->hasMessage('Partial loop detected while using unfold_partial option');
}
