b2pweb / bdf-prime

src/Mapper/SingleTableInheritanceMapper.php

<?php

namespace Bdf\Prime\Mapper;

use Bdf\Prime\Platform\PlatformInterface;
use Bdf\Prime\Relations\Relation;

/**
 * SingleTableInheritanceMapper
 *
 * @package Bdf\Prime\Mapper
 */
abstract class SingleTableInheritanceMapper extends Mapper implements MapperFactoryAwareInterface
{
    /**
     * The mapper factory
     *
     * @var MapperFactory
     */
    protected $mapperFactory;

    /**
     * The discriminator column
     *
     * @var string
     */
    protected $discriminatorColumn;

    /**
     * The discriminator map of mappers
     *
     * @var array<string, class-string<Mapper>>

The doc comment array<string, class-string<Mapper>> at position 4 could not be parsed: Unknown type name 'class-string' at position 4 in array<string, class-string<Mapper>>.

     */
    protected $discriminatorMap = [];


    /**
     * @todo voir pour retirer le mapper factory: passer par les depots
     * {@inheritdoc}
     * @final
     */
    public function setMapperFactory(MapperFactory $mapperFactory): void
    {
        $this->mapperFactory = $mapperFactory;
    }

    /**
     * {@inheritdoc}
     */
    public function relation(string $relationName): array
    {
        $relation = parent::relation($relationName);

        if ($this->isDiscriminatedMapper() && $relation['type'] == Relation::BY_INHERITANCE) {
            throw new \RuntimeException('Relation type not allowed from relation "' . $relationName . '" in ' . $this->getEntityClass());
        }

        return $relation;
    }

    /**
     * {@inheritdoc}
     */
    public function customConstraints(): array
    {
        if ($this->isDiscriminatedMapper()) {
            return [$this->discriminatorColumn => array_search(static::class, $this->discriminatorMap)];
        }

        return parent::customConstraints();
    }

    /**
     * {@inheritDoc}
     */
    public function prepareFromRepository(array $data, PlatformInterface $platform)
    {
        if ($this->isDiscriminatedMapper()) {
            return parent::prepareFromRepository($data, $platform);
        }

        return $this->getMapperByDiscriminatorValue($this->getDiscriminatorValueByRawData($data))->prepareFromRepository($data, $platform);
    }

    /**
     * Get the discriminator map of mappers
     *
     * @return array
     * @final
     */
    public function getDiscriminatorMap(): array
    {
        return $this->discriminatorMap;
    }

    /**
     * Get the discriminator map of entities
     *
     * @return array<string, class-string>

The doc comment array<string, class-string> at position 4 could not be parsed: Unknown type name 'class-string' at position 4 in array<string, class-string>.

     * @final
     */
    public function getEntityMap(): array
    {
        $map = [];
        $resolver = $this->mapperFactory->getNameResolver();

        foreach ($this->discriminatorMap as $key => $mapperClass) {
            $map[$key] = $resolver->reverse($mapperClass);
        }

        return $map;
    }

    /**
     * Get the discriminator column
     *
     * @return string
     * @final
     */
    public function getDiscriminatorColumn(): string
    {
        return $this->discriminatorColumn;
    }

    /**
     * Get the mapper by a discriminator value
     *
     * @param mixed $value
     *
     * @return Mapper
     * @psalm-suppress InvalidNullableReturnType
     * @final
     */
    public function getMapperByDiscriminatorValue($value): Mapper
    {
        /** @psalm-suppress NullableReturnStatement */
        return $this->mapperFactory->createMapper(

The expression return $this->mapperFactory->createMapper($this->serviceLocator, $this->getDiscriminatorType($value)) could return the type null which is incompatible with the type-hinted return Bdf\Prime\Mapper\Mapper. Consider adding an additional type-check to rule them out.

            $this->serviceLocator,
            $this->getDiscriminatorType($value)
        );
    }

    /**
     * Get the discriminator value from array of data
     *
     * @param array $data
     *
     * @return mixed
     *
     * @throws \Exception if discriminator field not present in $data
     * @final
     */
    public function getDiscriminatorValueByRawData(array $data)
    {
        $discriminatorField = $this->metadata()->attributes[$this->discriminatorColumn]['field'];

        if (empty($data[$discriminatorField])) {
            throw new \Exception('Discriminator field "' . $discriminatorField . '" not found');
        }

        return $data[$discriminatorField];
    }

    /**
     * Get the mapper class from discriminator value
     *
     * @param mixed $discriminatorValue
     *
     * @return class-string<Mapper>

The doc comment class-string<Mapper> at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string<Mapper>.

     *
     * @throws \Exception if discriminator value is unknown
     * @final
     */
    public function getDiscriminatorType($discriminatorValue): string
    {
        if (empty($this->discriminatorMap[$discriminatorValue])) {
            throw new \Exception('Unknown discriminator type "' . $discriminatorValue . '"');
        }

        return $this->discriminatorMap[$discriminatorValue];
    }

    /**
     * Check whether the class is a discriminated mapper
     *
     * @return boolean
     * @final
     */
    protected function isDiscriminatedMapper(): bool
    {
        return in_array(static::class, $this->discriminatorMap);
    }
}