Mapado\RestClientSdk\Mapping

Complexity

Total Complexity

34

Size/Duplication

Total Lines	217
Duplicated Lines	0 %

Test Coverage

Coverage

96.77%

Importance

Changes	3
Bugs	0	Features	0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	parseKeyFromId()	0	10	2
A	getConfig()	0	3	1
A	tryGetClassMetadataById()	0	11	3
A	setConfig()	0	5	1
A	getIdPrefix()	0	3	1
A	getKeyFromModel()	0	10	3
A	checkMappingExistence()	0	17	5
A	getModelName()	0	8	1
A	getMappingKeys()	0	5	1
A	getKeyFromId()	0	10	2
A	setMapping()	0	5	1
A	getClassMetadataByKey()	0	9	3
A	hasClassMetadata()	0	9	3
A	removePrefix()	0	10	3
A	getClassMetadata()	0	9	3
A	__construct()	0	5	1

<?php

declare(strict_types=1);

namespace Mapado\RestClientSdk;

use Mapado\RestClientSdk\Exception\MappingException;
use Mapado\RestClientSdk\Mapping\ClassMetadata;

/**
 * Class Mapping
 *
 * @author Julien Deniau <julien.deniau@mapado.com>
 */
class Mapping
{
    public const DEFAULT_CONFIG = ['collectionKey' => 'hydra:member'];

    /**
     * @var string
     */
    private $idPrefix;

    /**
     * @var int
     */
    private $idPrefixLength;

    /**
     * @var array<ClassMetadata>
     */
    private $classMetadataList = [];

    /**
     * @var array
     */
    private $config;

    public function __construct(string $idPrefix = '', array $config = [])
    {
        $this->idPrefix = $idPrefix;
        $this->idPrefixLength = mb_strlen($idPrefix);
        $this->setConfig($config);
    }

    public function getIdPrefix(): string
    {
        return $this->idPrefix;
    }

    public function getConfig(): array
    {
        return $this->config;
    }

    public function setConfig(array $config): self
    {
        $this->config = array_merge(self::DEFAULT_CONFIG, $config);

        return $this;
    }

    /**
     * @param array<ClassMetadata> $classMetadataList
     */
    public function setMapping(array $classMetadataList): self
    {
        $this->classMetadataList = $classMetadataList;

        return $this;
    }

    /**
     * return a model class name for a given key
     */
    public function getModelName(string $key): string
    {
        $this->checkMappingExistence($key, true);

        /** @var ClassMetadata */
        $classMetadata = $this->getClassMetadataByKey($key);

        return $classMetadata->getModelName();
    }

    /**
     * return the list of mapping keys
     *
     * @return array<string>
     */
    public function getMappingKeys(): array
    {
        return array_map(function (ClassMetadata $classMetadata) {
            return $classMetadata->getKey();
        }, $this->classMetadataList);
    }

    /**
     * get the key from an id (path)
     */
    public function getKeyFromId(string $id): string
    {
        $key = $this->parseKeyFromId($id);
        if (null === $key) {
            throw new MappingException("Unable to parse key from id {$id}.");
        }

        $this->checkMappingExistence($key);

        return $key;
    }

    /**
     * @param string $modelName model name
     *
     * @throws MappingException
     */
    public function getKeyFromModel(string $modelName): string
    {
        foreach ($this->classMetadataList as $classMetadata) {
            if ($modelName === $classMetadata->getModelName()) {
                return $classMetadata->getKey();
            }
        }

        throw new MappingException(
            'Model name ' . $modelName . ' not found in mapping'
        );
    }

    /**
     * getClassMetadata for model name
     *
     * @throws MappingException
     */
    public function getClassMetadata(string $modelName): ClassMetadata
    {
        foreach ($this->classMetadataList as $classMetadata) {
            if ($modelName === $classMetadata->getModelName()) {
                return $classMetadata;
            }
        }

        throw new MappingException($modelName . ' model is not mapped');
    }

    /**
     * getClassMetadata for id
     */
    public function tryGetClassMetadataById(string $id): ?ClassMetadata
    {
        $key = $this->parseKeyFromId($id);

        foreach ($this->classMetadataList as $classMetadata) {
            if ($key === $classMetadata->getKey()) {
                return $classMetadata;
            }
        }

        return null;
    }

    public function hasClassMetadata(string $modelName): bool
    {
        foreach ($this->classMetadataList as $classMetadata) {
            if ($modelName === $classMetadata->getModelName()) {
                return true;
            }
        }

        return false;
    }

    public function getClassMetadataByKey(string $key): ?ClassMetadata
    {
        foreach ($this->classMetadataList as $classMetadata) {
            if ($key === $classMetadata->getKey()) {
                return $classMetadata;
            }
        }

        return null;
    }

    /**
     * Parse the key from an id (path)
     */
    private function parseKeyFromId(string $id): ?string
    {
        $id = $this->removePrefix($id);

        $matches = [];
        if (1 === preg_match('|/([^/]+)/[^/]+$|', $id, $matches)) {
            return $matches[1];
        }

        return null;
    }

    private function checkMappingExistence(
        string $key,
        bool $checkModelName = false
    ): void {
        if (empty($key)) {
            throw new MappingException('key is not set');
        }

        $metadata = $this->getClassMetadataByKey($key);
        if (!$metadata) {
            throw new MappingException($key . ' key is not mapped');
        }

        if ($checkModelName) {
            if ('' === $metadata->getModelName()) {
                throw new MappingException(
                    $key . ' key is mapped but the model name is empty'
                );
            }
        }
    }

    private function removePrefix(string $value): string
    {
        if (
            $this->idPrefixLength > 0 &&
            0 === mb_strpos($value, $this->idPrefix)
        ) {
            return mb_substr($value, $this->idPrefixLength);
        }

        return $value;
    }
}