Hydratation error when two classes with the same parent class both define the same property with different types.

[m-r-r]

Bug Report

Q	A
BC Break	no
Version	2.6.3

Summary

SimpleObjectHydrator produces a type error when two classes with the same parent class both define a property with the same name and different types.

I think this may be related to issue #5989.

Current behavior

When two classes inherit from the same parent using SINGLE_TABLE inheritance, and both classes define the same property with different types, SimpleObjectHydrator produce a type error if one of the properties is of type simple_array.

How to reproduce

Create an abstract class with two child classes:

use Doctrine\ORM\Annotation as ORM;

/**
 * @ORM\Entity()
 * @ORM\Table(name="test_responses")
 * @ORM\InheritanceType("SINGLE_TABLE")
 * @ORM\DiscriminatorColumn(name="discr", type="string")
 * @ORM\DiscriminatorMap({
 *     "array"       = ArrayResponse::class,
 *     "text"        = TextResponse::class,
 * })
 */
abstract class AbstractResponse {
    /**
     * @ORM\Id @ORM\GeneratedValue
     * @ORM\Column(type="integer")
     */
    public $id;
}

Create two child classes. Each class defines the same property with different types.
The first class use the type simple_array and the second class has a string property :

/**
 * @ORM\Entity()
 */
class ArrayResponse extends AbstractResponse {
    /**
     * @ORM\Column(name="value_array", type="simple_array")
     *
     * @var array
     */
    public $value = [];
}

/**
 * @ORM\Entity()
 */
class TextResponse extends AbstractResponse {
    /**
     * @ORM\Column(name="value_string", type="string")
     *
     * @var string|null
     */
    public $value = null;
}

Create an instance of the second class and flush the EntityManager:

$textResponse = new TextResponse();
$em->persist($textResponse);
$em->flush();

Clear the EntityManager and fetch the instance:

$em->clear();

/** @var TextResponse $arrayResponse */
$textResponse = $em->getRepository(AbstractResponse::class)
                   ->find($textResponse->id);

var_dump($textResponse->value); // Display an empty array (type error)

Expected behavior

The value of $textResponse->value should be NULL, because the property $value of class TextResponse has type string|null.

[m-r-r]

I'm creating a pull request with a failing test case.

[Ocramius]

This should be a validation error: these columns MUST have different names.

[m-r-r]

@Ocramius Thanks for answering so quickly and noticing that: I made an error when writing the issue and the names of the columns are missing in the annotation.

The behavior is the same when the columns have different names, I updated the code in the issue to fix the column names.

[Ocramius]

@m-r-r there are two issues then:

1. two ReflectionProperty with same #getName(), same #getDeclaringClass()->getParentClass(), but same #getName() lead to incorrect hydration
2. two ReflectionProperty with same #getName(), same #getDeclaringClass()->getParentClass(), but same #getName() and mapped with same @Column(name=) should lead to the SchemaValidator rejecting them.

[m-r-r]

@Ocramius Ok ! Should I open a second issue for the validation problem ?

[Ocramius]

@m-r-r yes please, or maybe just create a failing test case involving the schema validator 👍

[beberlei]

@Ocramius the hydrator code has multiple paths where it has comments mentioning the handling of duplicate field names across the hierachy, so it is actually supported to do this right now.

[beberlei]

Fixed