GitHub - remorhaz/php-json-patch: JSON Patch (RFC-6902) PHP implementation (original) (raw)

PHP JSON Patch

This library implements RFC6902-compliant JSON patch tool.

Requirements

PHP 8.1.
JSON extension (ext-json) - required by remorhaz/php-json-data to access JSON documents.
Internationalization functions (ext-intl) - required by remorhaz/php-json-data to compare Unicode strings.

Installation

You will need composer to perform install.

composer require remorhaz/php-json-patch

Documentation

Accessing JSON document

You can create accessible JSON document either from encoded JSON string or from decoded JSON data using corresponding node value factory:

use Remorhaz\JSON\Data\Value\EncodedJson; use Remorhaz\JSON\Data\Value\DecodedJson;

// Creating document from JSON-encoded string: $encodedValueFactory = EncodedJson\NodeValueFactory::create(); encodedJson=′"a":1′;<spanclass="katex"><spanclass="katex−mathml"><mathxmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>d</mi><mi>o</mi><mi>c</mi><mi>u</mi><mi>m</mi><mi>e</mi><mi>n</mi><mi>t</mi><mn>1</mn><mo>=</mo></mrow><annotationencoding="application/x−tex">document1=</annotation></semantics></math><spanclass="katex−html"aria−hidden="true"><spanclass="base"><spanclass="strut"style="height:0.6944em;"><spanclass="mordmathnormal">d<spanclass="mordmathnormal">oc<spanclass="mordmathnormal">u<spanclass="mordmathnormal">m<spanclass="mordmathnormal">e<spanclass="mordmathnormal">n<spanclass="mordmathnormal">t<spanclass="mord">1<spanclass="mspace"style="margin−right:0.2778em;"><spanclass="mrel">=encodedValueFactory−>createValue(encodedJson = '{"a":1}'; <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>d</mi><mi>o</mi><mi>c</mi><mi>u</mi><mi>m</mi><mi>e</mi><mi>n</mi><mi>t</mi><mn>1</mn><mo>=</mo></mrow><annotation encoding="application/x-tex">document1 = </annotation></semantics></math>document1=encodedValueFactory->createValue(encodedJson=′"a":1′;<spanclass="katex"><spanclass="katex−mathml"><mathxmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>d</mi><mi>o</mi><mi>c</mi><mi>u</mi><mi>m</mi><mi>e</mi><mi>n</mi><mi>t</mi><mn>1</mn><mo>=</mo></mrow><annotationencoding="application/x−tex">document1=</annotation></semantics></math><spanclass="katex−html"aria−hidden="true"><spanclass="base"><spanclass="strut"style="height:0.6944em;"><spanclass="mordmathnormal">d<spanclass="mordmathnormal">oc<spanclass="mordmathnormal">u<spanclass="mordmathnormal">m<spanclass="mordmathnormal">e<spanclass="mordmathnormal">n<spanclass="mordmathnormal">t<spanclass="mord">1<spanclass="mspace"style="margin−right:0.2778em;"><spanclass="mrel">=encodedValueFactory−>createValue(encodedJson);

// Creating document from decoded JSON data: $decodedValueFactory = DecodedJson\NodeValueFactory::create(); decodedJson=(object)[′a′=>1];<spanclass="katex"><spanclass="katex−mathml"><mathxmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>d</mi><mi>o</mi><mi>c</mi><mi>u</mi><mi>m</mi><mi>e</mi><mi>n</mi><mi>t</mi><mn>2</mn><mo>=</mo></mrow><annotationencoding="application/x−tex">document2=</annotation></semantics></math><spanclass="katex−html"aria−hidden="true"><spanclass="base"><spanclass="strut"style="height:0.6944em;"><spanclass="mordmathnormal">d<spanclass="mordmathnormal">oc<spanclass="mordmathnormal">u<spanclass="mordmathnormal">m<spanclass="mordmathnormal">e<spanclass="mordmathnormal">n<spanclass="mordmathnormal">t<spanclass="mord">2<spanclass="mspace"style="margin−right:0.2778em;"><spanclass="mrel">=decodedValueFactory−>createValue(decodedJson = (object) ['a' => 1]; <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>d</mi><mi>o</mi><mi>c</mi><mi>u</mi><mi>m</mi><mi>e</mi><mi>n</mi><mi>t</mi><mn>2</mn><mo>=</mo></mrow><annotation encoding="application/x-tex">document2 = </annotation></semantics></math>document2=decodedValueFactory->createValue(decodedJson=(object)[′a′=>1];<spanclass="katex"><spanclass="katex−mathml"><mathxmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>d</mi><mi>o</mi><mi>c</mi><mi>u</mi><mi>m</mi><mi>e</mi><mi>n</mi><mi>t</mi><mn>2</mn><mo>=</mo></mrow><annotationencoding="application/x−tex">document2=</annotation></semantics></math><spanclass="katex−html"aria−hidden="true"><spanclass="base"><spanclass="strut"style="height:0.6944em;"><spanclass="mordmathnormal">d<spanclass="mordmathnormal">oc<spanclass="mordmathnormal">u<spanclass="mordmathnormal">m<spanclass="mordmathnormal">e<spanclass="mordmathnormal">n<spanclass="mordmathnormal">t<spanclass="mord">2<spanclass="mspace"style="margin−right:0.2778em;"><spanclass="mrel">=decodedValueFactory−>createValue(decodedJson);

Creating and processing query

You should use query factory to create query from JSON Patch document. Then you should use processor to apply that query:

patch=patch = patch=encodedValueFactory->createValue('[{"op":"remove","path":"/0"}]'); query=query = query=queryFactory->createQuery($patch); document=document = document=encodedValueFactory->createValue('[1,2]'); result=result = result=processor->apply($query, $document); var_dump($result->encode()); // string: '[2]' var_dump($result->decode()); // array: [2] Note that result can be exported either to JSON-encoded string or to raw PHP value. ## License [](#license) PHP JSON Patch is licensed under [MIT license](/remorhaz/php-json-patch/blob/master/LICENSE).