Skip to content

Support entities with association column names that conflict with a field name #11857

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: 3.3.x
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/Cache/DefaultEntityHydrator.php
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ public function buildCacheEntry(ClassMetadata $metadata, EntityCacheKey $key, ob
assert($owningAssociation->isToOneOwningSide());
$fieldMapping = $targetClassMetadata->fieldMappings[$fieldName];

$data[$owningAssociation->targetToSourceKeyColumns[$fieldMapping->columnName]] = $fieldValue;
$data['.column:' . $owningAssociation->targetToSourceKeyColumns[$fieldMapping->columnName]] = $fieldValue;

continue;
}
Expand All @@ -88,7 +88,7 @@ public function buildCacheEntry(ClassMetadata $metadata, EntityCacheKey $key, ob
assert($assoc->isToOneOwningSide());
foreach ($assoc->targetToSourceKeyColumns as $referencedColumn => $localColumn) {
if (isset($targetAssoc->sourceToTargetKeyColumns[$referencedColumn])) {
$data[$localColumn] = $fieldValue;
$data['.column:' . $localColumn] = $fieldValue;
}
}
}
Expand Down
8 changes: 7 additions & 1 deletion src/Internal/Hydration/AbstractHydrator.php
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ abstract protected function hydrateAllData(): mixed;
* scalars?: array
* }
*/
protected function gatherRowData(array $data, array &$id, array &$nonemptyComponents): array
protected function gatherRowData(array $data, array &$id, array &$nonemptyComponents, bool $prefixColumns = true): array
{
$rowData = ['data' => [], 'newObjects' => []];

Expand Down Expand Up @@ -300,6 +300,12 @@ protected function gatherRowData(array $data, array &$id, array &$nonemptyCompon

//case (isset($cacheKeyInfo['isMetaColumn'])):
default:
// Meta column field name is actually a column name. This
// prevents possible clashes with actual field names
if (isset($cacheKeyInfo['isMetaColumn']) && $cacheKeyInfo['isMetaColumn'] && $prefixColumns) {
$fieldName = '.column:' . $fieldName;
}

$dqlAlias = $cacheKeyInfo['dqlAlias'];
$type = $cacheKeyInfo['type'];

Expand Down
2 changes: 1 addition & 1 deletion src/Internal/Hydration/ArrayHydrator.php
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ protected function hydrateRowData(array $row, array &$result): void
// 1) Initialize
$id = $this->idTemplate; // initialize the id-memory
$nonemptyComponents = [];
$rowData = $this->gatherRowData($row, $id, $nonemptyComponents);
$rowData = $this->gatherRowData($row, $id, $nonemptyComponents, false);

// 2) Now hydrate the data found in the current row.
foreach ($rowData['data'] as $dqlAlias => $data) {
Expand Down
7 changes: 4 additions & 3 deletions src/Internal/Hydration/ObjectHydrator.php
Original file line number Diff line number Diff line change
Expand Up @@ -228,10 +228,11 @@ private function getEntity(array $data, string $dqlAlias): object
throw HydrationException::missingDiscriminatorMetaMappingColumn($className, $fieldName, $dqlAlias);
}

$discrColumn = $this->resultSetMapping()->metaMappings[$fieldName];
$originalDiscrColumn = $this->resultSetMapping()->metaMappings[$fieldName];
$discrColumn = '.column:' . $originalDiscrColumn;

if (! isset($data[$discrColumn])) {
throw HydrationException::missingDiscriminatorColumn($className, $discrColumn, $dqlAlias);
throw HydrationException::missingDiscriminatorColumn($className, $originalDiscrColumn, $dqlAlias);
}

if ($data[$discrColumn] === '') {
Expand Down Expand Up @@ -278,7 +279,7 @@ private function getEntityFromIdentityMap(string $className, array $data): objec
array_map(
/** @return mixed */
static fn (string $fieldName) => isset($class->associationMappings[$fieldName]) && assert($class->associationMappings[$fieldName]->isToOneOwningSide())
? $data[$class->associationMappings[$fieldName]->joinColumns[0]->name]
? $data['.column:' . $class->associationMappings[$fieldName]->joinColumns[0]->name]
: $data[$fieldName],
$class->identifier,
),
Expand Down
5 changes: 4 additions & 1 deletion src/Internal/Hydration/SimpleObjectHydrator.php
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,10 @@ protected function hydrateRowData(array $row, array &$result): void
}
}

$fieldName = $cacheKeyInfo['fieldName'];
// Meta column field name is actually a column name. This
// prevents possible clashes with actual field names
$isMetaColumn = isset($cacheKeyInfo['isMetaColumn']) && $cacheKeyInfo['isMetaColumn'];
$fieldName = $isMetaColumn ? '.column:' . $cacheKeyInfo['fieldName'] : $cacheKeyInfo['fieldName'];

// Prevent overwrite in case of inherit classes using same property name (See AbstractHydrator)
if (! isset($data[$fieldName]) || ! $valueIsNull) {
Expand Down
4 changes: 2 additions & 2 deletions src/UnitOfWork.php
Original file line number Diff line number Diff line change
Expand Up @@ -2456,7 +2456,7 @@ public function createEntity(string $className, array $data, array &$hints = [])
assert($assoc->isToOneOwningSide());
// TODO: Is this even computed right in all cases of composite keys?
foreach ($assoc->targetToSourceKeyColumns as $targetColumn => $srcColumn) {
$joinColumnValue = $data[$srcColumn] ?? null;
$joinColumnValue = $data['.column:' . $srcColumn] ?? null;

if ($joinColumnValue !== null) {
if ($joinColumnValue instanceof BackedEnum) {
Expand Down Expand Up @@ -2667,7 +2667,7 @@ private function eagerLoadCollections(array $collections, ToManyInverseSideMappi
$data = $this->getOriginalEntityData($targetValue);
$id = [];
foreach ($targetClass->associationMappings[$mappedBy]->joinColumns as $joinColumn) {
$id[] = $data[$joinColumn->name];
$id[] = $data['.column:' . $joinColumn->name];
}
} else {
$id = $this->identifierFlattener->flattenIdentifier($class, $class->getIdentifierValues($sourceEntity));
Expand Down
2 changes: 1 addition & 1 deletion src/Utility/IdentifierFlattener.php
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ public function flattenIdentifier(ClassMetadata $class, array $id): array
$associatedId = [];

foreach ($class->associationMappings[$field]->joinColumns as $joinColumn) {
$associatedId[] = $id[$joinColumn->name];
$associatedId[] = $id['.column:' . $joinColumn->name];
}

$flatId[$field] = implode(' ', $associatedId);
Expand Down
27 changes: 27 additions & 0 deletions tests/Tests/Models/FieldColumnConflict/User.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<?php

declare(strict_types=1);

namespace Doctrine\Tests\Models\FieldColumnConflict;

use Doctrine\ORM\Mapping\Column;
use Doctrine\ORM\Mapping\Entity;
use Doctrine\ORM\Mapping\GeneratedValue;
use Doctrine\ORM\Mapping\Id;
use Doctrine\ORM\Mapping\JoinColumn;
use Doctrine\ORM\Mapping\OneToOne;
use Doctrine\ORM\Mapping\Table;

#[Table(name: 'user')]
#[Entity]
class User
{
#[Id]
#[Column(type: 'integer', name: 'user_id')]
#[GeneratedValue]
public int $id;

#[OneToOne(targetEntity: UserContent::class)]
#[JoinColumn(name: 'id', referencedColumnName: 'id')]
public UserContent|null $userContent;
}
22 changes: 22 additions & 0 deletions tests/Tests/Models/FieldColumnConflict/UserContent.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<?php

declare(strict_types=1);

namespace Doctrine\Tests\Models\FieldColumnConflict;

use Doctrine\ORM\Mapping\Column;
use Doctrine\ORM\Mapping\Entity;
use Doctrine\ORM\Mapping\Id;
use Doctrine\ORM\Mapping\Table;

#[Table(name: 'user_content')]
#[Entity]
class UserContent
{
#[Id]
#[Column(type: 'string')]
public string $id;

#[Column(type: 'string')]
public string $data;
}
43 changes: 43 additions & 0 deletions tests/Tests/ORM/Functional/Ticket/FieldColumnConflictTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
<?php

declare(strict_types=1);

namespace Doctrine\Tests\ORM\Functional\Ticket;

use Doctrine\Tests\Models\FieldColumnConflict\User;
use Doctrine\Tests\Models\FieldColumnConflict\UserContent;
use Doctrine\Tests\OrmFunctionalTestCase;

class FieldColumnConflictTest extends OrmFunctionalTestCase
{
protected function setUp(): void
{
parent::setUp();

$this->createSchemaForModels(User::class, UserContent::class);
}

public function testIssue(): void
{
$user = new User();
$user->id = 1;

$this->_em->persist($user);

$userContent = new UserContent();
$userContent->id = 'uuid';
$userContent->data = 'data';

$this->_em->persist($userContent);

$user->userContent = $userContent;

$this->_em->flush();
$this->_em->clear();

$user = $this->_em->find(User::class, 1);
self::assertSame(1, $user->id);
self::assertNotNull($user->userContent);
self::assertSame('uuid', $user->userContent->id);
}
}
2 changes: 1 addition & 1 deletion tests/Tests/ORM/Functional/Ticket/GH7869Test.php
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ public function getClassMetadata($className): ClassMetadata
];

$uow = new UnitOfWork($em);
$uow->createEntity(GH7869Appointment::class, ['id' => 1, 'patient_id' => 1], $hints);
$uow->createEntity(GH7869Appointment::class, ['id' => 1, '.column:patient_id' => 1], $hints);
$uow->clear();
$uow->triggerEagerLoads();

Expand Down
Loading