phpdocumentor/json-path

Access php objects with json path expressions

0.1.0 2024-05-24 12:05 UTC

Requires

• php: 7.4|8.0.*|8.1.*
• parsica-php/parsica: ^0.8.1
• symfony/property-access: ^5.4|^6.0

Requires (Dev)

• phpunit/phpunit: ^9.5

MIT

• jaapio

README

JSON-path is a simple JSON path parser and evaluator for PHP. It is based on the JSONPath implementation in Goessner's JSONPath. The code allows you to parse json paths and evaluate them on php objects. Which makes it a query language for php object structures.

It's propably not the fastest solution to query php objects, but as the paths are stored as plain strings, it's easy to use them in configuration files or databases. This makes is a good solution for tools that need to query a php object structure based on user input.

Installation

The recommended way to install JSON-path is through Composer.

  composer require phpdocumentor/json-path

Usage

$parser = \phpDocumentor\JsonPath\Parser::createInstance();
$query = $parser->parse('.store.book[*].author');

$executor = new \phpDocumentor\JsonPath\Executor();
foreach ($executor->execute($query, $json) as $result) {
    var_dump($result);
}