ergebnis/json

Provides a Json value object for representing a valid JSON string.

1.4.0 2024-11-17 11:51 UTC

Requires

• php: ~7.4.0 || ~8.0.0 || ~8.1.0 || ~8.2.0 || ~8.3.0 || ~8.4.0
• ext-json: *

Requires (Dev)

• ergebnis/data-provider: ^3.3.0
• ergebnis/license: ^2.5.0
• ergebnis/php-cs-fixer-config: ^6.37.0
• ergebnis/phpunit-slow-test-detector: ^2.16.1
• fakerphp/faker: ^1.24.0
• infection/infection: ~0.26.6
• phpstan/extension-installer: ^1.4.3
• phpstan/phpstan: ^1.12.10
• phpstan/phpstan-deprecation-rules: ^1.2.1
• phpstan/phpstan-phpunit: ^1.4.0
• phpstan/phpstan-strict-rules: ^1.6.1
• phpunit/phpunit: ^9.6.18
• rector/rector: ^1.2.10

MIT

• Andreas Möller

• json

README

This project provides a composer package with a Json value object for representing a valid JSON string.

Installation

Run

composer require ergebnis/json

Usage

Create a Json object from string

Create a Json object from a string:

<?php

declare(strict_types=1);

use Ergebnis\Json;

$encoded = <<<TXT
{
  "foo
TXT;

$json = Json\Json::fromString($encoded); // throws Json\Exception\NotJson

Create a Json object from a valid JSON string:

<?php

declare(strict_types=1);

use Ergebnis\Json;

$encoded = <<<JSON
{
  "foo": "bar"
}
JSON;

$json = Json\Json::fromString($encoded); // instance of Json\Json

Create a Json object from a file

Create a Json object from a file that does not exist:

<?php

declare(strict_types=1);

use Ergebnis\Json;

$json = Json\Json::fromFile(__DIR__ . '/does-not-exist.json'); // throws Json\Exception\FileDoesNotExist

Create a Json object from a file that can not be read:

<?php

declare(strict_types=1);

use Ergebnis\Json;

$json = Json\Json::fromFile(__DIR__ . '/can-not-be-read.json'); // throws Json\Exception\FileCanNotBeRead

Create a Json object from a file that does not contain a valid JSON string:

<?php

declare(strict_types=1);

use Ergebnis\Json;

$json = Json\Json::fromFile(__DIR__ . '/README.MD'); // throws Json\Exception\FileDoesNotContainJson

Create a Json object from a file that contains a valid JSON string:

<?php

declare(strict_types=1);

use Ergebnis\Json;

$json = Json\Json::fromFile(__DIR__ . '/contains-json.json'); // instance of Json\Json

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.