Giter Club home page Giter Club logo

json-mapper's Introduction

JSON Mapper

Strict JSON to object hydrator based on PHPStan.

Usage

use Lookyman\JsonMapper\MapperBuilder
use PHPUnit\Framework\Assert;

class Foo
{
    public function __construct(public string $foo)
    {
    }
}

class Bar
{
    public function __construct(public Foo $first)
    {
    }
}

$result = (new MapperBuilder())
    ->build()
    ->map(Bar::class, '{"first":{"foo":"wtf"}}');

Assert::assertEquals(
    new Bar(new Foo('wtf')),
    $result,
);

If the parameter is not present in source, and has a scalar default value, it will be assigned that value. If the parameter is not present in source, but is nullable, it will be assigned a NULL value. If the source contains keys not present in parameter names, those will be ignored. Otherwise, we do not do any guessing or type casting.

In case of any error, Lookyman\JsonMapper\Exception\MapperException is thrown.

Supported types

  • Scalars (including literals and integer ranges),
  • arrays (including associative and shapes),
  • iterables,
  • class-string (including generic),
  • object,
  • normal class objects (including generic),
  • unions (including nullable parameters),
  • backed enums.

See PHPStan documentation and tests directory for examples.

Caveats

All classes must be instantiable with a public constructor. If your types contain interfaces or abstract classes, use MapperBuilder::withClassMapping to provide a map to concrete classes.

Questions?

This is a pet project I played with over the 2021 end of year holidays, because I saw @Ocramius looking for a similar library a few weeks earlier. At the moment, I have no ambitions with it, I just wanted to see if this approach is feasible.

It probably contains a lot of bugs.

If you have any questions, the answer is probably "I don't know". If you have any requests, I will probably not respond.

But I reserve the right to change my mind at any point.

json-mapper's People

Contributors

lookyman avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.