byjg/anydataset-json

Anydataset JSON abstraction. Anydataset is an agnostic data source abstraction layer in PHP.

5.0.0 2024-10-27 21:14 UTC

Requires

• php: >=8.1 <8.4
• ext-json: *
• byjg/anydataset: ^5.0

Requires (Dev)

• phpunit/phpunit: ^9.6
• vimeo/psalm: ^5.6

Suggests

• ext-curl: *

Provides

• byjg/anydataset-implementation: 1.0

MIT

README

JSON abstraction dataset. Anydataset is an agnostic data source abstraction layer in PHP.

See more about Anydataset here.

Concept

The AnyDataset-Json is an abstraction layer to read a JSON data and transform it into a dataset, and you can manipulate it as a table.

Some features:

• Read a JSON file or string
• Define and extract fields
• Validate some elements such as if is required or not, datatype, etc

Example

example.json

{
   "menu":{
      "header":"SVG Viewer",
      "items":[
         {
            "id":"Open",
            "metadata":{
               "version":"1",
               "date":"NA"
            }
         },
         {
            "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([
                            JsonFieldDefinition::create("name", "id"),
                            JsonFieldDefinition::create("version", "metadata/version")
                        ]);

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

Features

• The JsonFieldDefinition
• Creating dynamic fields
• Simple Manipulation

Install

composer require "byjg/anydataset-json"

Running the Unit tests

vendor/bin/phpunit

Dependencies

flowchart TD
    byjg/anydataset-json --> byjg/anydataset
    byjg/anydataset-json --> ext-json

Loading

Open source ByJG