brick / json-mapper

Maps JSON data to strongly typed PHP DTOs

Brick

Incubator for PHP components under development.

Once a component reaches sufficient maturity, it will be moved to its own repository and composer package, and enter a beta phase. For this reason, this repository will never contain releases.

The incubator can be included in your project using Composer. Just define the following requirement in your composer.json file:

{
    "require": {
        "brick/brick": "dev-master"
    }
}

Feel free to use the incubator for your own use/research, but please note that the API can, and will, change at any time. Components can also disappear at any time.

json-mapper's Issues

Difference between this and CuyZ/Valinor

Hi, Ben

I have used your libraries frequently in the past. I just saw this library. What is the difference between this library and https://github.com/CuyZ/Valinor?

That's something you might add to the README because CuyZ/Valinor has gained quite a traction I reckon.

Thanks for your work :)

Brick \ JsonMapper \ JsonMapperException Unexpected property "labels" in JSON data: Google\Service\MyBusinessBusinessInformation\Location::__construct() does not have a corresponding $labels parameter. If you want to allow extra properties, change the $onExtraProperties option.

That class is declared as:

namespace Google\Service\MyBusinessBusinessInformation;

class Location extends \Google\Collection
{
  protected $collection_key = 'serviceItems';
  protected $adWordsLocationExtensionsType = AdWordsLocationExtensions::class;
  protected $adWordsLocationExtensionsDataType = '';
  protected $categoriesType = Categories::class;
  protected $categoriesDataType = '';
  /**
   * @var string[]
   */
  public $labels;

...
See: https://github.com/googleapis/google-api-php-client-services/blob/main/src/MyBusinessBusinessInformation/Location.php#L30C12-L30C12

Issue with matching properties' names

If you have different props with the matching string in the beginning of their names (and at least two of them are PHPdoc-ed with @param), you get an error at src/Reflection/Reflector.php::149 which is incorrect.

Please, consider adding \W to the end of regular expression at src/Reflection/Reflector.php::149:

$pattern = '/@param(.*)\$' . $parameter->getName() . '\W/';

HUGE PROBLEM: class ImportResolver is missing

Class "Brick\Reflection\ImportResolver" not found

row 289 of Reflection/Reflector.php file

private function convertNamedType(string $namedType, bool $isReflection, ReflectionParameter $reflectionParameter): SimpleType|ClassType|EnumType
    {
        $namedTypeLower = strtolower($namedType);

        $isAllowedBuiltinType = in_array($namedTypeLower, self::ALLOWED_BUILTIN_TYPES, true);
        $isDisallowedBuiltinType = in_array($namedTypeLower, self::DISALLOWED_BUILTIN_TYPES, true);
        $isBuiltinType = $isAllowedBuiltinType || $isDisallowedBuiltinType;

        if (! $isBuiltinType && ! $isReflection) {
            // Class names coming from reflection are already fully qualified, while class names coming from @param
            // must be resolved according to the current namespace & use statements,
            $importResolver = new ImportResolver($reflectionParameter); <--- HERE

            $namedType = $importResolver->resolve($namedType);
            $namedTypeLower = strtolower($namedType);
        }

Mapping a nested Json object

What's the best way to map a nested json object?

Imagine this response shown here: https://stytch.com/docs/b2b/api/create-organization

Inside that Json object is an Organisation, which is the only thing I need to map.

Currently, I json_decode the response to test for errors and raise exceptions based on any error object. This means I have access to an organisation object already ($data->organisation).

I don't think re-json_encoding that Organisation object is the way forward, only to pass it to Json-Mapper to do it all again.

So from what I can see, I'm either petitioning for:

• mapToObject() to be made public, so I can pass my object straight to it; or,
• map() gets a new, nullable, argument that specifies the path to the object to map.

Am I seeing this from the wrong angle? All thoughts appreciated!

Edit: similar question, but for when an array of objects is returned.

Edit2: Would it be typical to leave json-mapper alone, and create a PHP object per API Response type?

Show JSON path in exceptions

Exceptions such as "Unexpected property %s in JSON data" should display the full path to the property in the JSON document, for easier debugging.