Skip to main content

Dynamic Fields

Dynamic fields are fields that are not defined in the dataset. They are created on the fly after read the JSON file.

To define a dynamic field you need to use the JsonFieldDefinition class and the json_path needs to be a \Closure.

Example

example.json

{
"menu":{
"header":"SVG Viewer",
"items":[
{
"id":"Open",
"metadata":[
{
"version":"1",
"date":"NA"
},
{
"version":"beta",
"date":"soon"
}
]
},
{
"id":"OpenNew",
"label":"Open New",
"metadata":[
{
"version":"2",
"date":"2021-10-01"
}
]
}
]
}
}

example.php

$json = file_get_contents('example.json');

$dataset = new \ByJG\AnyDataset\Json\JsonDataset($json);

$iterator = $dataset->getIterator("/menu/items")
->withFields([
"name" => "id",
"version" => "metadata/*/version"
"dynamic" => function($values) {
return $values["name"] . ":" . implode(", ", $values["version"]);
}
]);

foreach ($iterator as $row) {
echo $row->get('name'); // Print "Open", "OpenNew"
echo $row->get('version'); // Print ["1", "Beta"], ["2"]
echo $row->get('dynamic'); // Print "Open:1, Beta", "OpenNew:2"
}

The closure will receive an array with all the values of the fields defined in the json_path. You can use this array to create the dynamic field.