ergebnis / json-pointer
Provides an abstraction of a JSON pointer.
Installs: 7 962 755
Dependents: 4
Suggesters: 0
Security: 0
Stars: 15
Watchers: 2
Forks: 0
Open Issues: 0
Requires
- php: ~7.4.0 || ~8.0.0 || ~8.1.0 || ~8.2.0 || ~8.3.0 || ~8.4.0
Requires (Dev)
- ergebnis/composer-normalize: ^2.43.0
- ergebnis/data-provider: ^3.2.0
- ergebnis/license: ^2.4.0
- ergebnis/php-cs-fixer-config: ^6.32.0
- ergebnis/phpunit-slow-test-detector: ^2.15.0
- fakerphp/faker: ^1.23.1
- infection/infection: ~0.26.6
- phpunit/phpunit: ^9.6.19
- psalm/plugin-phpunit: ~0.19.0
- rector/rector: ^1.2.1
- vimeo/psalm: ^5.25.0
This package is auto-updated.
Last update: 2024-10-23 15:21:25 UTC
README
This project provides a composer
package with an abstraction of a JSON pointer.
Installation
Run
composer require ergebnis/json-pointer
Usage
ReferenceToken
You can create a ReferenceToken
from a string
value:
<?php declare(strict_types=1); use Ergebnis\Json\Pointer; $referenceToken = Pointer\ReferenceToken::fromString('foo/9000/π'); $referenceToken->toJsonString(); // 'foo~19000~π' $referenceToken->toString(); // 'foo/9000/π' $referenceToken->toUriFragmentIdentifierString(); // 'foo~19000~1%F0%9F%98%86'
You can create a ReferenceToken
from a JSON string
value:
<?php declare(strict_types=1); use Ergebnis\Json\Pointer; $referenceToken = Pointer\ReferenceToken::fromJsonString('foo~19000~π'); $referenceToken->toJsonString(); // 'foo~19000~π' $referenceToken->toString(); // 'foo/9000/π' $referenceToken->toUriFragmentIdentifierString(); // 'foo~19000~1%F0%9F%98%86'
You can create a ReferenceToken
from a URI fragment identifier string
value:
<?php declare(strict_types=1); use Ergebnis\Json\Pointer; $referenceToken = Pointer\ReferenceToken::fromUriFragmentIdentifierString('foo~19000~1%F0%9F%98%86'); $referenceToken->toJsonString(); // 'foo~19000~π' $referenceToken->toString(); // 'foo/9000/π' $referenceToken->toUriFragmentIdentifierString(); // 'foo~19000~1%F0%9F%98%86'
You can create a ReferenceToken
from an int
value:
<?php declare(strict_types=1); use Ergebnis\Json\Pointer; $referenceToken = Pointer\ReferenceToken::fromInt(9001); $referenceToken->toJsonString(); // '9001' $referenceToken->toString(); // '9001' $referenceToken->toUriFragmentIdentifierString(); // '9001'
You can compare ReferenceToken
s:
<?php declare(strict_types=1); use Ergebnis\Json\Pointer; $one = Pointer\ReferenceToken::fromString('foo/bar'); $two = Pointer\ReferenceToken::fromJsonString('foo~1bar'); $three = Pointer\ReferenceToken::fromString('foo/9000'); $one->equals($two); // true $one->equals($three); // false
JsonPointer
You can create a JsonPointer
referencing a document:
<?php declare(strict_types=1); use Ergebnis\Json\Pointer; $jsonPointer = Pointer\JsonPointer::document(); $jsonPointer->toJsonString(); // '' $jsonPointer->toUriFragmentIdentifierString(); // '#'
You can create a JsonPointer
from a JSON string
representation value:
<?php declare(strict_types=1); use Ergebnis\Json\Pointer; $jsonPointer = Pointer\JsonPointer::fromJsonString('/foo/bar/π'); $jsonPointer->toJsonString(); // '/foo/bar/π' $jsonPointer->toUriFragmentIdentifierString(); // '#/foo/bar/%F0%9F%98%86'
You can create a JsonPointer
from a URI fragment identifier string
representation value:
<?php declare(strict_types=1); use Ergebnis\Json\Pointer; $jsonPointer = Pointer\JsonPointer::fromUriFragmentIdentifierString('#/foo/bar/%F0%9F%98%86'); $jsonPointer->toJsonString(); // '/foo/bar/π' $jsonPointer->toUriFragmentIdentifierString(); // '#/foo/bar/%F0%9F%98%86'
You can create a JsonPointer
from ReferenceToken
s:
<?php declare(strict_types=1); use Ergebnis\Json\Pointer; $referenceTokens = [ Pointer\ReferenceToken::fromString('foo'), Pointer\ReferenceToken::fromString('bar'), ]; $jsonPointer = Pointer\JsonPointer::fromReferenceTokens(...$referenceTokens); $jsonPointer->toJsonString(); // '/foo/bar' $jsonPointer->toUriFragmentIdentifierString(); // '#/foo/bar'
You can compare JsonPointer
s:
<?php declare(strict_types=1); use Ergebnis\Json\Pointer; $one = Pointer\JsonPointer::fromJsonString('/foo/bar'); $two = Pointer\JsonPointer::fromJsonString('/foo~1bar'); $three = Pointer\JsonPointer::fromUriFragmentIdentifierString('#/foo/bar'); $one->equals($two); // false $one->equals($three); // true
You can append a ReferenceToken
to a JsonPointer
:
<?php declare(strict_types=1); use Ergebnis\Json\Pointer; $jsonPointer = Pointer\JsonPointer::fromJsonString('/foo/bar'); $referenceToken = Pointer\ReferenceToken::fromString('baz'); $newJsonPointer = $jsonPointer->append($referenceToken); $newJsonPointer->toJsonString(); // '/foo/bar/baz' $newJsonPointer->toUriFragmentIdentifierString(); // '#foo/bar/baz'
Specification
You can create a Specification
that is always satisfied by a JsonPointer
:
<?php declare(strict_types=1); use Ergebnis\Json\Pointer; $specification = Pointer\Specification::always(); $specification->isSatisfiedBy(Pointer\JsonPointer::fromJsonString('/foo')); // true $specification->isSatisfiedBy(Pointer\JsonPointer::fromJsonString('/foo/bar')); // true
You can create a Specification
that is satisfied when a closure returns true
for a JsonPointer
:
<?php declare(strict_types=1); use Ergebnis\Json\Pointer; $specification = Pointer\Specification::closure(static function (Pointer\JsonPointer $jsonPointer) { return $jsonPointer->toJsonString() === '/foo/bar'; }); $specification->isSatisfiedBy(Pointer\JsonPointer::fromJsonString('/foo')); // false $specification->isSatisfiedBy(Pointer\JsonPointer::fromJsonString('/foo/bar')); // true
You can create a Specification
that is satisfied when a JsonPointer
equals another JsonPointer
:
<?php declare(strict_types=1); use Ergebnis\Json\Pointer; $specification = Pointer\Specification::equals(Pointer\JsonPointer::fromJsonString('/foo/bar')); $specification->isSatisfiedBy(Pointer\JsonPointer::fromJsonString('/foo')); // false $specification->isSatisfiedBy(Pointer\JsonPointer::fromJsonString('/foo/bar')); // true
You can create a Specification
that is never satisfied by a JsonPointer
:
<?php declare(strict_types=1); use Ergebnis\Json\Pointer; $specification = Pointer\Specification::never(); $specification->isSatisfiedBy(Pointer\JsonPointer::fromJsonString('/foo')); // false $specification->isSatisfiedBy(Pointer\JsonPointer::fromJsonString('/foo/bar')); // false
You can create a Specification
that is satisfied when another Specification
is not satisfied by a JsonPointer
:
<?php declare(strict_types=1); use Ergebnis\Json\Pointer; $specification = Pointer\Specification::not(Pointer\Specification::equals(Pointer\JsonPointer::fromJsonString('/foo/bar'))); $specification->isSatisfiedBy(Pointer\JsonPointer::fromJsonString('/foo')); // true $specification->isSatisfiedBy(Pointer\JsonPointer::fromJsonString('/foo/bar')); // false
You can compose Specification
s to find out if a JsonPointer
satisfies any of them:
<?php declare(strict_types=1); use Ergebnis\Json\Pointer; $specification = Pointer\Specification::anyOf( Pointer\Specification::closure(static function(Pointer\JsonPointer $jsonPointer) { return $jsonPointer->toJsonString() === '/foo/bar'; }), Pointer\Specification::equals(Pointer\JsonPointer::fromJsonString('/foo/baz')), Pointer\Specification::never(), ); $specification->isSatisfiedBy(Pointer\JsonPointer::fromJsonString('/foo')); // false $specification->isSatisfiedBy(Pointer\JsonPointer::fromJsonString('/foo/bar')); // true $specification->isSatisfiedBy(Pointer\JsonPointer::fromJsonString('/foo/baz')); // true
Changelog
The maintainers of this project record notable changes to this project in a changelog.
Contributing
The maintainers of this project suggest following the contribution guide.
Code of Conduct
The maintainers of this project ask contributors to follow the code of conduct.
General Support Policy
The maintainers of this project provide limited support.
You can support the maintenance of this project by sponsoring @localheinz or requesting an invoice for services related to this project.
PHP Version Support Policy
This project supports PHP versions with active and security support.
The maintainers of this project add support for a PHP version following its initial release and drop support for a PHP version when it has reached the end of security support.
Security Policy
This project has a security policy.
License
This project uses the MIT license.
Social
Follow @localheinz and @ergebnis on Twitter.