One To One inverse index: implementation

Author: homersimpsons

src/Utils/BeanDescriptor.php

@@ -356,7 +356,7 @@ private function getDirectForeignKeysDescriptors(): array
         $descriptors = [];
 
         foreach ($fks as $fk) {
-            $descriptors[] = new DirectForeignKeyMethodDescriptor($fk, $this->table, $this->namingStrategy, $this->annotationParser);
+            $descriptors[] = new DirectForeignKeyMethodDescriptor($fk, $this->table, $this->namingStrategy, $this->annotationParser, $this->beanNamespace);
         }
 
         return $descriptors;

src/Utils/DirectForeignKeyMethodDescriptor.php

@@ -40,18 +40,30 @@ class DirectForeignKeyMethodDescriptor implements MethodDescriptorInterface
      * @var AnnotationParser
      */
     private $annotationParser;
+    /**
+     * @var string
+     */
+    private $beanNamespace;
 
     /**
      * @param ForeignKeyConstraint $fk The foreign key pointing to our bean
      * @param Table $mainTable The main table that is pointed to
      * @param NamingStrategyInterface $namingStrategy
+     * @param AnnotationParser $annotationParser
+     * @param string $beanNamespace
      */
-    public function __construct(ForeignKeyConstraint $fk, Table $mainTable, NamingStrategyInterface $namingStrategy, AnnotationParser $annotationParser)
-    {
+    public function __construct(
+        ForeignKeyConstraint $fk,
+        Table $mainTable,
+        NamingStrategyInterface $namingStrategy,
+        AnnotationParser $annotationParser,
+        string $beanNamespace
+    ) {
         $this->foreignKey = $fk;
         $this->mainTable = $mainTable;
         $this->namingStrategy = $namingStrategy;
         $this->annotationParser = $annotationParser;
+        $this->beanNamespace = $beanNamespace;
     }
 
     /**
@@ -100,23 +112,37 @@ public function useAlternativeName(): void
     public function getCode() : array
     {
         $beanClass = $this->getBeanClassName();
+        $tdbmFk = ForeignKey::createFromFk($this->foreignKey);
 
         $getter = new MethodGenerator($this->getName());
-        $getter->setDocBlock(sprintf('Returns the list of %s pointing to this bean via the %s column.', $beanClass, implode(', ', $this->foreignKey->getUnquotedLocalColumns())));
-        $getter->getDocBlock()->setTag(new ReturnTag([
-            $beanClass.'[]',
-            '\\'.AlterableResultIterator::class
-        ]));
-        $getter->setReturnType(AlterableResultIterator::class);
 
-        $tdbmFk = ForeignKey::createFromFk($this->foreignKey);
+        if ($this->hasLocalUniqueIndex()) {
+            $getter->setDocBlock(sprintf('Returns the %s pointing to this bean via the %s column.', $beanClass, implode(', ', $this->foreignKey->getUnquotedLocalColumns())));
+            $classType = '\\' . $this->beanNamespace . '\\' . $beanClass;
+            $getter->getDocBlock()->setTag(new ReturnTag([$classType . '|null']));
+            $getter->setReturnType('?' . $classType);
 
-        $code = sprintf(
-            'return $this->retrieveManyToOneRelationshipsStorage(%s, %s, %s);',
-            var_export($this->foreignKey->getLocalTableName(), true),
-            var_export($tdbmFk->getCacheKey(), true),
-            $this->getFilters($this->foreignKey)
-        );
+            $code = sprintf(
+                'return $this->retrieveManyToOneRelationshipsStorage(%s, %s, %s)->first();',
+                var_export($this->foreignKey->getLocalTableName(), true),
+                var_export($tdbmFk->getCacheKey(), true),
+                $this->getFilters($this->foreignKey)
+            );
+        } else {
+            $getter->setDocBlock(sprintf('Returns the list of %s pointing to this bean via the %s column.', $beanClass, implode(', ', $this->foreignKey->getUnquotedLocalColumns())));
+            $getter->getDocBlock()->setTag(new ReturnTag([
+                $beanClass . '[]',
+                '\\' . AlterableResultIterator::class
+            ]));
+            $getter->setReturnType(AlterableResultIterator::class);
+
+            $code = sprintf(
+                'return $this->retrieveManyToOneRelationshipsStorage(%s, %s, %s);',
+                var_export($this->foreignKey->getLocalTableName(), true),
+                var_export($tdbmFk->getCacheKey(), true),
+                $this->getFilters($this->foreignKey)
+            );
+        }
 
         $getter->setBody($code);
 
@@ -144,6 +170,25 @@ private function getFilters(ForeignKeyConstraint $fk) : string
         return $parametersCode;
     }
 
+    /**
+     * Check if the ForeignKey have an unique index
+     *
+     * @return bool
+     */
+    private function hasLocalUniqueIndex(): bool
+    {
+        foreach ($this->getForeignKey()->getLocalTable()->getIndexes() as $index) {
+            if (
+                $index->isUnique()
+                && count($index->getColumns()) === count($this->getForeignKey()->getLocalColumns())
+                && !array_diff($index->getColumns(), $this->getForeignKey()->getLocalColumns()) // Check for permuted columns too
+            ) {
+                return true;
+            }
+        }
+        return false;
+    }
+
     /**
      * Returns an array of classes that needs a "use" for this method.
      *
@@ -181,17 +226,21 @@ public function getJsonSerializeCode() : string
         $class = $this->getBeanClassName();
         $variableName = '$' . TDBMDaoGenerator::toVariableName($class);
         $getter = $this->getName();
-        $code = <<<PHP
+        if ($this->hasLocalUniqueIndex()) {
+            $code = "\$array['$index'] = (\$object = \$this->$getter()) ? \$object->$format : null;";
+        } else {
+            $code = <<<PHP
 \$array['$index'] = array_map(function ($class $variableName) {
     return ${variableName}->$format;
 }, \$this->$getter()->toArray());
 PHP;
+        }
         if (!$isIncluded) {
             $code = preg_replace('(\n)', '\0    ', $code);
             $code = <<<PHP
 if (!\$stopRecursion) {
     $code
-};
+}
 PHP;
         }
         return $code;

tests/TDBMAbstractServiceTest.php

@@ -441,7 +441,7 @@ private static function initSchema(Connection $connection): void
             ->column('id')->integer()->primaryKey()->autoIncrement();
         $db->table('object_inherited')
             ->column('id')->integer()->primaryKey()->autoIncrement()
-            ->column('object_base_id')->references('object_base')->unique();
+            ->column('object_base_id')->references('object_base')->unique()->comment('@JsonCollection');
 
         $sqlStmts = $toSchema->getMigrateFromSql($fromSchema, $connection->getDatabasePlatform());
 

tests/TDBMDaoGeneratorTest.php

@@ -2079,6 +2079,9 @@ public function testLazyLoad(): void
         $this->assertSame(TDBMObjectStateEnum::STATE_NOT_LOADED, $roleBean->_getDbRows()['roles']->_getStatus());
     }
 
+    /**
+     * @depends testDaoGeneration
+     */
     public function testOneToOneInverseRelationGetter(): void
     {
         $objectBaseDao = new ObjectBaseDao($this->tdbmService);
@@ -2089,5 +2092,6 @@ public function testOneToOneInverseRelationGetter(): void
         $objectInherited = new ObjectInheritedBean($objectBase);
         $objectInheritedDao->save($objectInherited);
         $this->assertInstanceOf(ObjectInheritedBean::class, $objectBase->getObjectInherited());
+        $this->assertEquals(1, $objectBase->jsonSerialize()['objectInherited']['id']);
     }
 }

tests/Utils/DirectForeignKeyMethodDescriptorTest.php

@@ -15,7 +15,7 @@ public function testGetForeignKey(): void
         $table = $this->createMock(Table::class);
         $ns = $this->createMock(DefaultNamingStrategy::class);
         $ap = $this->createMock(AnnotationParser::class);
-        $descriptor = new DirectForeignKeyMethodDescriptor($fk, $table, $ns, $ap);
+        $descriptor = new DirectForeignKeyMethodDescriptor($fk, $table, $ns, $ap, '');
 
         $this->assertSame($fk, $descriptor->getForeignKey());
         $this->assertSame($table, $descriptor->getMainTable());