• Home
• Doctrine
• ODM
• MongoDB
• Mapping
• ClassMetadataInfo

PHP Class Doctrine\ODM\MongoDB\Mapping\ClassMetadataInfo

Once populated, ClassMetadata instances are usually cached in a serialized form. IMPORTANT NOTE: 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). Show file Open project: doctrine/mongodb-odm Class Usage Examples

Public Properties

Property	Type	Description
$alsoLoadMethods	array	READ-ONLY: Array of fields to also load with a given method.
$associationMappings	array	Keys are field names and values are mapping definitions.
$changeTrackingPolicy	integer	READ-ONLY: The policy used for change-tracking on entities of this class.
$collection		READ-ONLY: The name of the mongo collection the document is mapped to.
$collectionCapped		READ-ONLY: If the collection should be a fixed size.
$collectionMax		READ-ONLY: If the collection is fixed size, the maximum number of elements to store in the collection.
$collectionSize		READ-ONLY: If the collection is fixed size, its size in bytes.
$customRepositoryClassName	string	(Optional).
$db		READ-ONLY: The name of the mongo database the document is mapped to.
$defaultDiscriminatorValue	string	READ-ONLY: The default value for discriminatorField in case it's not set in the document
$discriminatorField	string	READ-ONLY: The definition of the discriminator field used in SINGLE_COLLECTION inheritance mapping.
$discriminatorMap	mixed	This does only apply to the SINGLE_COLLECTION inheritance mapping strategy where a discriminator field is used.
$discriminatorValue	mixed	This does only apply to the JOINED and SINGLE_COLLECTION inheritance mapping strategies where a discriminator field is used.
$distance		READ-ONLY: The field that stores the calculated distance when performing geo spatial queries.
$fieldMappings	array	Keys are field names and values are mapping definitions. The mapping definition array has the following values: - fieldName (string) The name of the field in the Document. - id (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.
$file		READ-ONLY: The field that stores a file reference and indicates the document is a file and should be stored on the MongoGridFS.
$generatorOptions	array	READ-ONLY: The Id generator options.
$generatorType	string	READ-ONLY: The Id generator type used by the class.
$idGenerator	Doctrine\ODM\MongoDB\Id\AbstractIdGenerator	READ-ONLY: The ID generator used for generating IDs for this class.
$identifier		READ-ONLY: The field name of the document identifier.
$indexes		READ-ONLY: The array of indexes for the document collection.
$inheritanceType	integer	READ-ONLY: The inheritance mapping type used by the class.
$isEmbeddedDocument	boolean	READ-ONLY: Whether this class describes the mapping of a embedded document.
$isLockable	boolean	READ-ONLY: A flag for whether or not instances of this class are to allow pessimistic locking.
$isMappedSuperclass	boolean	READ-ONLY: Whether this class describes the mapping of a mapped superclass.
$isQueryResultDocument	boolean	READ-ONLY: Whether this class describes the mapping of an aggregation result document.
$isVersioned	boolean	READ-ONLY: A flag for whether or not instances of this class are to be versioned with optimistic locking.
$lifecycleCallbacks	array	READ-ONLY: The registered lifecycle callbacks for documents of this class.
$lockField	mixed	READ-ONLY: The name of the field which is used for locking a document.
$name		READ-ONLY: The name of the document class.
$namespace	string	READ-ONLY: The namespace the document class is contained in.
$parentClasses	array	READ-ONLY: The names of the parent classes (ancestors).
$reflClass	ReflectionClass	The ReflectionClass instance of the mapped class.
$reflFields	ReflectionProperty[]	The ReflectionProperty instances of the mapped class.
$requireIndexes		READ-ONLY: Whether or not queries on this document should require indexes.
$rootDocumentName	string	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}.
$shardKey		READ-ONLY: Keys and options describing shard key. Only for sharded collections.
$slaveOkay		READ-ONLY: Whether or not reads for this class are okay to read from a slave.
$subClasses	array	READ-ONLY: The names of all subclasses (descendants).
$versionField	mixed	READ-ONLY: The name of the field which is used for versioning in optimistic locking (if any).
$writeConcern		READ-ONLY: Describes the level of acknowledgement requested from MongoDB for write operations.

Public Methods

