ergebnis / json
Provides a Json value object for representing a valid JSON string.
Installs: 151 259
Dependents: 5
Suggesters: 0
Security: 0
Stars: 6
Watchers: 1
Forks: 0
Open Issues: 1
Requires
- php: ^8.0
Requires (Dev)
- ergebnis/composer-normalize: ^2.29.0
- ergebnis/data-provider: ^1.2.0
- ergebnis/license: ^2.1.0
- ergebnis/php-cs-fixer-config: ^5.0.0
- ergebnis/phpstan-rules: ^1.0.0
- fakerphp/faker: ^1.20.0
- infection/infection: ~0.26.16
- phpunit/phpunit: ^9.5.27
- psalm/plugin-phpunit: ~0.18.4
- vimeo/psalm: ^5.1.0
This package is auto-updated.
Last update: 2023-03-16 07:06:17 UTC
README
Provides 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
Please have a look at CHANGELOG.md
.
Contributing
Please have a look at CONTRIBUTING.md
.
Code of Conduct
Please have a look at CODE_OF_CONDUCT.md
.
License
This package is licensed using the MIT License.
Please have a look at LICENSE.md
.
Curious what I am up to?
Follow me on Twitter!