Merge pull request cakephp#17873 from cakephp/5.1-associations-preser…

…ve-keys Allow preserving keys when using select loaders.
CakeDC · Aug 31, 2024 · 1d87350 · 1d87350
2 parents 9c2f478 + 514b828
commit 1d87350
Show file tree

Hide file tree

Showing 5 changed files with 75 additions and 4 deletions.
diff --git a/src/ORM/Association/Loader/SelectLoader.php b/src/ORM/Association/Loader/SelectLoader.php
@@ -485,16 +485,25 @@ protected function _buildResultMap(SelectQuery $fetchQuery, array $options): arr
             $this->bindingKey;
         $key = (array)$keys;
 
-        foreach ($fetchQuery->all() as $result) {
+        $preserveKeys = $fetchQuery->getOptions()['preserveKeys'] ?? false;
+
+        foreach ($fetchQuery->all() as $i => $result) {
             $values = [];
             foreach ($key as $k) {
                 $values[] = $result[$k];
             }
+
             if ($singleResult) {
                 $resultMap[implode(';', $values)] = $result;
-            } else {
-                $resultMap[implode(';', $values)][] = $result;
+                continue;
             }
+
+            if ($preserveKeys) {
+                $resultMap[implode(';', $values)][$i] = $result;
+                continue;
+            }
+
+            $resultMap[implode(';', $values)][] = $result;
         }
 
         return $resultMap;

diff --git a/src/ORM/Association/Loader/SelectWithPivotLoader.php b/src/ORM/Association/Loader/SelectWithPivotLoader.php
@@ -178,8 +178,9 @@ protected function _buildResultMap(SelectQuery $fetchQuery, array $options): arr
     {
         $resultMap = [];
         $key = (array)$options['foreignKey'];
+        $preserveKeys = $fetchQuery->getOptions()['preserveKeys'] ?? false;
 
-        foreach ($fetchQuery->all() as $result) {
+        foreach ($fetchQuery->all() as $i => $result) {
             if (!isset($result[$this->junctionProperty])) {
                 throw new DatabaseException(sprintf(
                     '`%s` is missing from the belongsToMany results. Results cannot be created.',
@@ -191,6 +192,12 @@ protected function _buildResultMap(SelectQuery $fetchQuery, array $options): arr
             foreach ($key as $k) {
                 $values[] = $result[$this->junctionProperty][$k];
             }
+
+            if ($preserveKeys) {
+                $resultMap[implode(';', $values)][$i] = $result;
+                continue;
+            }
+
             $resultMap[implode(';', $values)][] = $result;
         }
 

diff --git a/tests/TestCase/ORM/Query/SelectQueryTest.php b/tests/TestCase/ORM/Query/SelectQueryTest.php
@@ -47,6 +47,7 @@
 use ReflectionProperty;
 use TestApp\Model\Table\ArticlesTable;
 use TestApp\Model\Table\AuthorsTable;
+use TestApp\Model\Table\TagsTable;
 
 /**
  * Tests SelectQuery class
@@ -1432,6 +1433,24 @@ public function testFormatResultsBelongsToMany(): void
         $this->assertInstanceOf(DateTime::class, $first->tags[0]->created);
     }
 
+    public function testBelongsToManyWithPreservedKeys(): void
+    {
+        $table = $this->getTableLocator()->get('Articles');
+        $this->getTableLocator()->get('Tags', ['className' => TagsTable::class]);
+        $table->belongsToMany('Tags');
+
+        $first = $table->find()
+            ->where(['Articles.id' => 1])
+            ->contain([
+                'Tags' => ['finder' => 'slugged'],
+            ])
+            ->first();
+
+        $this->assertArrayHasKey('tag1', $first->tags);
+        $this->assertArrayHasKey('tag2', $first->tags);
+        $this->assertSame('tag1', $first->tags['tag1']->name);
+    }
+
     /**
      * Tests that belongsTo relations are correctly hydrated
      */
@@ -3028,6 +3047,18 @@ public function testContainFinderHasMany(): void
                 ],
             ]);
 
+        $resultWithSlugIndexedArticles = $table->find('all')
+            ->where(['id' => 1])
+            ->contain([
+                'Articles' => [
+                    'finder' => [
+                        'slugged' => [
+                            'preserveKeys' => true,
+                        ],
+                    ],
+                ],
+            ]);
+
         $this->assertCount(2, $resultWithArticles->first()->articles);
         $this->assertCount(2, $resultWithArticlesArray->first()->articles);
 
@@ -3038,6 +3069,8 @@ public function testContainFinderHasMany(): void
         );
 
         $this->assertCount(0, $resultWithoutArticles->first()->articles);
+
+        $this->assertSame('First-Article', key($resultWithSlugIndexedArticles->first()->articles));
     }
 
     /**

diff --git a/tests/test_app/TestApp/Model/Table/ArticlesTable.php b/tests/test_app/TestApp/Model/Table/ArticlesTable.php
@@ -16,6 +16,7 @@
 
 use Cake\ORM\Query\SelectQuery;
 use Cake\ORM\Table;
+use Cake\Utility\Text;
 
 /**
  * Article table class
@@ -69,6 +70,15 @@ public function findTitled(SelectQuery $query, array $options): SelectQuery
         return $query;
     }
 
+    public function findSlugged(SelectQuery $query): SelectQuery
+    {
+        return $query->formatResults(function ($results) {
+            return $results->indexBy(function ($row) {
+                return Text::slug($row['title']);
+            });
+        });
+    }
+
     /**
      * Example public method
      */

diff --git a/tests/test_app/TestApp/Model/Table/TagsTable.php b/tests/test_app/TestApp/Model/Table/TagsTable.php
@@ -14,7 +14,9 @@
  */
 namespace TestApp\Model\Table;
 
+use Cake\ORM\Query\SelectQuery;
 use Cake\ORM\Table;
+use Cake\Utility\Text;
 
 /**
  * Tag table class
@@ -27,4 +29,14 @@ public function initialize(array $config): void
         $this->belongsToMany('Articles');
         $this->hasMany('ArticlesTags', ['propertyName' => 'extraInfo']);
     }
+
+    public function findSlugged(SelectQuery $query): SelectQuery
+    {
+        return $query->applyOptions(['preserveKeys' => true])
+            ->formatResults(function ($results) {
+                return $results->indexBy(function ($record) {
+                    return Text::slug($record->name);
+                });
+            });
+    }
 }