https://github.com/jurasciix/objeckson

PHP library that supposed for mapping JSON objects to PHP objects
https://github.com/jurasciix/objeckson

arrays deserialization generics json mapping php8

Last synced: 2 months ago
JSON representation

PHP library that supposed for mapping JSON objects to PHP objects

• Host: GitHub
• URL: https://github.com/jurasciix/objeckson
• Owner: JuraSciix
• License: mit
• Created: 2024-04-25T03:20:32.000Z (9 months ago)
• Default Branch: master
• Last Pushed: 2024-07-19T23:02:40.000Z (6 months ago)
• Last Synced: 2024-10-28T16:59:59.642Z (2 months ago)
• Topics: arrays, deserialization, generics, json, mapping, php8
• Language: PHP
• Homepage:
• Size: 60.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Objeckson

__Objeckson__ - это библиотека для отображения динамических ассоциативных структур 

(которые, как правило, хранятся в формате JSON) на объекты PHP.

## Возможности и roadmap

- [x] Десериализовывать массивы

- [x] Отображать на перечисления

- [x] Анализировать обобщенные типы

- [x] Работать с nullable-типами

- [x] Пользовательские сеттеры

- [x] Анализировать array-shapes: array{foo: Foo, bar: Bar}

- [ ] Значения по умолчанию для Readonly свойств

- [ ] Отображать на объекты STD: DateTime, SplFixedArray, etc...

- [ ] Комбинации прямо отображаемых типов (примитивных): string|int|Foo

- [ ] OneOf

## Установка

Требования:

* PHP ≥ 8.1

* Composer

Установка посредством __composer__:

> composer require jurasciix/objeckson:^1.0

## Быстрый туториал

Следующий код демонстрирует инициализацию объекта, предоставляющего доступ к функциям __Objeckson__, 

и десериализацию данных JSON с отображением на объект PHP:

```php

use jurasciix\objeckson\JsonProperty;

use jurasciix\objeckson\Optional;

use jurasciix\objeckson\Objeckson;

#[JsonProperty]

class APIResponse {

    #[Optional]

    public ?APIError $error = null;

    #[Optional]

    public mixed $data = null;

}

#[JsonProperty]

class APIError {

    public int $code;

    public string $description;

}

$responseJSON = <<fromJson($responseJSON, APIResponse::class);

// Смотрим, что у нас вышло.

var_dump($response);

```