estahn/json-query-wrapper

Wrapper for jq, a lightweight and flexible command-line JSON processor

v1.0.0 2021-01-11 23:19 UTC

Requires

• php: ^7.1|^8
• symfony/process: ^4|^5

Requires (Dev)

• phpunit/phpunit: ^7|^8|^9
• vimeo/psalm: 4.x-dev

MIT

• Enrico Stahn

• json
• query
• jq

README

json-query-wrapper is a wrapper for the popular command-line JSON processor "jq".

Features

• Easy to use interface
• PHP data type mapping

Installation

$ composer require estahn/json-query-wrapper

Usage

Basic usage

test.json:

{
  "Foo": {
    "Bar": "33"
  }
}

Example 1:

$jq = JsonQueryWrapper\JsonQueryFactory::createWith('test.json');
$jq->run('.Foo.Bar'); # string(33)

Example 2:

$jq = JsonQueryWrapper\JsonQueryFactory::createWith('test.json');
$jq->run('.Foo.Bar == "33"'); # Returns bool(true)

Example 3:

$jq = JsonQueryWrapper\JsonQueryFactory::createWith('{"Foo":{"Bar":"33"}}');
$jq->run('.Foo.Bar == "33"'); # Returns bool(true)

Advanced usage

Example 1:

$jq = JsonQueryWrapper\JsonQueryFactory::create();
$jq->setDataProvider(new JsonQueryWrapper\DataProvider\File('test.json');
$jq->run('.Foo.Bar == "33"'); # Returns bool(true)

Data Providers

A "Data Provider" provides the wrapper with the necessary data to read from. It's a common interface for several providers. All providers implement the DataProviderInterface which essentially returns a path to the file for jq.

Available providers:

• Text - Regular PHP string containing JSON data
• File - A path to a file containing JSON data

Badge Mania

Alternatives

• jmespath.php - Declaratively specify how to extract elements from a JSON document, in PHP
• JSONPath - JSONPath implementation for PHP (based on Stefan Goessner's JSONPath script)