File: GH10288Test.php

package info (click to toggle)
doctrine 2.14.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 10,612 kB
  • sloc: php: 113,660; xml: 4,630; makefile: 28; sh: 14
file content (240 lines) | stat: -rw-r--r-- 6,128 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
<?php

declare(strict_types=1);

namespace Doctrine\Tests\ORM\Functional\Ticket;

use Doctrine\DBAL\Platforms\AbstractPlatform;
use Doctrine\DBAL\Types\StringType;
use Doctrine\DBAL\Types\Type;
use Doctrine\ORM\AbstractQuery;
use Doctrine\ORM\Mapping\Column;
use Doctrine\ORM\Mapping\DiscriminatorColumn;
use Doctrine\ORM\Mapping\DiscriminatorMap;
use Doctrine\ORM\Mapping\Entity;
use Doctrine\ORM\Mapping\GeneratedValue;
use Doctrine\ORM\Mapping\Id;
use Doctrine\ORM\Mapping\InheritanceType;
use Doctrine\Tests\Models\GH10288\GH10288People;
use Doctrine\Tests\OrmFunctionalTestCase;

/**
 * This test makes sure that Discriminator columns can use both custom types using PHP enums as well as
 * enumType definition of enums.
 *
 * @requires PHP 8.1
 */
class GH10288Test extends OrmFunctionalTestCase
{
    protected function setUp(): void
    {
        parent::setUp();

        if (Type::hasType(GH10288PeopleType::NAME)) {
            Type::overrideType(GH10288PeopleType::NAME, GH10288PeopleType::class);
        } else {
            Type::addType(GH10288PeopleType::NAME, GH10288PeopleType::class);
        }

        $this->createSchemaForModels(
            GH10288PersonWithEnumType::class,
            GH10288BossWithEnumType::class,
            GH10288EmployeeWithEnumType::class,
            GH10288PersonCustomEnumType::class,
            GH10288BossCustomEnumType::class,
            GH10288EmployeeCustomEnumType::class
        );
    }

    /**
     * @param class-string $personType
     * @psalm-param GH10288BossWithEnumType|GH10288BossCustomEnumType $boss
     * @psalm-param GH10288EmployeeWithEnumType|GH10288EmployeeCustomEnumType $employee
     */
    private function performEnumDiscriminatorTest($boss, $employee, string $personType): void
    {
        $boss->bossId = 1;

        $this->_em->persist($boss);
        $this->_em->persist($employee);
        $this->_em->flush();
        $bossId = $boss->id;
        $this->_em->clear();

        // Using DQL here to make sure that we'll use ObjectHydrator instead of SimpleObjectHydrator
        $query = $this->_em->createQueryBuilder()
            ->select('person')
            ->from($personType, 'person')
            ->where('person.name = :name')
            ->setMaxResults(1)
            ->getQuery();

        $query->setParameter('name', 'John');

        self::assertEquals($boss, $query->getOneOrNullResult(AbstractQuery::HYDRATE_OBJECT));
        self::assertEquals(
            GH10288People::BOSS,
            $query->getOneOrNullResult(AbstractQuery::HYDRATE_ARRAY)['discr']
        );

        $query->setParameter('name', 'Bob');
        self::assertEquals($employee, $query->getOneOrNullResult(AbstractQuery::HYDRATE_OBJECT));
        self::assertEquals(
            GH10288People::EMPLOYEE,
            $query->getOneOrNullResult(AbstractQuery::HYDRATE_ARRAY)['discr']
        );

        $this->_em->clear();

        // test SimpleObjectHydrator
        $bossFetched = $this->_em->find($personType, $bossId);
        self::assertEquals($boss, $bossFetched);
    }

    /**
     * @group GH10288
     */
    public function testEnumDiscriminatorWithEnumType(): void
    {
        $boss     = new GH10288BossWithEnumType('John');
        $employee = new GH10288EmployeeWithEnumType('Bob');

        $this->performEnumDiscriminatorTest($boss, $employee, GH10288PersonWithEnumType::class);
    }

    /**
     * @group GH10288
     */
    public function testEnumDiscriminatorWithCustomEnumType(): void
    {
        $boss     = new GH10288BossCustomEnumType('John');
        $employee = new GH10288EmployeeCustomEnumType('Bob');

        $this->performEnumDiscriminatorTest($boss, $employee, GH10288PersonCustomEnumType::class);
    }
}

class GH10288PeopleType extends StringType
{
    public const NAME = 'GH10288PeopleType';

    /**
     * {@inheritdoc}
     */
    public function convertToDatabaseValue($value, AbstractPlatform $platform)
    {
        if (! $value instanceof GH10288People) {
            $value = GH10288People::from($value);
        }

        return $value->value;
    }

    /**
     * {@inheritdoc}
     */
    public function convertToPHPValue($value, AbstractPlatform $platform)
    {
        return GH10288People::from($value);
    }

    /**
     * {@inheritdoc}
     */
    public function getName()
    {
        return self::NAME;
    }
}

/**
 * @Entity
 * @InheritanceType("JOINED")
 * @DiscriminatorColumn(name="discr", enumType=GH10288People::class)
 * @DiscriminatorMap({
 *      "boss"     = GH10288BossWithEnumType::class,
 *      "employee" = GH10288EmployeeWithEnumType::class
 * })
 */
abstract class GH10288PersonWithEnumType
{
    /**
     * @var int
     * @Id
     * @Column(type="integer")
     * @GeneratedValue(strategy="AUTO")
     */
    public $id;

    /**
     * @var string
     * @Column(type="string", length=255)
     */
    public $name;

    public function __construct(string $name)
    {
        $this->name = $name;
    }
}

/** @Entity */
class GH10288BossWithEnumType extends GH10288PersonWithEnumType
{
    /**
     * @var int
     * @Column(type="integer")
     */
    public $bossId;
}

/** @Entity */
class GH10288EmployeeWithEnumType extends GH10288PersonWithEnumType
{
}

/**
 * @Entity
 * @InheritanceType("SINGLE_TABLE")
 * @DiscriminatorColumn(name="discr", type="GH10288PeopleType")
 * @DiscriminatorMap({
 *      "boss"     = GH10288BossCustomEnumType::class,
 *      "employee" = GH10288EmployeeCustomEnumType::class
 * })
 */
abstract class GH10288PersonCustomEnumType
{
    /**
     * @var int
     * @Id
     * @Column(type="integer")
     * @GeneratedValue(strategy="AUTO")
     */
    public $id;

    /**
     * @var string
     * @Column(type="string", length=255)
     */
    public $name;

    public function __construct(string $name)
    {
        $this->name = $name;
    }
}

/** @Entity */
class GH10288BossCustomEnumType extends GH10288PersonCustomEnumType
{
    /**
     * @var int
     * @Column(type="integer")
     */
    public $bossId;
}

/** @Entity */
class GH10288EmployeeCustomEnumType extends GH10288PersonCustomEnumType
{
}