Yiisoft\Yii\Cycle\Helper\CycleOrmHelper

Complexity

Total Complexity

10

Size/Duplication

Total Lines	105
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	2
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	dropCurrentSchemaCache()	0	3	1
A	addEntityPaths()	0	5	2
A	generateMigrations()	0	16	1
A	__construct()	0	5	1
A	getEntityClassLocator()	0	11	2
A	getCurrentSchemaArray()	0	29	3

<?php

namespace Yiisoft\Yii\Cycle\Helper;

use Cycle\Migrations\GenerateMigrations;
use Cycle\Annotated;
use Cycle\Schema\Compiler;
use Cycle\Schema\Generator\GenerateRelations;
use Cycle\Schema\Generator\GenerateTypecast;
use Cycle\Schema\Generator\RenderRelations;
use Cycle\Schema\Generator\RenderTables;
use Cycle\Schema\Generator\ResetTables;
use Cycle\Schema\Generator\SyncTables;
use Cycle\Schema\Generator\ValidateEntities;
use Cycle\Schema\Registry;
use Doctrine\Common\Annotations\AnnotationRegistry;
use Spiral\Database\DatabaseManager;
use Spiral\Migrations\Config\MigrationConfig;
use Spiral\Migrations\Migrator;
use Spiral\Tokenizer\ClassLocator;
use Symfony\Component\Finder\Finder;
use Yiisoft\Aliases\Aliases;

The type Yiisoft\Aliases\Aliases was not found. Maybe you did not declare it correctly or list all dependencies?

use Psr\SimpleCache\CacheInterface;

The type Psr\SimpleCache\CacheInterface was not found. Maybe you did not declare it correctly or list all dependencies?

class CycleOrmHelper
{
    /** @var DatabaseManager $dbal */
    private $dbal;

    /** @var Aliases */
    private $aliases;

    /** @var CacheInterface */
    private $cache;

    /** @var string */
    private $cacheKey = 'Cycle-ORM-Schema';

    /** @var string[] */
    private $entityPaths = [];

    /** @var int */
    private $tableNaming = Annotated\Entities::TABLE_NAMING_SINGULAR;

    public function __construct(DatabaseManager $dbal, Aliases $aliases, CacheInterface $cache)
    {
        $this->aliases = $aliases;
        $this->dbal = $dbal;
        $this->cache = $cache;
    }

    /**
     * @param string|string[] $paths
     */
    public function addEntityPaths($paths): void
    {
        $paths = (array)$paths;
        foreach ($paths as $path) {
            $this->entityPaths[] = $path;
        }
    }

    public function dropCurrentSchemaCache(): void
    {
        $this->cache->delete($this->cacheKey);
    }

    public function generateMigrations(Migrator $migrator, MigrationConfig $config): void
    {
        $classLocator = $this->getEntityClassLocator();

        // autoload annotations
        AnnotationRegistry::registerLoader('class_exists');

The function Doctrine\Common\Annotations\AnnotationRegistry::registerLoader() has been deprecated: this method is deprecated and will be removed in doctrine/annotations 2.0 autoloading should be deferred to the globally registered autoloader by then. For now, use @example AnnotationRegistry::registerLoader('class_exists')

        (new Compiler())->compile(new Registry($this->dbal), [
            new Annotated\Embeddings($classLocator),   // register embeddable entities
            new Annotated\Entities($classLocator, null, $this->tableNaming), // register annotated entities
            new ResetTables(),                         // re-declared table schemas (remove columns)
            new GenerateRelations(),                   // generate entity relations
            new ValidateEntities(),                    // make sure all entity schemas are correct
            new RenderTables(),                        // declare table schemas
            new RenderRelations(),                     // declare relation keys and indexes
            new GenerateMigrations($migrator->getRepository(), $config), // generate migrations
            // new GenerateTypecast(),                    // typecast non string columns
        ]);
    }

    public function getCurrentSchemaArray($fromCache = true): array
    {
        $getSchemaArray = function () {
            $classLocator = $this->getEntityClassLocator();
            // autoload annotations
            AnnotationRegistry::registerLoader('class_exists');

The function Doctrine\Common\Annotations\AnnotationRegistry::registerLoader() has been deprecated: this method is deprecated and will be removed in doctrine/annotations 2.0 autoloading should be deferred to the globally registered autoloader by then. For now, use @example AnnotationRegistry::registerLoader('class_exists')

            return (new Compiler())->compile(new Registry($this->dbal), [
                new Annotated\Embeddings($classLocator),    // register embeddable entities
                new Annotated\Entities($classLocator, null, $this->tableNaming), // register annotated entities
                new ResetTables(),                          // re-declared table schemas (remove columns)
                new GenerateRelations(),                    // generate entity relations
                new ValidateEntities(),                     // make sure all entity schemas are correct
                new RenderTables(),                         // declare table schemas
                new RenderRelations(),                      // declare relation keys and indexes
                new SyncTables(),                           // sync table changes to database
                new GenerateTypecast(),                     // typecast non string columns
            ]);
        };

        if ($fromCache) {
            $schema = $this->cache->get($this->cacheKey);
            if (is_array($schema)) {
                return $schema;
            }
        }
        $schema = $getSchemaArray();
        $this->cache->set($this->cacheKey, $schema);
        return $schema;
    }

    private function getEntityClassLocator(): ClassLocator
    {
        $list = [];
        foreach ($this->entityPaths as $path) {
            $list[] = $this->aliases->get($path);
        }
        $finder = (new Finder())
            ->files()
            ->in($list);

        return new ClassLocator($finder);
    }
}