readme.md

Pyther.Json

A lightweight (de)serializer between json strings and data models with the following features:

• support for nested arrays and objects
• pre defined or custom naming policies
• support for basic or backed enumerations.
• meta/attribute support for
  • property renaming
  • property exclusion
  • (array) data type
  • datetime format
  • enum format
• several settings like
  • include protected properties
  • skip null values
  • skip empty arrays
  • skip inherited properties
  • enum format (name, value or full)
  • and more ...
• takes documentation "@var" hints into account
• no external dependencies
• straightforward to use

Requirements:

• PHP 8.1+

Examples:

Deserialization

    // creates a new order class and populate its properties from a json string or array. 
    $order = Json::deserialize($json, Order::class);

Serialization

    // creates a json string populate from orders properties.
    $json = Json::serialize($order);

Meta/Attributes

Json

The attribute allow two manually match a single property with a json attribute. This attribute will ignore the selected naming policy.

use Pyther\Json\Attributes\Json;

class MyClass
{
    // fill the "sku" from the json "id" property.    
    #[Json("id)]
    public string $sku;
}

JsonIgnore

Allow to ignore a single property during serialization, deserialization or both.

use Pyther\Json\Attributes\JsonIgnore;

class MyClass
{
    // ignore on serialization and deserialization
    #[JsonIgnore]
    public string $ignoreMe;

    // ignore on serialization only
    #[JsonIgnore(true, false)]
    public string $ignoreMe;

    // ignore on deserialization only
    #[JsonIgnore(false, true)]
    public string $ignoreMe;
}

JsonType

Define a datatype for a single property. This is especially useful for arrays due the lack of type hint support for arrays in php.

use Pyther\Json\Attributes\JsonType;

class MyClass
{
    // definfes the type of the array items.
    #[JsonType(OrderItem::class)]
    public array $typedArrayByMeta;

    // possible to replace the missing build in datatype.
    #[JsonType(\int::class)]
    public $intByMeta;
}

JsonDateTime

Allow to define a date/time format for a single property.

use Pyther\Json\Attributes\JsonDateTime;

class MyClass
{
    // parse this property by the given format.
    #[JsonDateTime("d/m/Y")]
    public string $dayOfBirth;
}

JsonEnum

Allow to define the enum serialization format for a single property.

use Pyther\Json\Attributes\JsonEnum;

class MyClass
{
    // parse this property by the given format.
    #[JsonEnum(EnumFormat::Name)]
    public Status $status;
}