Add ability to use Property names and Column names in relation keys (#47

) Co-authored-by: thenotsoft <[email protected]> Co-authored-by: roxblnfk <[email protected]>
cycle · Dec 27, 2021 · 203534f · 203534f
1 parent dc10cda
commit 203534f
Show file tree

Hide file tree

Showing 32 changed files with 293 additions and 204 deletions.
diff --git a/src/Compiler.php b/src/Compiler.php
@@ -137,7 +137,7 @@ private function compute(Registry $registry, Entity $entity): void
                     sprintf(
                         'Unable to apply schema modifier `%s` for the `%s` role. %s',
                         $modifier::class,
-                        (string)$entity->getRole(),
+                        $entity->getRole(),
                         $e->getMessage()
                     ),
                     (int)$e->getCode(),
@@ -181,7 +181,7 @@ private function renderColumns(Entity $entity): array
                 $comparator->compare();
             } catch (Throwable $e) {
                 throw new Exception\CompilerException(
-                    sprintf("Error compiling the `%s` role.\n\n%s", (string)$entity->getRole(), $e->getMessage()),
+                    sprintf("Error compiling the `%s` role.\n\n%s", $entity->getRole(), $e->getMessage()),
                     $e->getCode()
                 );
             }

diff --git a/src/Generator/GenerateRelations.php b/src/Generator/GenerateRelations.php
@@ -57,7 +57,7 @@ final class GenerateRelations implements GeneratorInterface
     private $relations = [];
 
     /**
-     * @param array|null        $relations
+     * @param array|null $relations
      * @param OptionSchema|null $optionSchema
      */
     public function __construct(array $relations = null, OptionSchema $optionSchema = null)
