lendable/json-serializer

JSON serializer/deserializer with an OOP interface

1.0.4 2023-04-17 11:57 UTC

Requires

• php: >=8.1,<9
• ext-json: *

Requires (Dev)

• infection/infection: ^0.26.20
• php-cs-fixer/shim: ^3.16.0
• php-parallel-lint/php-parallel-lint: ^1.3.2
• phpstan/phpstan: ^1.10.13
• phpstan/phpstan-deprecation-rules: ^1.1.3
• phpstan/phpstan-phpunit: ^1.3.11
• phpstan/phpstan-strict-rules: ^1.5.1
• phpunit/phpunit: ^10.1.0
• rector/rector: ^0.15.24

MIT

• Lendable Ltd

README

Provides an opinionated object oriented interface for handling JSON serialization and deserialization in PHP.

Features

• Throws exceptions on serialization and deserialization failure.
• Sane default serialization flags.

Installation

composer require lendable/json-serializer

Why? Opinionated?

This library aids to simplify our most common usage patterns of JSON at Lendable by providing a strict and limited API, and not a generic solution.

Type safety

We follow the pattern of converting object graph(s) to data array(s) and then to JSON, this library fits into the data array(s) <=> json part of that flow. Due to this, it is restrictive in what can be serialized and deserialized as for our use case, these are error conditions. Data is deserialized always as a numeric (array root element) or an associative array (object root element). Therefore, this library may not fit your use case.

Error handling

The default json_encode() and json_decode() global functions from ext-json are still used, but delegated to in a safe manner. The potential error reporting from these functions can be:

• A false return value - except json_decode('false') also returns false, and isn't an error.
• Retrieved as code or message via json_last_error() or json_last_error_msg() - requires being checked every time.
• An exception via the JSON_THROW_ON_ERROR option in PHP 7.3 - requires opt-in to the functionality.

This library will always throw exceptions on serialization and deserialization failures, simplifying calling logic.

API

Serialization Serializer::serialize(array $data): string

Serializes a data array into a JSON string.

Throws SerializationFailed on failure to serialize.

Deserialization Serializer::deserialize(string $json): array

Deserializes a JSON string into an array.

Throws DeserializationFailed on failure to deserialize. Throws InvalidDeserializedData if the data type of the resulting deserialized data is not an array.