Method	Description
__construct ( string $documentName )	Initializes a new ClassMetadata instance that will hold the object-document mapping metadata of the class with the given name.
addIndex ( array $keys, array $options = [] )	Add a index for this Document.
addInheritedAssociationMapping ( array $mapping ) : void	INTERNAL: Adds an association mapping without completing/validating it.
addInheritedFieldMapping ( array $fieldMapping )	INTERNAL: Adds a field mapping without completing/validating it.
addLifecycleCallback ( string $callback, string $event )	Adds a lifecycle callback for documents of this class.
getAssociationCollectionClass ( string $assocName )	Retrieve the collectionClass associated with an association
getAssociationMappedByTargetField ( $fieldName )	{@inheritDoc}
getAssociationNames ( )	{@inheritDoc}
getAssociationTargetClass ( $assocName )	{@inheritDoc}
getCollection ( ) : string	Get the collection this Document is mapped to.
getCollectionCapped ( ) : boolean	Get whether or not the documents collection is capped.
getCollectionMax ( ) : integer	Get the collection max.
getCollectionSize ( ) : integer	Get the collection size
getDatabase ( ) : string	Returns the database this Document is mapped to.
getDatabaseIdentifierValue ( mixed $id ) : mixed	Casts the identifier to its database type.
getDistance ( ) : string	Returns the distance field name.
getEmbeddedFieldsMappings ( ) : array	Gets mappings of fields holding embedded document(s).
getFieldMapping ( string $fieldName ) : array	Gets the mapping of a field.
getFieldMappingByDbFieldName ( string $dbFieldName ) : array	Gets the field mapping by its DB name.
getFieldNames ( )	{@inheritDoc}
getFieldValue ( object $document, string $field ) : mixed	Gets the specified field's value off the given document.
getFile ( ) : string	Returns the file field name.
getIdentifier ( )	{@inheritDoc}
getIdentifierFieldNames ( )	{@inheritDoc}
getIdentifierObject ( object $document ) : MongoId	Get the document identifier object as a database type.
getIdentifierValue ( object $document ) : mixed	Gets the document identifier as a PHP type.
getIdentifierValues ( $object )	{@inheritDoc}
getIndexes ( ) : array	Returns the array of indexes for this Document.
getLifecycleCallbacks ( string $event ) : array	Gets the registered lifecycle callbacks for an event.
getName ( )	{@inheritDoc}
getNamespace ( ) : string	The namespace this Document class belongs to.
getPHPIdentifierValue ( mixed $id ) : mixed	Casts the identifier to its portable PHP type.
getReflectionClass ( )	{@inheritDoc}
getReflectionProperties ( ) : array	Gets the ReflectionProperties of the mapped class.
getReflectionProperty ( string $name ) : ReflectionProperty	Gets a ReflectionProperty for a specific field of the mapped class.
getShardKey ( ) : array
getTypeOfField ( $fieldName )	{@inheritDoc}
getWriteConcern ( ) : string
hasAssociation ( $fieldName )	{@inheritDoc}
hasDiscriminator ( ) : boolean	Checks whether the document has a discriminator field and value configured.
hasEmbed ( string $fieldName ) : boolean	Checks whether the class has a mapped embed with the given field name.
hasField ( $fieldName )	{@inheritDoc}
hasIndexes ( ) : boolean	Checks whether this document has indexes or not.
hasLifecycleCallbacks ( string $event ) : boolean	Checks whether the class has callbacks registered for a lifecycle event.
hasReference ( string $fieldName ) : boolean	Checks whether the class has a mapped association with the given field name.
hasWriteConcern ( ) : boolean	Whether there is a write concern configured for this class.
invokeLifecycleCallbacks ( string $event, object $document, array $arguments = null )	Dispatches the lifecycle event of the given document by invoking all registered callbacks.
isAssociationInverseSide ( $fieldName )	{@inheritDoc}
isChangeTrackingDeferredExplicit ( ) : boolean	Whether the change tracking policy of this class is "deferred explicit".
isChangeTrackingDeferredImplicit ( ) : boolean	Whether the change tracking policy of this class is "deferred implicit".
isChangeTrackingNotify ( ) : boolean	Whether the change tracking policy of this class is "notify".
isCollectionValuedAssociation ( $fieldName )	{@inheritDoc}
isCollectionValuedEmbed ( string $fieldName ) : boolean	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).
isCollectionValuedReference ( string $fieldName ) : boolean	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).
isFile ( ) : boolean	Returns TRUE if this Document is a file to be stored on the MongoGridFS FALSE otherwise.
isIdGeneratorAuto ( ) : boolean	Checks whether the class will generate a new \MongoId instance for us.
isIdGeneratorIncrement ( ) : boolean	Checks whether the class will use a collection to generate incremented identifiers.
isIdGeneratorNone ( ) : boolean	Checks whether the class uses no id generator.
isIdGeneratorUuid ( ) : boolean	Checks whether the class will generate a uuid id.
isIdentifier ( $fieldName )	{@inheritDoc}
isInheritanceTypeCollectionPerClass ( ) : boolean	Checks whether the mapped class uses the COLLECTION_PER_CLASS inheritance mapping strategy.
isInheritanceTypeNone ( ) : boolean
isInheritanceTypeSingleCollection ( ) : boolean	Checks whether the mapped class uses the SINGLE_COLLECTION inheritance mapping strategy.
isInheritedField ( string $fieldName ) : boolean	Checks whether a mapped field is inherited from an entity superclass.
isMappedToCollection ( ) : boolean	Returns TRUE if this Document is mapped to a collection FALSE otherwise.
isNullable ( string $fieldName ) : boolean	Check if the field is not null.
isSharded ( ) : boolean	Checks whether this document has shard key or not.
isSingleValuedAssociation ( $fieldName )	{@inheritDoc}
isSingleValuedEmbed ( string $fieldName ) : boolean	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).
isSingleValuedReference ( string $fieldName ) : boolean	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).
mapField ( array $mapping ) : array	Map a field.
mapFile ( array $mapping )	Map a MongoGridFSFile.
mapManyEmbedded ( array $mapping )	Map a collection of embedded documents.
mapManyReference ( array $mapping )	Map a collection of document references.
mapOneEmbedded ( array $mapping )	Map a single embedded document.
mapOneReference ( array $mapping )	Map a single document reference.
registerAlsoLoadMethod ( string $method, array | string $fields )	Registers a method for loading document data before field hydration.
setAlsoLoadMethods ( array $methods )	Sets the AlsoLoad methods for documents of this class.
setChangeTrackingPolicy ( integer $policy )	Sets the change tracking policy used by this class.
setCollection ( array | string $name )	Sets the collection this Document is mapped to.
setCollectionCapped ( boolean $bool )	Set whether or not the documents collection is capped.
setCollectionMax ( integer $max )	Set the collection max.
setCollectionSize ( integer $size )	Set the collection size.
setCustomRepositoryClass ( string $repositoryClassName )	Registers a custom repository class for the document class.
setDatabase ( string $db )	Set the database this Document is mapped to.
setDefaultDiscriminatorValue ( string $defaultDiscriminatorValue )	Sets the default discriminator value to be used for this class Used for JOINED and SINGLE_TABLE inheritance mapping strategies if the document has no discriminator value
setDiscriminatorField ( string $discriminatorField )	Sets the discriminator field.
setDiscriminatorMap ( array $map )	Sets the discriminator values used by this class.
setDiscriminatorValue ( string $value )	Sets the discriminator value for this class.
setDistance ( string $distance )	Set the field name that stores the distance.
setFieldValue ( object $document, string $field, mixed $value )	Sets the specified field to the specified value on the given document.
setFile ( string $file )	Set the field name that stores the grid file.
setIdGenerator ( AbstractIdGenerator $generator )	Sets the ID generator used to generate IDs for instances of this class.
setIdGeneratorOptions ( array $generatorOptions )	Sets the Id generator options.
setIdGeneratorType ( string $generatorType )	Sets the type of Id generator to use for the mapped class.
setIdentifier ( string $identifier )	INTERNAL: Sets the mapped identifier field of this class.
setIdentifierValue ( object $document, mixed $id )	Sets the document identifier of a document.
setInheritanceType ( integer $type )	Sets the inheritance type used by the class and it's subclasses.
setLifecycleCallbacks ( array $callbacks )	Sets the lifecycle callbacks for documents of this class.
setLockField ( string $lockField )	Sets the name of the field that is to be used for storing whether a document is currently locked or not.
setLockMapping ( array &$mapping )	Sets the version field mapping used for versioning. Sets the default value to use depending on the column type.
setLockable ( boolean $bool )	Sets whether this class is to allow pessimistic locking.
setParentClasses ( array $classNames )	Sets the parent class names.
setRequireIndexes ( boolean $requireIndexes )	Set whether or not queries on this document should require indexes.
setShardKey ( array $keys, array $options = [] )	Set shard key for this Document.
setSlaveOkay ( boolean | null $slaveOkay )	Sets the slaveOkay option applied to collections for this class.
setSubclasses ( array $subclasses )	Sets the mapped subclasses of this class.
setVersionField ( string $versionField )	Sets the name of the field that is to be used for versioning if this class is versioned for optimistic locking.
setVersionMapping ( array &$mapping )	Sets the version field mapping used for versioning. Sets the default value to use depending on the column type.
setVersioned ( boolean $bool )	Sets whether this class is to be versioned for optimistic locking.
setWriteConcern ( string $writeConcern )	Sets the write concern used by this class.

Private Methods

Method	Description
applyStorageStrategy ( array &$mapping )	Validates the storage strategy of a mapping for consistency

Method Details

Property Details