@@ -67,10 +67,12 @@ public function __construct(array $relations = null, OptionSchema $optionSchema
 
         foreach ($relations as $id => $relation) {
             if (!$relation instanceof RelationInterface) {
-                throw new \InvalidArgumentException(sprintf(
-                    'Invalid relation type, RelationInterface excepted, `%s` given',
-                    is_object($relation) ? get_class($relation) : gettype($relation)
-                ));
+                throw new \InvalidArgumentException(
+                    sprintf(
+                        'Invalid relation type, RelationInterface excepted, `%s` given',
+                        is_object($relation) ? get_class($relation) : gettype($relation)
+                    )
+                );
             }
 
             $this->relations[$id] = $relation;
@@ -97,7 +99,7 @@ public function run(Registry $registry): Registry
 
     /**
      * @param Registry $registry
-     * @param Entity   $entity
+     * @param Entity $entity
      */
     protected function register(Registry $registry, Entity $entity): void
     {
@@ -126,7 +128,7 @@ protected function register(Registry $registry, Entity $entity): void
 
     /**
      * @param Registry $registry
-     * @param Entity   $entity
+     * @param Entity $entity
      */
     protected function inverse(Registry $registry, Entity $entity): void
     {

diff --git a/src/Generator/RenderTables.php b/src/Generator/RenderTables.php
@@ -4,12 +4,12 @@
 
 namespace Cycle\Schema\Generator;
 
+use Cycle\Database\Schema\AbstractTable;
+use Cycle\Database\Schema\Reflector;
 use Cycle\Schema\Definition\Entity;
 use Cycle\Schema\GeneratorInterface;
 use Cycle\Schema\Registry;
 use Cycle\Schema\Table\Column;
-use Cycle\Database\Schema\AbstractTable;
-use Cycle\Database\Schema\Reflector;
 
 /**
  * Generate table columns based on entity definition.

diff --git a/src/Relation/BelongsTo.php b/src/Relation/BelongsTo.php
@@ -54,10 +54,13 @@ public function compute(Registry $registry): void
         $source = $registry->getEntity($this->source);
         $target = $registry->getEntity($this->target);
 
+        $this->fixContextFields($source, $target);
+
         // create target outer field
         $this->createRelatedFields(
             $target,
             Relation::OUTER_KEY,
+            $registry->getTableSchema($target),
             $source,
             Relation::INNER_KEY
         );
@@ -71,13 +74,13 @@ public function render(Registry $registry): void
         $source = $registry->getEntity($this->source);
         $target = $registry->getEntity($this->target);
 
-        $innerFields = $this->getFields($source, Relation::INNER_KEY);
-        $outerFields = $this->getFields($target, Relation::OUTER_KEY);
+        $sourceTable = $registry->getTableSchema($source);
 
-        $table = $registry->getTableSchema($source);
+        $innerFields = $this->getFields($source, Relation::INNER_KEY, $sourceTable);
+        $outerFields = $this->getFields($target, Relation::OUTER_KEY, $registry->getTableSchema($target));
 
         if ($this->options->get(self::INDEX_CREATE) && $innerFields->count() > 0) {
-            $table->index($innerFields->getColumnNames());
+            $sourceTable->index($innerFields->getColumnNames());
         }
 
         if ($this->options->get(self::FK_CREATE)) {
@@ -99,8 +102,8 @@ public function inverseTargets(Registry $registry): array
 
     /**
      * @param RelationInterface $relation
-     * @param string            $into
-     * @param int|null          $load
+     * @param string $into
+     * @param int|null $load
      *
      * @throws RelationException
      *

diff --git a/src/Relation/HasMany.php b/src/Relation/HasMany.php
@@ -63,10 +63,13 @@ public function compute(Registry $registry): void
         $source = $registry->getEntity($this->source);
         $target = $registry->getEntity($this->target);
 
+        $this->fixContextFields($source, $target);
+
         // create target outer field
         $this->createRelatedFields(
             $source,
             Relation::INNER_KEY,
+            $registry->getTableSchema($source),
             $target,
             Relation::OUTER_KEY
         );
@@ -80,13 +83,13 @@ public function render(Registry $registry): void
         $source = $registry->getEntity($this->source);
         $target = $registry->getEntity($this->target);
 
-        $innerFields = $this->getFields($source, Relation::INNER_KEY);
-        $outerFields = $this->getFields($target, Relation::OUTER_KEY);
+        $targetTable = $registry->getTableSchema($target);
 
-        $table = $registry->getTableSchema($target);
+        $innerFields = $this->getFields($source, Relation::INNER_KEY, $registry->getTableSchema($source));
+        $outerFields = $this->getFields($target, Relation::OUTER_KEY, $targetTable);
 
         if ($this->options->get(self::INDEX_CREATE) && $outerFields->count() > 0) {
-            $table->index($outerFields->getColumnNames());
+            $targetTable->index($outerFields->getColumnNames());
         }
 
         if ($this->options->get(self::FK_CREATE)) {
@@ -108,8 +111,8 @@ public function inverseTargets(Registry $registry): array
 
     /**
      * @param RelationInterface $relation
-     * @param string            $into
-     * @param int|null          $load
+     * @param string $into
+     * @param int|null $load
      *
      * @throws RelationException
      *

diff --git a/src/Relation/HasOne.php b/src/Relation/HasOne.php
@@ -54,12 +54,15 @@ public function compute(Registry $registry): void
         $source = $registry->getEntity($this->source);
         $target = $registry->getEntity($this->target);
 
+        $this->fixContextFields($source, $target);
+
         // create target outer field
         $this->createRelatedFields(
             $source,
             Relation::INNER_KEY,
+            $registry->getTableSchema($source),
             $target,
-            Relation::OUTER_KEY
+            Relation::OUTER_KEY,
         );
     }
 
@@ -71,13 +74,13 @@ public function render(Registry $registry): void
         $source = $registry->getEntity($this->source);
         $target = $registry->getEntity($this->target);
 
-        $innerFields = $this->getFields($source, Relation::INNER_KEY);
-        $outerFields = $this->getFields($target, Relation::OUTER_KEY);
+        $targetTable = $registry->getTableSchema($target);
 
-        $table = $registry->getTableSchema($target);
+        $innerFields = $this->getFields($source, Relation::INNER_KEY, $registry->getTableSchema($source));
+        $outerFields = $this->getFields($target, Relation::OUTER_KEY, $targetTable);
 
         if ($this->options->get(self::INDEX_CREATE) && count($outerFields) > 0) {
-            $table->index($outerFields->getColumnNames());
+            $targetTable->index($outerFields->getColumnNames());
         }
 
         if ($this->options->get(self::FK_CREATE)) {
@@ -99,8 +102,8 @@ public function inverseTargets(Registry $registry): array
 
     /**
      * @param RelationInterface $relation
-     * @param string            $into
-     * @param int|null          $load
+     * @param string $into
+     * @param int|null $load
      *
      * @throws RelationException
      *

diff --git a/src/Relation/ManyToMany.php b/src/Relation/ManyToMany.php
@@ -105,16 +105,21 @@ public function compute(Registry $registry): void
             ));
         }
 
+        $this->fixContextFields($source, $target);
+        $this->fixContextFields($source, $through, ['innerKey', 'outerKey', 'throughInnerKey', 'throughOuterKey']);
+
         $this->createRelatedFields(
             $source,
             Relation::INNER_KEY,
+            $registry->getTableSchema($source),
             $through,
             Relation::THROUGH_INNER_KEY
         );
 
         $this->createRelatedFields(
             $target,
             Relation::OUTER_KEY,
+            $registry->getTableSchema($target),
             $through,
             Relation::THROUGH_OUTER_KEY
         );

diff --git a/src/Relation/Morphed/BelongsToMorphed.php b/src/Relation/Morphed/BelongsToMorphed.php
@@ -69,7 +69,7 @@ public function compute(Registry $registry): void
 
         // create target outer field
         foreach ($outerKeys as $key => $morphKey) {
-            $outerField = $outerFields->getByColumnName($key);
+            $outerField = $outerFields->get($key);
 
             $this->ensureField(
                 $source,

diff --git a/src/Relation/Morphed/MorphedHasMany.php b/src/Relation/Morphed/MorphedHasMany.php
@@ -60,8 +60,9 @@ public function compute(Registry $registry): void
         $this->createRelatedFields(
             $source,
             Relation::INNER_KEY,
+            $registry->getTableSchema($source),
             $target,
-            Relation::OUTER_KEY
+            Relation::OUTER_KEY,
         );
 
         // create target outer field

diff --git a/src/Relation/Morphed/MorphedHasOne.php b/src/Relation/Morphed/MorphedHasOne.php
@@ -57,8 +57,9 @@ public function compute(Registry $registry): void
         $this->createRelatedFields(
             $source,
             Relation::INNER_KEY,
+            $registry->getTableSchema($source),
             $target,
-            Relation::OUTER_KEY
+            Relation::OUTER_KEY,
         );
 
         // create target outer field

diff --git a/src/Relation/OptionSchema.php b/src/Relation/OptionSchema.php
@@ -11,17 +11,14 @@
  */
 final class OptionSchema
 {
-    private array $aliases = [];
-
     private array $options = [];
 
     private array $template = [];
 
     private array $context = [];
 
-    public function __construct(array $aliases)
+    public function __construct(private array $aliases)
     {
-        $this->aliases = $aliases;
     }
 
     public function __debugInfo(): array
@@ -38,6 +35,14 @@ public function __debugInfo(): array
         return $result;
     }
 
+    /**
+     * Get available options
+     */
+    public function getOptions(): array
+    {
+        return $this->options;
+    }
+
     /**
      * Create new option set with user provided options.
      */

diff --git a/src/Relation/RefersTo.php b/src/Relation/RefersTo.php
@@ -51,10 +51,13 @@ public function compute(Registry $registry): void
         $source = $registry->getEntity($this->source);
         $target = $registry->getEntity($this->target);
 
+        $this->fixContextFields($source, $target);
+
         // create target outer field
         $this->createRelatedFields(
             $target,
             Relation::OUTER_KEY,
+            $registry->getTableSchema($target),
             $source,
             Relation::INNER_KEY
         );

diff --git a/src/Relation/RelationSchema.php b/src/Relation/RelationSchema.php
@@ -89,29 +89,6 @@ public function compute(Registry $registry): void
         }
     }
 
-    private function packSchema(): array
-    {
-        $schema = [];
-
-        foreach (static::RELATION_SCHEMA as $option => $template) {
-            if (in_array($option, static::EXCLUDE, true)) {
-                continue;
-            }
-
-            $schema[$option] = $this->options->get($option);
-        }
-
-        // load option is not required in schema
-        unset($schema[Relation::LOAD]);
-
-        return [
-            Relation::TYPE => static::RELATION_TYPE,
-            Relation::TARGET => $this->target,
-            Relation::LOAD => $this->getLoadMethod(),
-            Relation::SCHEMA => $schema,
-        ];
-    }
-
     protected function getLoadMethod(): ?int
     {
         if (!$this->options->has(Relation::LOAD)) {
@@ -137,7 +114,7 @@ protected function getOptions(): OptionSchema
      */
     protected function getPrimaryColumns(Entity $entity): array
     {
-        $columns = $entity->getPrimaryFields()->getColumnNames();
+        $columns = $entity->getPrimaryFields()->getNames();
 
         if ($columns === []) {
             throw new RegistryException("Entity `{$entity->getRole()}` must have defined primary key");
@@ -180,4 +157,27 @@ protected function hasIndex(
         }
         return false;
     }
+
+    private function packSchema(): array
+    {
+        $schema = [];
+
+        foreach (static::RELATION_SCHEMA as $option => $template) {
+            if (in_array($option, static::EXCLUDE, true)) {
+                continue;
+            }
+
+            $schema[$option] = $this->options->get($option);
+        }
+
+        // load option is not required in schema
+        unset($schema[Relation::LOAD]);
+
+        return [
+            Relation::TYPE => static::RELATION_TYPE,
+            Relation::TARGET => $this->target,
+            Relation::LOAD => $this->getLoadMethod(),
+            Relation::SCHEMA => $schema,
+        ];
+    }
 }