apimatic/core-lib-php

<?php

declare(strict_types=1);

namespace Core\Utils;

use apimatic\jsonmapper\JsonMapper;
use apimatic\jsonmapper\JsonMapperException;
use CoreInterfaces\Core\Request\TypeValidatorInterface;
use Exception;

/**
 * Internal class: Do not use directly!
 */
class JsonHelper implements TypeValidatorInterface
{
    /**
     * @var JsonMapper|null
     */
    private $jsonMapper;

    /**
     * @var string|null
     */
    private $defaultNamespace;

    /**
     * @param array<string,string[]> $inheritedModels
     * @param array<string,string> $discriminatorSubstitutions
     * @param string|null $additionalPropsMethodName
     * @param string|null $defaultNamespace
     */
    public function __construct(
        array $inheritedModels,
        array $discriminatorSubstitutions,
        ?string $additionalPropsMethodName,
        ?string $defaultNamespace
    ) {
        $this->jsonMapper = new JsonMapper();
        $this->jsonMapper->arChildClasses = $inheritedModels;
        $this->jsonMapper->discriminatorSubs = $discriminatorSubstitutions;
        $this->jsonMapper->sAdditionalPropertiesCollectionMethod = $additionalPropsMethodName;
        $this->defaultNamespace = $defaultNamespace;
    }

    /**
     * @param mixed  $value                Value to be verified against the types
     * @param string $strictType           Strict single type i.e. string, ModelName, etc. or group of types
     *                                     in string format i.e. oneOf(...), anyOf(...)
     * @param array  $serializationMethods Methods required for the serialization of specific types in
     *                                     in the provided types/type, should be an array in the format:
     *                                     ['path/to/method argumentType', ...]. Default: []
     * @return mixed Returns validated and serialized $value
     * @throws JsonMapperException
     */
    public function verifyTypes($value, string $strictType, array $serializationMethods = [])
    {
        return $this->jsonMapper->checkTypeGroupFor($strictType, $value, $serializationMethods);
    }

    /**
     * @param mixed  $value     Value to be mapped by the class
     * @param string $classname Name of the class inclusive of its namespace
     * @param int    $dimension Greater than 0 if trying to map an array of
     *                          class with some dimensions, Default: 0
     * @return mixed Returns the mapped $value
     * @throws Exception
     */
    public function mapClass($value, string $classname, int $dimension = 0)
    {
        return $dimension <= 0 ? $this->jsonMapper->mapClass($value, $classname)
            : $this->jsonMapper->mapClassArray($value, $classname, $dimension);
    }

    /**
     * @param mixed  $value         Value to be mapped by the typeGroup
     * @param string $typeGroup     Group of types in string format i.e. oneOf(...), anyOf(...)
     * @param array  $deserializers Methods required for the de-serialization of specific types in
     *                              in the provided typeGroup, should be an array in the format:
     *                              ['path/to/method returnType', ...]. Default: []
     * @return mixed Returns the mapped $value
     * @throws JsonMapperException
     */
    public function mapTypes($value, string $typeGroup, array $deserializers = [])
    {
        return $this->jsonMapper->mapFor($value, $typeGroup, $this->defaultNamespace, $deserializers);
    }
}