cycle / annotated

src/Entities.php

<?php

declare(strict_types=1);

namespace Cycle\Annotated;

use Cycle\Annotated\Annotation\Entity;
use Cycle\Annotated\Exception\AnnotationException;
use Cycle\Annotated\Utils\EntityUtils;
use Cycle\Schema\Definition\Entity as EntitySchema;
use Cycle\Schema\Exception\RegistryException;
use Cycle\Schema\Exception\RelationException;
use Cycle\Schema\GeneratorInterface;
use Cycle\Schema\Registry;
use Doctrine\Common\Annotations\Reader as DoctrineReader;
use Spiral\Attributes\ReaderInterface;
use Spiral\Tokenizer\ClassesInterface;

/**
 * Generates ORM schema based on annotated classes.
 */
final class Entities implements GeneratorInterface
{
    // table name generation
    public const TABLE_NAMING_PLURAL = 1;
    public const TABLE_NAMING_SINGULAR = 2;
    public const TABLE_NAMING_NONE = 3;

    private ReaderInterface $reader;
    private Configurator $generator;
    private EntityUtils $utils;

    public function __construct(
        private ClassesInterface $locator,
        DoctrineReader|ReaderInterface $reader = null,
        int $tableNamingStrategy = self::TABLE_NAMING_PLURAL,
    ) {
        $this->reader = ReaderFactory::create($reader);
        $this->utils = new EntityUtils($this->reader);
        $this->generator = new Configurator($this->reader, $tableNamingStrategy);
    }

    public function run(Registry $registry): Registry
    {
        /** @var EntitySchema[] $children */
        $children = [];
        foreach ($this->locator->getClasses() as $class) {
            try {
                /** @var Entity $ann */
                $ann = $this->reader->firstClassMetadata($class, Entity::class);
            } catch (\Exception $e) {
                throw new AnnotationException($e->getMessage(), $e->getCode(), $e);
            }

            if ($ann === null) {
                continue;
            }

            $e = $this->generator->initEntity($ann, $class);

            // columns
            $this->generator->initFields($e, $class);

            // relations
            $this->generator->initRelations($e, $class);

            // schema modifiers
            $this->generator->initModifiers($e, $class);

            // foreign keys
            $this->generator->initForeignKeys($ann, $e, $class);

            // additional columns (mapped to local fields automatically)
            $this->generator->initColumns($e, $ann->getColumns(), $class);

            if ($this->utils->hasParent($e->getClass())) {
                foreach ($this->utils->findParents($e->getClass()) as $parent) {

It seems like $e->getClass() can also be of type null; however, parameter $class of Cycle\Annotated\Utils\EntityUtils::findParents() does only seem to accept string, maybe add an additional type check?

                    // additional columns from parent class
                    $ann = $this->reader->firstClassMetadata($parent, Entity::class);
                    $this->generator->initColumns($e, $ann->getColumns(), $parent);
                }

                $children[] = $e;
                continue;
            }

            // generated fields
            $this->generator->initGeneratedFields($e, $class);

            // register entity (OR find parent)
            $registry->register($e);
            $registry->linkTable($e, $e->getDatabase(), $e->getTableName());
        }

        foreach ($children as $e) {
            $registry->registerChildWithoutMerge($registry->getEntity($this->utils->findParent($e->getClass())), $e);
        }

        return $this->normalizeNames($registry);
    }

    private function normalizeNames(Registry $registry): Registry
    {
        foreach ($this->locator->getClasses() as $class) {
            if (!$registry->hasEntity($class->getName())) {
                continue;
            }

            $e = $registry->getEntity($class->getName());

            // resolve all the relation target names into roles
            foreach ($e->getRelations() as $name => $r) {
                try {
                    $r->setTarget($this->resolveTarget($registry, $r->getTarget()));

                    if ($r->getOptions()->has('though')) {
                        $though = $r->getOptions()->get('though');
                        if ($though !== null) {
                            $r->getOptions()->set(
                                'though',
                                $this->resolveTarget($registry, $though)
                            );
                        }
                    }

                    if ($r->getOptions()->has('through')) {
                        $through = $r->getOptions()->get('through');
                        if ($through !== null) {
                            $r->getOptions()->set(
                                'through',
                                $this->resolveTarget($registry, $through)
                            );
                        }
                    }

                    if ($r->getOptions()->has('throughInnerKey')) {
                        if ($throughInnerKey = (array)$r->getOptions()->get('throughInnerKey')) {
                            $r->getOptions()->set('throughInnerKey', $throughInnerKey);
                        }
                    }

                    if ($r->getOptions()->has('throughOuterKey')) {
                        if ($throughOuterKey = (array)$r->getOptions()->get('throughOuterKey')) {
                            $r->getOptions()->set('throughOuterKey', $throughOuterKey);
                        }
                    }
                } catch (RegistryException $ex) {
                    throw new RelationException(
                        sprintf(
                            'Unable to resolve `%s`.`%s` relation target (not found or invalid)',
                            $e->getRole(),
                            $name
                        ),
                        $ex->getCode(),
                        $ex
                    );
                }
            }

            // resolve foreign key target and column names
            foreach ($e->getForeignKeys() as $foreignKey) {
                $target = $this->resolveTarget($registry, $foreignKey->getTarget());
                \assert(!empty($target), 'Unable to resolve foreign key target entity.');
                $targetEntity = $registry->getEntity($target);

                $foreignKey->setTarget($target);
                $foreignKey->setInnerColumns($this->getColumnNames($e, $foreignKey->getInnerColumns()));

                $foreignKey->setOuterColumns(empty($foreignKey->getOuterColumns())
                    ? $targetEntity->getPrimaryFields()->getColumnNames()
                    : $this->getColumnNames($targetEntity, $foreignKey->getOuterColumns()));
            }
        }

        return $registry;
    }

    private function resolveTarget(Registry $registry, string $name): ?string
    {
        if (\interface_exists($name, true)) {
            // do not resolve interfaces
            return $name;
        }

        if (!$registry->hasEntity($name)) {
            // point all relations to the parent
            foreach ($registry as $entity) {
                foreach ($registry->getChildren($entity) as $child) {
                    if ($child->getClass() === $name || $child->getRole() === $name) {
                        return $entity->getRole();
                    }
                }
            }
        }

        return $registry->getEntity($name)->getRole();
    }

    /**
     * @param array<non-empty-string> $columns

The doc comment array<non-empty-string> at position 2 could not be parsed: Unknown type name 'non-empty-string' at position 2 in array<non-empty-string>.

     *
     * @throws AnnotationException
     *
     * @return array<non-empty-string>

The doc comment array<non-empty-string> at position 2 could not be parsed: Unknown type name 'non-empty-string' at position 2 in array<non-empty-string>.

     */
    private function getColumnNames(EntitySchema $entity, array $columns): array
    {
        $names = [];
        foreach ($columns as $name) {
            $names[] = match (true) {
                $entity->getFields()->has($name) => $entity->getFields()->get($name)->getColumn(),
                $entity->getFields()->hasColumn($name) => $name,
                default => throw new AnnotationException('Unable to resolve column name.'),
            };
        }

        return $names;
    }
}