-
-
Notifications
You must be signed in to change notification settings - Fork 504
/
ClassMetadata.php
2747 lines (2401 loc) · 81.8 KB
/
ClassMetadata.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
declare(strict_types=1);
namespace Doctrine\ODM\MongoDB\Mapping;
use BackedEnum;
use BadMethodCallException;
use DateTime;
use DateTimeImmutable;
use Doctrine\Common\Collections\Collection;
use Doctrine\Instantiator\Instantiator;
use Doctrine\Instantiator\InstantiatorInterface;
use Doctrine\ODM\MongoDB\Id\IdGenerator;
use Doctrine\ODM\MongoDB\LockException;
use Doctrine\ODM\MongoDB\Types\Incrementable;
use Doctrine\ODM\MongoDB\Types\Type;
use Doctrine\ODM\MongoDB\Types\Versionable;
use Doctrine\ODM\MongoDB\Utility\CollectionHelper;
use Doctrine\Persistence\Mapping\ClassMetadata as BaseClassMetadata;
use Doctrine\Persistence\Mapping\ReflectionService;
use Doctrine\Persistence\Mapping\RuntimeReflectionService;
use Doctrine\Persistence\Reflection\EnumReflectionProperty;
use InvalidArgumentException;
use LogicException;
use ProxyManager\Proxy\GhostObjectInterface;
use ReflectionClass;
use ReflectionEnum;
use ReflectionNamedType;
use ReflectionProperty;
use function array_filter;
use function array_key_exists;
use function array_keys;
use function array_map;
use function array_pop;
use function assert;
use function class_exists;
use function constant;
use function count;
use function enum_exists;
use function extension_loaded;
use function in_array;
use function interface_exists;
use function is_array;
use function is_string;
use function is_subclass_of;
use function ltrim;
use function sprintf;
use function strtolower;
use function strtoupper;
use function trigger_deprecation;
/**
* A <tt>ClassMetadata</tt> instance holds all the object-document mapping metadata
* of a document and it's references.
*
* Once populated, ClassMetadata instances are usually cached in a serialized form.
*
* <b>IMPORTANT NOTE:</b>
*
* The fields of this class are only public for 2 reasons:
* 1) To allow fast READ access.
* 2) To drastically reduce the size of a serialized instance (private/protected members
* get the whole class name, namespace inclusive, prepended to every property in
* the serialized representation).
*
* @psalm-type FieldMappingConfig = array{
* type?: string,
* fieldName?: string,
* name?: string,
* strategy?: string,
* association?: int,
* id?: bool,
* isOwningSide?: bool,
* collectionClass?: class-string,
* cascade?: list<string>|string,
* embedded?: bool,
* orphanRemoval?: bool,
* options?: array<string, mixed>,
* nullable?: bool,
* reference?: bool,
* storeAs?: string,
* targetDocument?: class-string|null,
* mappedBy?: string|null,
* inversedBy?: string|null,
* discriminatorField?: string,
* defaultDiscriminatorValue?: string,
* discriminatorMap?: array<string, class-string>,
* repositoryMethod?: string|null,
* sort?: array<string, string|int>,
* limit?: int|null,
* skip?: int|null,
* version?: bool,
* lock?: bool,
* inherited?: string,
* declared?: class-string,
* prime?: list<string>,
* sparse?: bool,
* unique?: bool,
* index?: bool,
* index-name?: string,
* criteria?: array<string, mixed>,
* alsoLoadFields?: list<string>,
* order?: int|string,
* background?: bool,
* enumType?: class-string<BackedEnum>,
* }
* @psalm-type FieldMapping = array{
* type: string,
* fieldName: string,
* name: string,
* isCascadeRemove: bool,
* isCascadePersist: bool,
* isCascadeRefresh: bool,
* isCascadeMerge: bool,
* isCascadeDetach: bool,
* isOwningSide: bool,
* isInverseSide: bool,
* strategy?: string,
* association?: int,
* id?: bool,
* collectionClass?: class-string,
* cascade?: list<string>|string,
* embedded?: bool,
* orphanRemoval?: bool,
* options?: array<string, mixed>,
* nullable?: bool,
* reference?: bool,
* storeAs?: string,
* targetDocument?: class-string|null,
* mappedBy?: string|null,
* inversedBy?: string|null,
* discriminatorField?: string,
* defaultDiscriminatorValue?: string,
* discriminatorMap?: array<string, class-string>,
* repositoryMethod?: string|null,
* sort?: array<string, string|int>,
* limit?: int|null,
* skip?: int|null,
* version?: bool,
* lock?: bool,
* notSaved?: bool,
* inherited?: string,
* declared?: class-string,
* prime?: list<string>,
* sparse?: bool,
* unique?: bool,
* index?: bool,
* criteria?: array<string, mixed>,
* alsoLoadFields?: list<string>,
* enumType?: class-string<BackedEnum>,
* storeEmptyArray?: bool,
* }
* @psalm-type AssociationFieldMapping = array{
* type?: string,
* fieldName: string,
* name: string,
* isCascadeRemove: bool,
* isCascadePersist: bool,
* isCascadeRefresh: bool,
* isCascadeMerge: bool,
* isCascadeDetach: bool,
* isOwningSide: bool,
* isInverseSide: bool,
* targetDocument: class-string|null,
* association: int,
* strategy?: string,
* id?: bool,
* collectionClass?: class-string,
* cascade?: list<string>|string,
* embedded?: bool,
* orphanRemoval?: bool,
* options?: array<string, mixed>,
* nullable?: bool,
* reference?: bool,
* storeAs?: string,
* mappedBy?: string|null,
* inversedBy?: string|null,
* discriminatorField?: string,
* defaultDiscriminatorValue?: string,
* discriminatorMap?: array<string, class-string>,
* repositoryMethod?: string|null,
* sort?: array<string, string|int>,
* limit?: int|null,
* skip?: int|null,
* version?: bool,
* lock?: bool,
* notSaved?: bool,
* inherited?: string,
* declared?: class-string,
* prime?: list<string>,
* sparse?: bool,
* unique?: bool,
* index?: bool,
* criteria?: array<string, mixed>,
* alsoLoadFields?: list<string>,
* storeEmptyArray?: bool,
* }
* @psalm-type IndexKeys = array<string, mixed>
* @psalm-type IndexOptions = array{
* background?: bool,
* bits?: int,
* default_language?: string,
* expireAfterSeconds?: int,
* language_override?: string,
* min?: float,
* max?: float,
* name?: string,
* partialFilterExpression?: mixed[],
* sparse?: bool,
* storageEngine?: mixed[],
* textIndexVersion?: int,
* unique?: bool,
* weights?: array{string, int},
* }
* @psalm-type IndexMapping = array{
* keys: IndexKeys,
* options: IndexOptions
* }
* @psalm-type SearchIndexStoredSourceInclude = array{include: list<string>}
* @psalm-type SearchIndexStoredSourceExclude = array{exclude: list<string>}
* @psalm-type SearchIndexStoredSource = bool|SearchIndexStoredSourceInclude|SearchIndexStoredSourceExclude
* @psalm-type SearchIndexSynonym = array{
* analyzer: string,
* name: string,
* source: array{
* collection: string,
* },
* }
* @psalm-type SearchIndexDefinition = array{
* mappings: array{
* dynamic?: bool,
* fields?: array,
* },
* analyzer?: string,
* searchAnalyzer?: string,
* analyzers?: array,
* storedSource?: SearchIndexStoredSource,
* synonyms?: list<SearchIndexSynonym>,
* }
* @psalm-type SearchIndexMapping = array{
* name: string,
* definition: SearchIndexDefinition
* }
* @psalm-type ShardKeys = array<string, mixed>
* @psalm-type ShardOptions = array<string, mixed>
* @psalm-type ShardKey = array{
* keys?: ShardKeys,
* options?: ShardOptions
* }
* @final
* @template-covariant T of object
* @template-implements BaseClassMetadata<T>
*/
/* final */ class ClassMetadata implements BaseClassMetadata
{
/* The Id generator types. */
/**
* AUTO means Doctrine will automatically create a new \MongoDB\BSON\ObjectId instance for us.
*/
public const GENERATOR_TYPE_AUTO = 1;
/**
* INCREMENT means a separate collection is used for maintaining and incrementing id generation.
* Offers full portability.
*/
public const GENERATOR_TYPE_INCREMENT = 2;
/**
* UUID means Doctrine will generate a uuid for us.
*/
public const GENERATOR_TYPE_UUID = 3;
/**
* ALNUM means Doctrine will generate Alpha-numeric string identifiers, using the INCREMENT
* generator to ensure identifier uniqueness
*/
public const GENERATOR_TYPE_ALNUM = 4;
/**
* CUSTOM means Doctrine expect a class parameter. It will then try to initiate that class
* and pass other options to the generator. It will throw an Exception if the class
* does not exist or if an option was passed for that there is not setter in the new
* generator class.
*
* The class will have to implement IdGenerator.
*/
public const GENERATOR_TYPE_CUSTOM = 5;
/**
* NONE means Doctrine will not generate any id for us and you are responsible for manually
* assigning an id.
*/
public const GENERATOR_TYPE_NONE = 6;
/**
* Default discriminator field name.
*
* This is used for associations value for associations where a that do not define a "targetDocument" or
* "discriminatorField" option in their mapping.
*/
public const DEFAULT_DISCRIMINATOR_FIELD = '_doctrine_class_name';
/**
* Association types
*/
public const REFERENCE_ONE = 1;
public const REFERENCE_MANY = 2;
public const EMBED_ONE = 3;
public const EMBED_MANY = 4;
/**
* Mapping types
*/
public const MANY = 'many';
public const ONE = 'one';
/**
* The types of storeAs references
*/
public const REFERENCE_STORE_AS_ID = 'id';
public const REFERENCE_STORE_AS_DB_REF = 'dbRef';
public const REFERENCE_STORE_AS_DB_REF_WITH_DB = 'dbRefWithDb';
public const REFERENCE_STORE_AS_REF = 'ref';
/**
* The collection schema validationAction values
*
* @see https://docs.mongodb.com/manual/core/schema-validation/#accept-or-reject-invalid-documents
*/
public const SCHEMA_VALIDATION_ACTION_ERROR = 'error';
public const SCHEMA_VALIDATION_ACTION_WARN = 'warn';
/**
* The collection schema validationLevel values
*
* @see https://docs.mongodb.com/manual/core/schema-validation/#existing-documents
*/
public const SCHEMA_VALIDATION_LEVEL_OFF = 'off';
public const SCHEMA_VALIDATION_LEVEL_STRICT = 'strict';
public const SCHEMA_VALIDATION_LEVEL_MODERATE = 'moderate';
/* The inheritance mapping types */
/**
* NONE means the class does not participate in an inheritance hierarchy
* and therefore does not need an inheritance mapping type.
*/
public const INHERITANCE_TYPE_NONE = 1;
/**
* SINGLE_COLLECTION means the class will be persisted according to the rules of
* <tt>Single Collection Inheritance</tt>.
*/
public const INHERITANCE_TYPE_SINGLE_COLLECTION = 2;
/**
* COLLECTION_PER_CLASS means the class will be persisted according to the rules
* of <tt>Concrete Collection Inheritance</tt>.
*/
public const INHERITANCE_TYPE_COLLECTION_PER_CLASS = 3;
/**
* DEFERRED_IMPLICIT means that changes of entities are calculated at commit-time
* by doing a property-by-property comparison with the original data. This will
* be done for all entities that are in MANAGED state at commit-time.
*
* This is the default change tracking policy.
*/
public const CHANGETRACKING_DEFERRED_IMPLICIT = 1;
/**
* DEFERRED_EXPLICIT means that changes of entities are calculated at commit-time
* by doing a property-by-property comparison with the original data. This will
* be done only for entities that were explicitly saved (through persist() or a cascade).
*/
public const CHANGETRACKING_DEFERRED_EXPLICIT = 2;
/**
* NOTIFY means that Doctrine relies on the entities sending out notifications
* when their properties change. Such entity classes must implement
* the <tt>NotifyPropertyChanged</tt> interface.
*
* @deprecated
*/
public const CHANGETRACKING_NOTIFY = 3;
/**
* SET means that fields will be written to the database using a $set operator
*/
public const STORAGE_STRATEGY_SET = 'set';
/**
* INCREMENT means that fields will be written to the database by calculating
* the difference and using the $inc operator
*/
public const STORAGE_STRATEGY_INCREMENT = 'increment';
public const STORAGE_STRATEGY_PUSH_ALL = 'pushAll';
public const STORAGE_STRATEGY_ADD_TO_SET = 'addToSet';
public const STORAGE_STRATEGY_ATOMIC_SET = 'atomicSet';
public const STORAGE_STRATEGY_ATOMIC_SET_ARRAY = 'atomicSetArray';
public const STORAGE_STRATEGY_SET_ARRAY = 'setArray';
/**
* Default search index name.
*
* @see https://www.mongodb.com/docs/manual/reference/command/createSearchIndexes/
*/
public const DEFAULT_SEARCH_INDEX_NAME = 'default';
private const ALLOWED_GRIDFS_FIELDS = ['_id', 'chunkSize', 'filename', 'length', 'metadata', 'uploadDate'];
/**
* READ-ONLY: The name of the mongo database the document is mapped to.
*
* @var string|null
*/
public $db;
/**
* READ-ONLY: The name of the mongo collection the document is mapped to.
*
* @var string
*/
public $collection;
/**
* READ-ONLY: The name of the GridFS bucket the document is mapped to.
*
* @var string
*/
public $bucketName = 'fs';
/**
* READ-ONLY: If the collection should be a fixed size.
*
* @var bool
*/
public $collectionCapped = false;
/**
* READ-ONLY: If the collection is fixed size, its size in bytes.
*
* @var int|null
*/
public $collectionSize;
/**
* READ-ONLY: If the collection is fixed size, the maximum number of elements to store in the collection.
*
* @var int|null
*/
public $collectionMax;
/**
* READ-ONLY Describes how MongoDB clients route read operations to the members of a replica set.
*
* @var string|null
*/
public $readPreference;
/**
* READ-ONLY Associated with readPreference Allows to specify criteria so that your application can target read
* operations to specific members, based on custom parameters.
*
* @var array<array<string, string>>
*/
public $readPreferenceTags = [];
/**
* READ-ONLY: Describes the level of acknowledgement requested from MongoDB for write operations.
*
* @var string|int|null
*/
public $writeConcern;
/**
* READ-ONLY: The field name of the document identifier.
*
* @var string|null
*/
public $identifier;
/**
* READ-ONLY: The array of indexes for the document collection.
*
* @var array<array<string, mixed>>
* @psalm-var array<IndexMapping>
*/
public $indexes = [];
/**
* READ-ONLY: The array of search indexes for the document collection.
*
* @var list<SearchIndexMapping>
*/
public $searchIndexes = [];
/**
* READ-ONLY: Keys and options describing shard key. Only for sharded collections.
*
* @var array<string, array>
* @psalm-var ShardKey
*/
public $shardKey = [];
/**
* Allows users to specify a validation schema for the collection.
*
* @var array|object|null
* @psalm-var array<string, mixed>|object|null
*/
private $validator;
/**
* Determines whether to error on invalid documents or just warn about the violations but allow invalid documents to be inserted.
*
* @var string
*/
private $validationAction = self::SCHEMA_VALIDATION_ACTION_ERROR;
/**
* Determines how strictly MongoDB applies the validation rules to existing documents during an update.
*/
private string $validationLevel = self::SCHEMA_VALIDATION_LEVEL_STRICT;
/**
* READ-ONLY: The name of the document class.
*
* @var string
* @psalm-var class-string<T>
*/
public $name;
/**
* READ-ONLY: The name of the document class that is at the root of the mapped document inheritance
* hierarchy. If the document is not part of a mapped inheritance hierarchy this is the same
* as {@link $documentName}.
*
* @var string
* @psalm-var class-string
*/
public $rootDocumentName;
/**
* The name of the custom repository class used for the document class.
* (Optional).
*
* @var string|null
* @psalm-var class-string|null
*/
public $customRepositoryClassName;
/**
* READ-ONLY: The names of the parent classes (ancestors).
*
* @var array
* @psalm-var list<class-string>
*/
public $parentClasses = [];
/**
* READ-ONLY: The names of all subclasses (descendants).
*
* @var array
* @psalm-var list<class-string>
*/
public $subClasses = [];
/**
* The ReflectionProperty instances of the mapped class.
*
* @var ReflectionProperty[]
*/
public $reflFields = [];
/**
* READ-ONLY: The inheritance mapping type used by the class.
*
* @var int
*/
public $inheritanceType = self::INHERITANCE_TYPE_NONE;
/**
* READ-ONLY: The Id generator type used by the class.
*
* @var int
*/
public $generatorType = self::GENERATOR_TYPE_AUTO;
/**
* READ-ONLY: The Id generator options.
*
* @var array<string, mixed>
*/
public $generatorOptions = [];
/**
* READ-ONLY: The ID generator used for generating IDs for this class.
*
* @var IdGenerator|null
*/
public $idGenerator;
/**
* READ-ONLY: The field mappings of the class.
* Keys are field names and values are mapping definitions.
*
* The mapping definition array has the following values:
*
* - <b>fieldName</b> (string)
* The name of the field in the Document.
*
* - <b>id</b> (boolean, optional)
* Marks the field as the primary key of the document. Multiple fields of an
* document can have the id attribute, forming a composite key.
*
* @var array<string, mixed>
* @psalm-var array<string, FieldMapping>
*/
public $fieldMappings = [];
/**
* READ-ONLY: The association mappings of the class.
* Keys are field names and values are mapping definitions.
*
* @var array<string, mixed>
* @psalm-var array<string, AssociationFieldMapping>
*/
public $associationMappings = [];
/**
* READ-ONLY: Array of fields to also load with a given method.
*
* @var array<string, mixed[]>
*/
public $alsoLoadMethods = [];
/**
* READ-ONLY: The registered lifecycle callbacks for documents of this class.
*
* @var array<string, list<string>>
*/
public $lifecycleCallbacks = [];
/**
* READ-ONLY: The discriminator value of this class.
*
* <b>This does only apply to the JOINED and SINGLE_COLLECTION inheritance mapping strategies
* where a discriminator field is used.</b>
*
* @see discriminatorField
*
* @var string|null
* @psalm-var class-string|null
*/
public $discriminatorValue;
/**
* READ-ONLY: The discriminator map of all mapped classes in the hierarchy.
*
* <b>This does only apply to the SINGLE_COLLECTION inheritance mapping strategy
* where a discriminator field is used.</b>
*
* @see discriminatorField
*
* @psalm-var array<string, class-string>
*/
public $discriminatorMap = [];
/**
* READ-ONLY: The definition of the discriminator field used in SINGLE_COLLECTION
* inheritance mapping.
*
* @var string|null
*/
public $discriminatorField;
/**
* READ-ONLY: The default value for discriminatorField in case it's not set in the document
*
* @see discriminatorField
*
* @var string|null
*/
public $defaultDiscriminatorValue;
/**
* READ-ONLY: Whether this class describes the mapping of a mapped superclass.
*
* @var bool
*/
public $isMappedSuperclass = false;
/**
* READ-ONLY: Whether this class describes the mapping of a embedded document.
*
* @var bool
*/
public $isEmbeddedDocument = false;
/**
* READ-ONLY: Whether this class describes the mapping of an aggregation result document.
*
* @var bool
*/
public $isQueryResultDocument = false;
/**
* READ-ONLY: Whether this class describes the mapping of a database view.
*/
private bool $isView = false;
/**
* READ-ONLY: Whether this class describes the mapping of a gridFS file
*
* @var bool
*/
public $isFile = false;
/**
* READ-ONLY: The default chunk size in bytes for the file
*
* @var int|null
*/
public $chunkSizeBytes;
/**
* READ-ONLY: The policy used for change-tracking on entities of this class.
*
* @var int
*/
public $changeTrackingPolicy = self::CHANGETRACKING_DEFERRED_IMPLICIT;
/**
* READ-ONLY: A flag for whether or not instances of this class are to be versioned
* with optimistic locking.
*
* @var bool $isVersioned
*/
public $isVersioned = false;
/**
* READ-ONLY: The name of the field which is used for versioning in optimistic locking (if any).
*
* @var string|null $versionField
*/
public $versionField;
/**
* READ-ONLY: A flag for whether or not instances of this class are to allow pessimistic
* locking.
*
* @var bool $isLockable
*/
public $isLockable = false;
/**
* READ-ONLY: The name of the field which is used for locking a document.
*
* @var mixed $lockField
*/
public $lockField;
/**
* The ReflectionClass instance of the mapped class.
*
* @var ReflectionClass
* @psalm-var ReflectionClass<T>
*/
public $reflClass;
/**
* READ_ONLY: A flag for whether or not this document is read-only.
*
* @var bool
*/
public $isReadOnly;
private InstantiatorInterface $instantiator;
private ReflectionService $reflectionService;
/**
* @var string|null
* @psalm-var class-string|null
*/
private $rootClass;
/**
* Initializes a new ClassMetadata instance that will hold the object-document mapping
* metadata of the class with the given name.
*
* @psalm-param class-string<T> $documentName
*/
public function __construct(string $documentName)
{
$this->name = $documentName;
$this->rootDocumentName = $documentName;
$this->reflectionService = new RuntimeReflectionService();
$this->reflClass = new ReflectionClass($documentName);
$this->setCollection($this->reflClass->getShortName());
$this->instantiator = new Instantiator();
}
/**
* Helper method to get reference id of ref* type references
*
* @internal
*
* @param mixed $reference
*
* @return mixed
*/
public static function getReferenceId($reference, string $storeAs)
{
return $storeAs === self::REFERENCE_STORE_AS_ID ? $reference : $reference[self::getReferencePrefix($storeAs) . 'id'];
}
/**
* Returns the reference prefix used for a reference
*/
private static function getReferencePrefix(string $storeAs): string
{
if (! in_array($storeAs, [self::REFERENCE_STORE_AS_REF, self::REFERENCE_STORE_AS_DB_REF, self::REFERENCE_STORE_AS_DB_REF_WITH_DB])) {
throw new LogicException('Can only get a reference prefix for DBRef and reference arrays');
}
return $storeAs === self::REFERENCE_STORE_AS_REF ? '' : '$';
}
/**
* Returns a fully qualified field name for a given reference
*
* @internal
*
* @param string $pathPrefix The field path prefix
*/
public static function getReferenceFieldName(string $storeAs, string $pathPrefix = ''): string
{
if ($storeAs === self::REFERENCE_STORE_AS_ID) {
return $pathPrefix;
}
return ($pathPrefix ? $pathPrefix . '.' : '') . static::getReferencePrefix($storeAs) . 'id';
}
public function getReflectionClass(): ReflectionClass
{
return $this->reflClass;
}
/** @param string $fieldName */
public function isIdentifier($fieldName): bool
{
return $this->identifier === $fieldName;
}
/**
* Sets the mapped identifier field of this class.
*
* @internal
*/
public function setIdentifier(?string $identifier): void
{
$this->identifier = $identifier;
}
/**
* Since MongoDB only allows exactly one identifier field
* this will always return an array with only one value
*
* @return array<string|null>
*/
public function getIdentifier(): array
{
return [$this->identifier];
}
/**
* Since MongoDB only allows exactly one identifier field
* this will always return an array with only one value
*
* @return array<string|null>
*/
public function getIdentifierFieldNames(): array
{
return [$this->identifier];
}
/** @param string $fieldName */
public function hasField($fieldName): bool
{
return isset($this->fieldMappings[$fieldName]);
}
/**
* Sets the inheritance type used by the class and it's subclasses.
*/
public function setInheritanceType(int $type): void
{
$this->inheritanceType = $type;
}
/**
* Checks whether a mapped field is inherited from an entity superclass.
*/
public function isInheritedField(string $fieldName): bool
{
return isset($this->fieldMappings[$fieldName]['inherited']);
}
/**
* Registers a custom repository class for the document class.
*
* @psalm-param class-string|null $repositoryClassName
*/
public function setCustomRepositoryClass(?string $repositoryClassName): void
{
if ($this->isEmbeddedDocument || $this->isQueryResultDocument) {
return;
}
$this->customRepositoryClassName = $repositoryClassName;
}
/**
* Dispatches the lifecycle event of the given document by invoking all
* registered callbacks.
*
* @param mixed[]|null $arguments
*
* @throws InvalidArgumentException If document class is not this class or
* a Proxy of this class.
*/
public function invokeLifecycleCallbacks(string $event, object $document, ?array $arguments = null): void
{
if ($this->isView()) {
return;
}
if (! $document instanceof $this->name) {
throw new InvalidArgumentException(sprintf('Expected document class "%s"; found: "%s"', $this->name, $document::class));
}
if (empty($this->lifecycleCallbacks[$event])) {
return;
}
foreach ($this->lifecycleCallbacks[$event] as $callback) {
if ($arguments !== null) {
$document->$callback(...$arguments);
} else {
$document->$callback();
}
}
}
/**
* Checks whether the class has callbacks registered for a lifecycle event.
*/
public function hasLifecycleCallbacks(string $event): bool
{
return ! empty($this->lifecycleCallbacks[$event]);
}
/**
* Gets the registered lifecycle callbacks for an event.
*
* @return list<string>
*/
public function getLifecycleCallbacks(string $event): array
{
return $this->lifecycleCallbacks[$event] ?? [];
}
/**
* Adds a lifecycle callback for documents of this class.
*
* If the callback is already registered, this is a NOOP.
*/
public function addLifecycleCallback(string $callback, string $event): void
{
if (isset($this->lifecycleCallbacks[$event]) && in_array($callback, $this->lifecycleCallbacks[$event])) {
return;
}
$this->lifecycleCallbacks[$event][] = $callback;
}
/**
* Sets the lifecycle callbacks for documents of this class.
*
* Any previously registered callbacks are overwritten.
*
* @param array<string, list<string>> $callbacks
*/
public function setLifecycleCallbacks(array $callbacks): void
{