forked from doctrine/data-fixtures
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ReferenceRepository.php
255 lines (224 loc) · 6.2 KB
/
ReferenceRepository.php
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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
<?php
declare(strict_types=1);
namespace Doctrine\Common\DataFixtures;
use BadMethodCallException;
use Doctrine\ODM\PHPCR\DocumentManager as PhpcrDocumentManager;
use Doctrine\Persistence\ObjectManager;
use OutOfBoundsException;
use function array_key_exists;
use function array_keys;
use function get_class;
use function method_exists;
use function sprintf;
/**
* ReferenceRepository class manages references for
* fixtures in order to easily support the relations
* between fixtures
*/
class ReferenceRepository
{
/**
* List of named references to the fixture objects
* gathered during loads of fixtures
*
* @var array
*/
private $references = [];
/**
* List of identifiers stored for references
* in case if reference gets unmanaged, it will
* use a proxy referenced by this identity
*
* @var array
*/
private $identities = [];
/**
* Currently used object manager
*
* @var ObjectManager
*/
private $manager;
public function __construct(ObjectManager $manager)
{
$this->manager = $manager;
}
/**
* Get identifier for a unit of work
*
* @param object $reference Reference object
* @param object $uow Unit of work
*
* @return array
*/
protected function getIdentifier($reference, $uow)
{
// In case Reference is not yet managed in UnitOfWork
if (! $this->hasIdentifier($reference)) {
$class = $this->manager->getClassMetadata(get_class($reference));
return $class->getIdentifierValues($reference);
}
// Dealing with ORM UnitOfWork
if (method_exists($uow, 'getEntityIdentifier')) {
return $uow->getEntityIdentifier($reference);
}
// PHPCR ODM UnitOfWork
if ($this->manager instanceof PhpcrDocumentManager) {
return $uow->getDocumentId($reference);
}
// ODM UnitOfWork
return $uow->getDocumentIdentifier($reference);
}
/**
* Set the reference entry identified by $name
* and referenced to $reference. If $name
* already is set, it overrides it
*
* @param string $name
* @param object $reference
*/
public function setReference($name, $reference)
{
$this->references[$name] = $reference;
if (! $this->hasIdentifier($reference)) {
return;
}
// in case if reference is set after flush, store its identity
$uow = $this->manager->getUnitOfWork();
$this->identities[$name] = $this->getIdentifier($reference, $uow);
}
/**
* Store the identifier of a reference
*
* @param string $name
* @param mixed $identity
*/
public function setReferenceIdentity($name, $identity)
{
$this->identities[$name] = $identity;
}
/**
* Set the reference entry identified by $name
* and referenced to managed $object. $name must
* not be set yet
*
* Notice: in case if identifier is generated after
* the record is inserted, be sure tu use this method
* after $object is flushed
*
* @param string $name
* @param object $object - managed object
*
* @return void
*
* @throws BadMethodCallException - if repository already has a reference by $name.
*/
public function addReference($name, $object)
{
if (isset($this->references[$name])) {
throw new BadMethodCallException(sprintf('Reference to "%s" already exists, use method setReference in order to override it', $name));
}
$this->setReference($name, $object);
}
/**
* Loads an object using stored reference
* named by $name
*
* @param string $name
*
* @return object
*
* @throws OutOfBoundsException - if repository does not exist.
*/
public function getReference($name)
{
if (! $this->hasReference($name)) {
throw new OutOfBoundsException(sprintf('Reference to "%s" does not exist', $name));
}
$reference = $this->references[$name];
$meta = $this->manager->getClassMetadata(get_class($reference));
if (! $this->manager->contains($reference) && isset($this->identities[$name])) {
$reference = $this->manager->getReference(
$meta->name,
$this->identities[$name]
);
$this->references[$name] = $reference; // already in identity map
}
return $reference;
}
/**
* Check if an object is stored using reference
* named by $name
*
* @param string $name
*
* @return bool
*/
public function hasReference($name)
{
return isset($this->references[$name]);
}
/**
* Searches for reference names in the
* list of stored references
*
* @param object $reference
*
* @return array
*/
public function getReferenceNames($reference)
{
return array_keys($this->references, $reference, true);
}
/**
* Checks if reference has identity stored
*
* @param string $name
*/
public function hasIdentity($name)
{
return array_key_exists($name, $this->identities);
}
/**
* Get all stored identities
*
* @return array
*/
public function getIdentities()
{
return $this->identities;
}
/**
* Get all stored references
*
* @return array
*/
public function getReferences()
{
return $this->references;
}
/**
* Get object manager
*
* @return ObjectManager
*/
public function getManager()
{
return $this->manager;
}
/**
* Checks if object has identifier already in unit of work.
*
* @param string $reference
*
* @return bool
*/
private function hasIdentifier($reference)
{
// in case if reference is set after flush, store its identity
$uow = $this->manager->getUnitOfWork();
if ($this->manager instanceof PhpcrDocumentManager) {
return $uow->contains($reference);
}
return $uow->isInIdentityMap($reference);
}
}