ClassMetadata

Initializes a new ClassMetadata instance that will hold the object-document mapping metadata of the class with the given name.

Helper method to get reference id of ref* type references

Returns a fully qualified field name for a given reference

{@inheritDoc}

{@inheritDoc}

Sets the mapped identifier field of this class.

{@inheritDoc}

Since MongoDB only allows exactly one identifier field this will always return an array with only one value

Since MongoDB only allows exactly one identifier field this will always return an array with only one value

return (string|null)[]

{@inheritDoc}

Sets the inheritance type used by the class and it's subclasses.

Checks whether a mapped field is inherited from an entity superclass.

Registers a custom repository class for the document class.

Dispatches the lifecycle event of the given document by invoking all registered callbacks.

Checks whether the class has callbacks registered for a lifecycle event.

Gets the registered lifecycle callbacks for an event.

Adds a lifecycle callback for documents of this class.

If the callback is already registered, this is a NOOP.

Sets the lifecycle callbacks for documents of this class.

Any previously registered callbacks are overwritten.

Registers a method for loading document data before field hydration.

Note: A method may be registered multiple times for different fields. it will be invoked only once for the first field found.

Sets the AlsoLoad methods for documents of this class.

Any previously registered methods are overwritten.

Sets the discriminator field.

The field name is the the unmapped database field. Discriminator values are only used to discern the hydration class and are not mapped to class properties.

Sets the discriminator values used by this class.

Used for JOINED and SINGLE_TABLE inheritance mapping strategies.

Sets the default discriminator value to be used for this class Used for SINGLE_TABLE inheritance mapping strategies if the document has no discriminator value

Sets the discriminator value for this class.

Used for JOINED/SINGLE_TABLE inheritance and multiple document types in a single collection.

Add a index for this Document.

Returns the array of indexes for this Document.

Checks whether this document has indexes or not.

Set shard key for this Document.

Checks whether this document has shard key or not.

Sets the read preference used by this class.

Sets the write concern used by this class.

Whether there is a write concern configured for this class.

Sets the change tracking policy used by this class.

Whether the change tracking policy of this class is "deferred explicit".

Whether the change tracking policy of this class is "deferred implicit".

Whether the change tracking policy of this class is "notify".

Gets the ReflectionProperties of the mapped class.

Gets a ReflectionProperty for a specific field of the mapped class.

{@inheritDoc}

Returns the database this Document is mapped to.

Set the database this Document is mapped to.

Get the collection this Document is mapped to.

Sets the collection this Document is mapped to.

Get whether or not the documents collection is capped.

Set whether or not the documents collection is capped.

Get the collection size

Set the collection size.

Get the collection max.

Set the collection max.

Returns TRUE if this Document is mapped to a collection FALSE otherwise.

Map a single embedded document.

Map a collection of embedded documents.

Map a single document reference.

Map a collection of document references.

Adds a field mapping without completing/validating it.

This is mainly used to add inherited field mappings to derived classes.

Adds an association mapping without completing/validating it.

This is mainly used to add inherited association mappings to derived classes.

Checks whether the class has a mapped association with the given field name.

Checks whether the class has a mapped embed with the given field name.

{@inheritDoc}

Checks whether the class has a mapped association (embed or reference) with the given field name.

{@inheritDoc}

Checks whether the class has a mapped reference or embed for the specified field and is a single valued association.

{@inheritDoc}

Checks whether the class has a mapped reference or embed for the specified field and is a collection valued association.

Checks whether the class has a mapped association for the specified field and if yes, checks whether it is a single-valued association (to-one).

Checks whether the class has a mapped association for the specified field and if yes, checks whether it is a collection-valued association (to-many).

Checks whether the class has a mapped embedded document for the specified field and if yes, checks whether it is a single-valued association (to-one).

Checks whether the class has a mapped embedded document for the specified field and if yes, checks whether it is a collection-valued association (to-many).

Sets the ID generator used to generate IDs for instances of this class.

Casts the identifier to its portable PHP type.

Casts the identifier to its database type.

Sets the document identifier of a document.

The value will be converted to a PHP type before being set.

Gets the document identifier as a PHP type.

{@inheritDoc}

Since MongoDB only allows exactly one identifier field this is a proxy to {see getIdentifierValue()} and returns an array with the identifier field as a key.

Get the document identifier object as a database type.

Sets the specified field to the specified value on the given document.

Gets the specified field's value off the given document.

Gets the mapping of a field.

Gets mappings of fields holding embedded document(s).

Gets the field mapping by its DB name.

E.g. it returns identifier's mapping when called with _id.

Check if the field is not null.

Checks whether the document has a discriminator field and value configured.

Sets the type of Id generator to use for the mapped class.

Sets the Id generator options.

Checks whether the mapped class uses the SINGLE_COLLECTION inheritance mapping strategy.

Checks whether the mapped class uses the COLLECTION_PER_CLASS inheritance mapping strategy.

Sets the mapped subclasses of this class.

Sets the parent class names.

Assumes that the class names in the passed array are in the order: directParent -> directParentParent -> directParentParentParent ... -> root.

Checks whether the class will generate a new \MongoDB\BSON\ObjectId instance for us.

Checks whether the class will use a collection to generate incremented identifiers.

Checks whether the class will generate a uuid id.

Checks whether the class uses no id generator.

Sets the version field mapping used for versioning. Sets the default value to use depending on the column type.

Sets whether this class is to be versioned for optimistic locking.

Sets the name of the field that is to be used for versioning if this class is versioned for optimistic locking.

Sets the version field mapping used for versioning. Sets the default value to use depending on the column type.

Sets whether this class is to allow pessimistic locking.

Sets the name of the field that is to be used for storing whether a document is currently locked or not.

Marks this class as read only, no change tracking is applied to it.

{@inheritDoc}

{@inheritDoc}

{@inheritDoc}

{@inheritDoc}

Retrieve the collectionClass associated with an association

{@inheritDoc}

{@inheritDoc}

Map a field.

Determines which fields get serialized.

It is only serialized what is necessary for best unserialization performance. That means any metadata properties that are not set or empty or simply have their default value are NOT serialized.

Parts that are also NOT serialized because they can not be properly unserialized: - reflClass (ReflectionClass) - reflFields (ReflectionProperty array)

Restores some state that can not be serialized/unserialized.

Creates a new instance of the mapped class, without invoking the constructor.