forked from doctrine/phpcr-odm
/
UnitOfWork.php
1220 lines (1075 loc) · 46.9 KB
/
UnitOfWork.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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* This software consists of voluntary contributions made by many individuals
* and is licensed under the LGPL. For more information, see
* <http://www.doctrine-project.org>.
*/
namespace Doctrine\ODM\PHPCR;
use Doctrine\ODM\PHPCR\Mapping\ClassMetadata;
use Doctrine\Common\Collections\Collection;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\ODM\PHPCR\Event\LifecycleEventArgs;
use Doctrine\ODM\PHPCR\Event\OnFlushEventArgs;
use PHPCR\PropertyType;
/**
* Unit of work class
*
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @link www.doctrine-project.com
* @since 1.0
* @author Jordi Boggiano <j.boggiano@seld.be>
* @author Pascal Helfenstein <nicam@nicam.ch>
*/
class UnitOfWork
{
const STATE_NEW = 1;
const STATE_MANAGED = 2;
const STATE_REMOVED = 3;
const STATE_DETACHED = 4;
/**
* @var DocumentManager
*/
private $dm = null;
/**
* @var array
*/
private $identityMap = array();
/**
* @var array
*/
private $nodesMap = array();
/**
* @var array
*/
private $documentIds = array();
/**
* @var array
*/
private $documentRevisions = array();
/**
* @var array
*/
private $documentState = array();
/**
* PHPCR always returns and updates the whole data of a document. If on update data is "missing"
* this means the data is deleted. This also applies to attachments. This is why we need to ensure
* that data that is not mapped is not lost. This map here saves all the "left-over" data and keeps
* track of it if necessary.
*
* @var array
*/
private $nonMappedData = array();
/**
* @var array
*/
private $originalData = array();
/**
* @var array
*/
private $documentChangesets = array();
/**
* @var array
*/
private $scheduledUpdates = array();
/**
* @var array
*/
private $scheduledInserts = array();
/**
* @var array
*/
private $scheduledRemovals = array();
/**
* @var array
*/
private $visitedCollections = array();
/**
* @var array
*/
private $idGenerators = array();
/**
* @var EventManager
*/
private $evm;
/**
* @var DocumentNameMapperInterface
*/
private $documentNameMapper;
/**
* @var boolean
*/
private $validateDocumentName;
/**
* @var boolean
*/
private $writeMetadata;
/**
* @param DocumentManager $dm
*/
public function __construct(DocumentManager $dm, DocumentNameMapperInterface $documentNameMapper = null)
{
$this->dm = $dm;
$this->evm = $dm->getEventManager();
$this->documentNameMapper = $documentNameMapper;
$this->validateDocumentName = $this->dm->getConfiguration()->getValidateDoctrineMetadata();
$this->writeMetadata = $this->dm->getConfiguration()->getWriteDoctrineMetadata();
}
/**
* Get an already fetched node for the proxyDocument from the nodesMap and create the associated document
*
* @param string $documentName
* @param Proxy $document
* @return void
*/
public function refreshDocumentForProxy($documentName, $document)
{
$node = $this->nodesMap[spl_object_hash($document)];
$hints = array('refresh' => true);
$this->createDocument($documentName, $node, $hints);
}
/**
* Create a document given class, data and the doc-id and revision
*
* @param string $documentName
* @param \PHPCR\NodeInterface $node
* @param array $hints
* @return object
*/
public function createDocument($documentName, $node, array &$hints = array())
{
// get uuid rather than dereference reference properties
$properties = $node->getPropertiesValues(null, false);
if ($this->documentNameMapper) {
$type = $this->documentNameMapper->getDocumentName($this->dm, $documentName, $node, $this->writeMetadata);
$class = $this->dm->getClassMetadata($type);
} else {
if (isset($documentName)) {
$class = $this->dm->getClassMetadata($documentName);
} elseif (isset($properties['phpcr:class'])) {
$class = $this->dm->getClassMetadata($properties['phpcr:class']);
} elseif (isset($properties['phpcr:alias'])) {
$class = $this->dm->getMetadataFactory()->getMetadataForAlias($properties['phpcr:alias']);
}
if ($this->writeMetadata && empty($properties['phpcr:class']) && isset($class)) {
$node->setProperty('phpcr:class', $class->name, PropertyType::STRING);
}
}
if (empty($class)) {
throw new \InvalidArgumentException("Could not determine Doctrine metadata for node");
}
$documentState = array();
$nonMappedData = array();
$id = $node->getPath();
foreach ($class->fieldMappings as $fieldName => $mapping) {
if (isset($properties[$mapping['name']])) {
if ($mapping['multivalue']) {
$documentState[$fieldName] = new ArrayCollection((array)$properties[$mapping['name']]);
} else {
$documentState[$fieldName] = $properties[$mapping['name']];
}
}
}
if ($class->node) {
$documentState[$class->node] = $node;
}
if ($class->versionField) {
$documentState[$class->versionField] = $properties['jcr:baseVersion'];
}
if ($class->identifier) {
$documentState[$class->identifier] = $node->getPath();
}
// collect uuids of all referenced nodes and get them all within one single call
// they will get cached so you have more performance when they are accessed later
$refNodeUUIDs = array();
foreach ($class->associationsMappings as $assocOptions) {
if (!$node->hasProperty($assocOptions['fieldName'])) {
continue;
}
if ($assocOptions['type'] & ClassMetadata::MANY_TO_ONE) {
$refNodeUUIDs[] = $node->getProperty($assocOptions['fieldName'])->getString();
} elseif ($assocOptions['type'] & ClassMetadata::MANY_TO_MANY) {
foreach ($node->getProperty($assocOptions['fieldName'])->getString() as $uuid) {
$refNodeUUIDs[] = $uuid;
}
}
}
if (count($refNodeUUIDs) > 0) {
$session = $this->dm->getPhpcrSession();
// ensure that the given nodes are in the in memory cache
$session->getNodesByIdentifier($refNodeUUIDs);
}
// initialize inverse side collections
foreach ($class->associationsMappings as $assocName => $assocOptions) {
if ($assocOptions['type'] & ClassMetadata::MANY_TO_ONE) {
// TODO figure this one out which collection should be used
if (! $node->hasProperty($assocOptions['fieldName'])) {
continue;
}
// get the already cached referenced node
$referencedNode = $node->getPropertyValue($assocOptions['fieldName']);
$referencedId = $referencedNode->getPath();
// check if referenced document already exists
if (isset($this->identityMap[$referencedId])) {
$documentState[$class->associationsMappings[$assocName]['fieldName']] = $this->identityMap[$referencedId];
} else {
$config = $this->dm->getConfiguration();
$this->referenceProxyFactory = new Proxy\ReferenceProxyFactory($this->dm, $config->getProxyDir(), $config->getProxyNamespace(), true);
$referencedClass = $this->dm->getMetadataFactory()->getMetadataFor(ltrim($assocOptions['targetDocument'], '\\'));
$proxyDocument = $this->referenceProxyFactory->getProxy($referencedClass->name, $referencedId);
// register the referenced document under its own id
$this->registerManaged($proxyDocument, $referencedId, null);
$documentState[$class->associationsMappings[$assocName]['fieldName']] = $proxyDocument;
// save node for the case that the referenced document will be created
$proxyOid = spl_object_hash($proxyDocument);
$this->nodesMap[$proxyOid] = $referencedNode;
}
} elseif ($assocOptions['type'] & ClassMetadata::MANY_TO_MANY) {
if (! $node->hasProperty($assocOptions['fieldName'])) {
continue;
}
// get the already cached referenced nodes
$proxyNodes = $node->getPropertyValue($assocOptions['fieldName']);
if (!is_array($proxyNodes)) {
throw new PHPCRException("Expected referenced nodes passed as array.");
}
$config = $this->dm->getConfiguration();
$this->referenceProxyFactory = new Proxy\ReferenceProxyFactory($this->dm, $config->getProxyDir(), $config->getProxyNamespace(), true);
foreach ($proxyNodes as $referencedNode) {
$referencedId = $referencedNode->getPath();
// check if referenced document already exists
if (isset($this->identityMap[$referencedId])) {
$documentState[$class->associationsMappings[$assocName]['fieldName']][] = $this->identityMap[$referencedId];
} else {
$referencedClass = $this->dm->getMetadataFactory()->getMetadataFor(ltrim($assocOptions['targetDocument'], '\\'));
$proxyDocument = $this->referenceProxyFactory->getProxy($referencedClass->name, $referencedId);
// register the referenced document under its own id
$this->registerManaged($proxyDocument, $referencedId, null);
$documentState[$class->associationsMappings[$assocName]['fieldName']][] = $proxyDocument;
// save node for the case that the referenced document will be created
$proxyOid = spl_object_hash($proxyDocument);
$this->nodesMap[$proxyOid] = $referencedNode;
}
}
}
}
foreach ($class->childMappings as $childName => $mapping) {
if ($node->hasNode($mapping['name'])) {
$documentState[$class->childMappings[$childName]['fieldName']] = $this->createDocument(null, $node->getNode($mapping['name']));
} else {
$documentState[$class->childMappings[$childName]['fieldName']] = null;
}
}
if (isset($this->identityMap[$id])) {
$document = $this->identityMap[$id];
$overrideLocalValues = false;
if (isset($hints['refresh'])) {
$overrideLocalValues = true;
$oid = spl_object_hash($document);
}
} else {
$document = $class->newInstance();
$this->identityMap[$id] = $document;
$oid = spl_object_hash($document);
$this->documentState[$oid] = self::STATE_MANAGED;
$this->documentIds[$oid] = $id;
$overrideLocalValues = true;
}
foreach ($class->childrenMappings as $mapping) {
$documentState[$mapping['fieldName']] = new ChildrenCollection($document, $this->dm, $mapping['filter']);
}
foreach ($class->referrersMappings as $mapping) {
$documentState[$mapping['fieldName']] = new ReferrersCollection($document, $this->dm, $mapping['referenceType'], $mapping['filterName']);
}
if (isset($documentName) && $this->validateDocumentName && !($document instanceof $documentName)) {
$msg = "Doctrine metadata mismatch! Requested type '$documentName' type does not match type '{$class->name}' stored in the metadata";
throw new \InvalidArgumentException($msg);
}
if ($overrideLocalValues) {
$this->nodesMap[$oid] = $node;
$this->nonMappedData[$oid] = $nonMappedData;
foreach ($class->reflFields as $prop => $reflFields) {
$value = isset($documentState[$prop]) ? $documentState[$prop] : null;
$reflFields->setValue($document, $value);
$this->originalData[$oid][$prop] = $value;
}
}
// Invoke the postLoad lifecycle callbacks and listeners
if (isset($class->lifecycleCallbacks[Event::postLoad])) {
$class->invokeLifecycleCallbacks(Event::postLoad, $document);
}
if ($this->evm->hasListeners(Event::postLoad)) {
$this->evm->dispatchEvent(Event::postLoad, new Event\LifecycleEventArgs($document, $this->dm));
}
return $document;
}
/**
* @param object $document
* @return array
*/
public function getOriginalData($document)
{
return $this->originalData[spl_object_hash($document)];
}
/**
* Schedule insertion of this document and cascade if neccessary.
*
* @param object $document
* @param string $id
*/
public function scheduleInsert($document)
{
$visited = array();
$this->doScheduleInsert($document, $visited);
}
private function doScheduleInsert($document, &$visited, $overrideIdGenerator = null)
{
$oid = spl_object_hash($document);
if (isset($visited[$oid])) {
return;
}
$visited[$oid] = true;
$class = $this->dm->getClassMetadata(get_class($document));
$state = $this->getDocumentState($document);
switch ($state) {
case self::STATE_NEW:
$this->persistNew($class, $document, $overrideIdGenerator);
break;
case self::STATE_MANAGED:
// TODO: Change Tracking Deferred Explicit
break;
case self::STATE_REMOVED:
// document becomes managed again
unset($this->scheduledRemovals[$oid]);
$this->documentState[$oid] = self::STATE_MANAGED;
break;
case self::STATE_DETACHED:
throw new \InvalidArgumentException("Detached entity passed to persist().");
break;
}
$this->cascadeScheduleInsert($class, $document, $visited);
}
/**
*
* @param ClassMetadata $class
* @param object $document
* @param array $visited
*/
private function cascadeScheduleInsert($class, $document, &$visited)
{
foreach ($class->associationsMappings as $assocName => $assoc) {
$related = $class->reflFields[$assocName]->getValue($document);
if ($related !== null) {
if ($class->associationsMappings[$assocName]['type'] & ClassMetadata::TO_ONE) {
if (is_array($related)) {
throw new PHPCRException("Referenced document is not stored correctly in a reference-one property. Don't use array notation.");
}
if ($this->getDocumentState($related) == self::STATE_NEW) {
$this->doScheduleInsert($related, $visited);
}
} else {
// $related can never be a persistent collection in case of a new entity.
if (!is_array($related)) {
throw new PHPCRException("Referenced document is not stored correctly in a reference-many property. Use array notation.");
}
foreach ($related as $relatedDocument) {
if (isset($relatedDocument) && $this->getDocumentState($relatedDocument) == self::STATE_NEW) {
$this->doScheduleInsert($relatedDocument, $visited);
}
}
}
}
}
foreach ($class->childMappings as $childName => $mapping) {
$child = $class->reflFields[$childName]->getValue($document);
if ($child !== null && $this->getDocumentState($child) == self::STATE_NEW) {
$childClass = $this->dm->getClassMetadata(get_class($child));
$id = $class->reflFields[$class->identifier]->getValue($document);
$childClass->reflFields[$childClass->identifier]->setValue($child , $id . '/'. $mapping['name']);
$this->doScheduleInsert($child, $visited, ClassMetadata::GENERATOR_TYPE_ASSIGNED);
}
}
foreach ($class->referrersMappings as $referrerName => $mapping) {
$referrer = $class->reflFields[$referrerName]->getValue($document);
if ($referrer !== null && $this->getDocumentState($referrer) == self::STATE_NEW) {
$this->doScheduleInsert($referrer, $visited);
}
}
}
private function getIdGenerator($type)
{
if (!isset($this->idGenerators[$type])) {
$this->idGenerators[$type] = Id\IdGenerator::create($type);
}
return $this->idGenerators[$type];
}
public function scheduleRemove($document)
{
$oid = spl_object_hash($document);
$this->scheduledRemovals[$oid] = $document;
$this->documentState[$oid] = self::STATE_REMOVED;
$class = $this->dm->getClassMetadata(get_class($document));
if (isset($class->lifecycleCallbacks[Event::preRemove])) {
$class->invokeLifecycleCallbacks(Event::preRemove, $document);
}
if ($this->evm->hasListeners(Event::preRemove)) {
$this->evm->dispatchEvent(Event::preRemove, new LifecycleEventArgs($document, $this->dm));
}
}
/**
* recurse over all known child documents to remove them form this unit of work
* as their parent gets removed from phpcr. If you do not, flush will try to create
* orphaned nodes if these documents are modified which leads to a PHPCR exception
*/
private function purgeChildren($document)
{
$class = $this->dm->getClassMetadata(get_class($document));
foreach ($class->childMappings as $childName => $mapping) {
$child = $class->reflFields[$childName]->getValue($document);
if ($child !== null) {
$this->purgeChildren($child);
$oid = spl_object_hash($child);
unset(
$this->scheduledRemovals[$oid],
$this->scheduledInserts[$oid],
$this->scheduledUpdates[$oid]
);
$this->removeFromIdentityMap($child);
}
}
}
public function getDocumentState($document)
{
$oid = spl_object_hash($document);
if (isset($this->documentState[$oid])) {
return $this->documentState[$oid];
}
return self::STATE_NEW;
}
private function detectChangedDocuments()
{
foreach ($this->identityMap as $document) {
$state = $this->getDocumentState($document);
if ($state == self::STATE_MANAGED) {
$class = $this->dm->getClassMetadata(get_class($document));
$this->computeChangeSet($class, $document);
}
}
}
/**
* @param ClassMetadata $class
* @param object $document
* @return void
*/
public function computeChangeSet(ClassMetadata $class, $document)
{
$oid = spl_object_hash($document);
$actualData = array();
foreach ($class->reflFields as $fieldName => $reflProperty) {
$value = $reflProperty->getValue($document);
if ($class->isCollectionValuedAssociation($fieldName)
&& $value !== null
&& !($value instanceof PersistentCollection)
) {
if (!$value instanceof Collection) {
$value = new ArrayCollection($value);
}
// TODO coll shold be a new PersistentCollection
$coll = $value;
$class->reflFields[$fieldName]->setValue($document, $coll);
$actualData[$fieldName] = $coll;
} else {
$actualData[$fieldName] = $value;
}
}
// unset the revision field if necessary, it is not to be managed by the user in write scenarios.
if ($class->isVersioned) {
unset($actualData[$class->versionField]);
}
if (!isset($this->originalData[$oid])) {
// Entity is New and should be inserted
$this->originalData[$oid] = $actualData;
$this->documentChangesets[$oid] = $actualData;
$this->scheduledInserts[$oid] = $document;
} else {
// Entity is "fully" MANAGED: it was already fully persisted before
// and we have a copy of the original data
$changed = false;
foreach ($actualData as $fieldName => $fieldValue) {
if (!isset($class->fieldMappings[$fieldName])
&& !isset($class->childMappings[$fieldName])
&& !isset($class->associationsMappings[$fieldName])
&& !isset($class->referrersMappings[$fieldName])
) {
continue;
}
if ($class->isCollectionValuedAssociation($fieldName)) {
if (!$fieldValue instanceof PersistentCollection) {
// if its not a persistent collection and the original value changed. otherwise it could just be null
if($this->originalData[$oid][$fieldName] !== $fieldValue) {
$changed = true;
break;
}
} elseif ($fieldValue->changed()) {
$this->visitedCollections[] = $fieldValue;
$changed = true;
break;
}
} elseif ($this->originalData[$oid][$fieldName] !== $fieldValue) {
$changed = true;
break;
}
}
if ($changed) {
$this->documentChangesets[$oid] = $actualData;
$this->scheduledUpdates[$oid] = $document;
}
}
$id = $class->reflFields[$class->identifier]->getValue($document);
foreach ($class->childMappings as $name => $childMapping) {
if ($this->originalData[$oid][$name]) {
$this->computeChildChanges($childMapping, $this->originalData[$oid][$name], $id);
}
}
foreach ($class->associationsMappings as $assocName => $assoc) {
if ($actualData[$assocName]) {
if (is_array($actualData[$assocName])) {
foreach ($actualData[$assocName] as $ref) {
if ($ref !== null) {
$this->computeReferenceChanges($assoc, $ref, $id);
}
}
} else {
$this->computeReferenceChanges($assoc, $actualData[$assocName], $id);
}
}
}
foreach ($class->referrersMappings as $name => $referrerMapping) {
if ($this->originalData[$oid][$name]) {
foreach ($this->originalData[$oid][$name] as $referrer) {
$this->computeReferrerChanges($referrerMapping, $referrer, $id);
}
}
}
}
/**
* Computes the changes of a child.
*
* @param mixed $child the child document.
*/
private function computeChildChanges($mapping, $child, $parentId)
{
$targetClass = $this->dm->getClassMetadata(get_class($child));
$state = $this->getDocumentState($child);
if ($state == self::STATE_NEW) {
$targetClass->reflFields[$targetClass->identifier]->setValue($child , $parentId . '/'. $mapping['name']);
$this->persistNew($targetClass, $child, ClassMetadata::GENERATOR_TYPE_ASSIGNED);
$this->computeChangeSet($targetClass, $child);
} elseif ($state == self::STATE_REMOVED) {
throw new \InvalidArgumentException("Removed child document detected during flush");
} elseif ($state == self::STATE_DETACHED) {
throw new \InvalidArgumentException("A detached document was found through a "
. "child relationship during cascading a persist operation.");
}
}
/**
* Computes the changes of a reference.
*
* @param mixed $reference the referenced document.
*/
private function computeReferenceChanges($mapping, $reference, $referrerId)
{
$targetClass = $this->dm->getClassMetadata(get_class($reference));
$state = $this->getDocumentState($reference);
if ($state == self::STATE_NEW) {
$this->persistNew($targetClass, $reference, ClassMetadata::GENERATOR_TYPE_ASSIGNED);
$this->computeChangeSet($targetClass, $reference);
} elseif ($state == self::STATE_DETACHED) {
throw new \InvalidArgumentException("A detached document was found through a "
. "reference during cascading a persist operation.");
}
}
/**
* Computes the changes of a referrer.
*
* @param mixed $referrer the referenced document.
*/
private function computeReferrerChanges($mapping, $referrer, $referenceId)
{
$targetClass = $this->dm->getClassMetadata(get_class($referrer));
$state = $this->getDocumentState($referrer);
switch ($state) {
case self::STATE_NEW:
$this->persistNew($targetClass, $referrer, ClassMetadata::GENERATOR_TYPE_ASSIGNED);
$this->computeChangeSet($targetClass, $referrer);
break;
case self::STATE_DETACHED:
// TODO: can this actually happen?
throw new \InvalidArgumentException("A detached document was found through a "
. "referrer during cascading a persist operation.");
}
}
/**
* Gets the changeset for an document.
*
* @return array
*/
public function getDocumentChangeSet($document)
{
$oid = spl_object_hash($document);
if (isset($this->documentChangesets[$oid])) {
return $this->documentChangesets[$oid];
}
return array();
}
/**
* Persist new document, marking it managed and generating the id.
*
* This method is either called through `DocumentManager#persist()` or during `DocumentManager#flush()`,
* when persistence by reachability is applied.
*
* @param ClassMetadata $class
* @param object $document
* @return void
*/
public function persistNew($class, $document, $overrideIdGenerator = null)
{
$id = $this->getIdGenerator($overrideIdGenerator ? $overrideIdGenerator : $class->idGenerator)->generate($document, $class, $this->dm);
$this->registerManaged($document, $id, null);
if (isset($class->lifecycleCallbacks[Event::prePersist])) {
$class->invokeLifecycleCallbacks(Event::prePersist, $document);
}
if ($this->evm->hasListeners(Event::prePersist)) {
$this->evm->dispatchEvent(Event::prePersist, new LifecycleEventArgs($document, $this->dm));
}
}
/**
* Flush Operation - Write all dirty entries to the PHPCR.
*
* @param boolean $persist_to_backend Whether the phpcr session should be saved to permanent storage.
* (temporary workaround until all phpcr functionality is mapped in the doctrine-phpcr-odm)
*
* @return void
*
* @throws PHPCRException if it detects that a existing child should be replaced
*/
public function flush($persist_to_backend = true)
{
$this->detectChangedDocuments();
if ($this->evm->hasListeners(Event::onFlush)) {
$this->evm->dispatchEvent(Event::onFlush, new OnFlushEventArgs($this));
}
$config = $this->dm->getConfiguration();
$useDoctrineMetadata = $config->getWriteDoctrineMetadata();
$session = $this->dm->getPhpcrSession();
if ($persist_to_backend) {
try {
$utx = $session->getWorkspace()->getTransactionManager();
$utx->begin();
} catch (\PHPCR\UnsupportedRepositoryOperationException $e) {
$utx = null;
}
}
foreach ($this->scheduledRemovals as $oid => $document) {
$this->nodesMap[$oid]->remove();
$this->removeFromIdentityMap($document);
$this->purgeChildren($document);
}
foreach ($this->scheduledInserts as $oid => $document) {
$class = $this->dm->getClassMetadata(get_class($document));
// FIXME: this leads to prePersist being called twice, because its also invoked in persistNew
// which is the right place? mongo does this differently.
if (isset($class->lifecycleCallbacks[Event::prePersist])) {
$class->invokeLifecycleCallbacks(Event::prePersist, $document);
$this->computeChangeSet($class, $document); // TODO: prevent association computations in this case?
}
if ($this->evm->hasListeners(Event::prePersist)) {
$this->evm->dispatchEvent(Event::prePersist, new LifecycleEventArgs($document, $this->dm));
$this->computeChangeSet($class, $document); // TODO: prevent association computations in this case?
}
$id = $this->documentIds[$oid];
$parentNode = $session->getNode(dirname($id) === '\\' ? '/' : dirname($id));
$node = $parentNode->addNode(basename($id), $class->nodeType);
try {
$node->addMixin('phpcr:managed');
} catch (\PHPCR\NodeType\NoSuchNodeTypeException $e) {
throw new PHPCRException("You need to register the node type phpcr:managed first. See https://github.com/doctrine/phpcr-odm/wiki/Custom-node-type-phpcr:managed");
}
if ($class->isVersioned) {
$node->addMixin("mix:versionable");
}
if ($class->referenceable) {
$node->addMixin("mix:referenceable");
// TODO make sure uuid is unique
$node->setProperty("jcr:uuid", \PHPCR\Util\UUIDHelper::generateUUID());
}
$this->nodesMap[$oid] = $node;
if ($class->identifier) {
$class->reflFields[$class->identifier]->setValue($document, $id);
}
if ($class->node) {
$class->reflFields[$class->node]->setValue($document, $node);
}
if ($useDoctrineMetadata) {
$node->setProperty('phpcr:class', $class->name, PropertyType::STRING);
}
foreach ($this->documentChangesets[$oid] as $fieldName => $fieldValue) {
if (isset($class->fieldMappings[$fieldName])) {
$type = \PHPCR\PropertyType::valueFromName($class->fieldMappings[$fieldName]['type']);
if ($class->fieldMappings[$fieldName]['multivalue']) {
$value = $fieldValue === null ? null : $fieldValue->toArray();
$node->setProperty($class->fieldMappings[$fieldName]['name'], $value, $type);
} else {
$node->setProperty($class->fieldMappings[$fieldName]['name'], $fieldValue, $type);
}
} elseif (isset($class->associationsMappings[$fieldName])) {
$this->scheduledUpdates[$oid] = $document;
}
}
}
foreach ($this->scheduledUpdates as $oid => $document) {
$class = $this->dm->getClassMetadata(get_class($document));
$node = $this->nodesMap[$oid];
if (isset($class->lifecycleCallbacks[Event::preUpdate])) {
$class->invokeLifecycleCallbacks(Event::preUpdate, $document);
$this->computeChangeSet($class, $document); // TODO: prevent association computations in this case?
}
if ($this->evm->hasListeners(Event::preUpdate)) {
$this->evm->dispatchEvent(Event::preUpdate, new LifecycleEventArgs($document, $this->dm));
$this->computeChangeSet($class, $document); // TODO: prevent association computations in this case?
}
if ($useDoctrineMetadata) {
$node->setProperty('phpcr:class', $class->name, PropertyType::STRING);
}
foreach ($this->documentChangesets[$oid] as $fieldName => $fieldValue) {
if (isset($class->fieldMappings[$fieldName])) {
$type = \PHPCR\PropertyType::valueFromName($class->fieldMappings[$fieldName]['type']);
if ($class->fieldMappings[$fieldName]['multivalue']) {
$value = $fieldValue === null ? null : $fieldValue->toArray();
$node->setProperty($class->fieldMappings[$fieldName]['name'], $value, $type);
} else {
$node->setProperty($class->fieldMappings[$fieldName]['name'], $fieldValue, $type);
}
} elseif (isset($class->associationsMappings[$fieldName]) && $useDoctrineMetadata) {
if ($node->hasProperty($class->associationsMappings[$fieldName]['fieldName']) && is_null($fieldValue)) {
$node->getProperty($class->associationsMappings[$fieldName]['fieldName'])->remove();
continue;
}
$type = $class->associationsMappings[$fieldName]['weak']
? \PHPCR\PropertyType::WEAKREFERENCE : \PHPCR\PropertyType::REFERENCE;
if ($class->associationsMappings[$fieldName]['type'] === $class::MANY_TO_MANY) {
if (isset($fieldValue)) {
$refNodesIds = array();
foreach ($fieldValue as $fv ) {
if ($fv === null) {
continue;
}
$refOid = spl_object_hash($fv);
$refNodesIds[] = $this->nodesMap[$refOid]->getIdentifier();
}
$node->setProperty($class->associationsMappings[$fieldName]['fieldName'], $refNodesIds, $type);
unset($refNodesIds);
}
} elseif ($class->associationsMappings[$fieldName]['type'] === $class::MANY_TO_ONE) {
if (isset($fieldValue)) {
$refOid = spl_object_hash($fieldValue);
$refNodeId = $this->nodesMap[$refOid]->getIdentifier();
$node->setProperty($class->associationsMappings[$fieldName]['fieldName'], $refNodeId, $type);
}
}
// child is set to null ... remove the node ...
} elseif (isset($class->childMappings[$fieldName])) {
// child is set to null ... remove the node ...
if ($fieldValue === null) {
if ($node->hasNode($class->childMappings[$fieldName]['name'])) {
$child = $node->getNode($class->childMappings[$fieldName]['name']);
$childDocument = $this->createDocument(null, $child);
$this->purgeChildren($childDocument);
$child->remove();
}
} elseif (is_null($this->originalData[$oid][$fieldName])) {
// TODO: store this new child
} elseif (isset($this->originalData[$oid][$fieldName])) {
//TODO: is this the correct test? if you put a different document as child and already had one, it means you moved stuff?
if ($fieldValue === $this->originalData[$oid][$fieldName]) {
//TODO: save
} else {
// this is currently not implemented
// the old child needs to be removed and the new child might be moved
throw new PHPCRException("You can not move or copy children by assignment as it would be ambiguous. Please use the PHPCR\Session::move() resp PHPCR\Session::copy() operations for this.");
}
}
}
}
}
if ($persist_to_backend) {
try {
$session->save();
if ($utx) {
$utx->commit();
}
} catch (\Exception $e) {
if ($utx) {
$utx->rollback();
}
}
}
$this->handlePostFlushEvents();
foreach ($this->visitedCollections as $col) {
$col->takeSnapshot();
}
$this->scheduledUpdates =
$this->scheduledRemovals =
$this->scheduledInserts =
$this->visitedCollections = array();
}
/**
* Invoke / dispatch events as necessary after a flush operation
*/
protected function handlePostFlushEvents()
{
foreach ($this->scheduledRemovals as $document) {
$class = $this->dm->getClassMetadata(get_class($document));
if (isset($class->lifecycleCallbacks[Event::postRemove])) {
$class->invokeLifecycleCallbacks(Event::postRemove, $document);
}
if ($this->evm->hasListeners(Event::postRemove)) {
$this->evm->dispatchEvent(Event::postRemove, new LifecycleEventArgs($document, $this->dm));
}
}
foreach ($this->scheduledInserts as $document) {
$class = $this->dm->getClassMetadata(get_class($document));
if (isset($class->lifecycleCallbacks[Event::postPersist])) {
$class->invokeLifecycleCallbacks(Event::postPersist, $document);
}
if ($this->evm->hasListeners(Event::postPersist)) {
$this->evm->dispatchEvent(Event::postPersist, new LifecycleEventArgs($document, $this->dm));
}
}
foreach ($this->scheduledUpdates as $document) {
$class = $this->dm->getClassMetadata(get_class($document));
if (isset($class->lifecycleCallbacks[Event::postUpdate])) {
$class->invokeLifecycleCallbacks(Event::postUpdate, $document);
}
if ($this->evm->hasListeners(Event::postUpdate)) {
$this->evm->dispatchEvent(Event::postUpdate, new LifecycleEventArgs($document, $this->dm));
}
}
}
/**
* Checkin operation - Save all current changes and then check in the Node by id.
*
* @return void
*/