• Home
• Doctrine
• ODM
• PHPCR
• Mapping
• ClassMetadata

PHP Class Doctrine\ODM\PHPCR\Mapping\ClassMetadata

Show file Open project: doctrine/phpcr-odm Class Usage Examples

Public Properties

Property	Type	Description
$childClasses	array	If empty then any classes are permitted.
$childMappings	array	READ-ONLY: The child mappings of the class.
$childrenMappings	array	READ-ONLY: The children mappings of the class.
$customRepositoryClassName	string	(Optional).
$depthMapping	string	READ-ONLY: Name of the depth property
$fieldMappings	array	READ-ONLY: The field mappings of the class.
$idGenerator		READ-ONLY: The ID generator used for generating IDs for this class.
$identifier		READ-ONLY: The field name of the document identifier.
$inheritMixins	boolean	READ-ONLY: Inherit parent class' mixins (default) or not
$isLeaf	boolean	READ-ONLY: If the document should be act as a leaf-node and therefore not be allowed children.
$isMappedSuperclass	boolean	READ-ONLY: Whether this class describes the mapping of a mapped superclass.
$lifecycleCallbacks	array	READ-ONLY: The registered lifecycle callbacks for documents of this class.
$localeMapping	string	READ-ONLY: Name of the locale property
$mappings	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.
$mixedReferrersMappings	array	READ-ONLY: The mixed referrers (read only) mappings of the class.
$mixins	array	READ-ONLY: The JCR Mixins to be used for this node (including inherited mixins)
$name		READ-ONLY: The name of the document class that is stored in the phpcr:class property
$namespace	string	READ-ONLY: The namespace the document class is contained in.
$node	string	READ-ONLY: The field name of the node
$nodeType	string	READ-ONLY: The JCR Nodetype to be used for this node
$nodename	string	READ-ONLY except on document creation: The field name for the name of the node.
$parentClasses	array	READ-ONLY: Mapped parent classes.
$parentMapping	string	READ-ONLY except on document creation: The field name for the parent document.
$referenceMappings	array	READ-ONLY: The reference mappings of the class.
$referenceable	boolean	READ-ONLY: determines if the document is referenceable or not
$referrersMappings	array	READ-ONLY: The referrers mappings of the class.
$reflClass	ReflectionClass	The ReflectionClass instance of the mapped class.
$reflFields	ReflectionPropert\ReflectionProperty[]	READ-ONLY: The ReflectionProperty instances of the mapped class.
$translatableFields	array	READ-ONLY: List of translatable fields
$translator	string	This is the key used for DocumentManagerInterface::getTranslationStrategy
$uniqueNodeType	boolean	READ-ONLY: If true, consider this document's node type to be unique among all mappings.
$uuidFieldName		READ-ONLY: The field name of the UUID field
$versionCreatedField	string	READ-ONLY: Name of the version created property of this document
$versionNameField	string	READ-ONLY: Name of the version name property of this document
$versionable	boolean | string	READ-ONLY: Whether this document should be versioned. If this is not false, it will be one of the values from self::validVersionableAnnotations

Protected Properties

Property	Type	Description
$validVersionableAnnotations

Public Methods

Method	Description
__construct ( string $className )	Initializes a new ClassMetadata instance that will hold the object-document mapping metadata of the class with the given name.
__sleep ( ) : array	Determines which fields get serialized.
addLifecycleCallback ( string $callback, string $event )	Adds a lifecycle callback for documents of this class.
assertValidChildClass ( ClassMetadata $class )	Assert that the given class FQN can be a child of the document this metadata represents.
fullyQualifiedClassName ( string $className ) : string
getAssociation ( $fieldName ) : array
getAssociationMappedByTargetField ( $assocName )	{@inheritDoc}
getAssociationNames ( )	{@inheritDoc}
getAssociationTargetClass ( $fieldName )	{@inheritDoc}
getChildClasses ( ) : string[]	Return the class names or interfaces that children of this document must be an instance of.
getField ( $fieldName )	{@inheritDoc}
getFieldMapping ( string $fieldName ) : array	Gets the mapping of a (regular) field that holds some data but not a reference to another object.
getFieldNames ( )	{@inheritDoc}
getFieldValue ( object $document, string $field ) : mixed | null	Gets the specified field's value off the given document.
getIdentifier ( )	{@inheritDoc}
getIdentifierFieldNames ( ) : array	Get identifier field names of this class.
getIdentifierValue ( object $document ) : string	Gets the document identifier.
getIdentifierValues ( object $document ) : array	Get identifier values of this document.
getInheritMixins ( ) : boolean	Return whether to inherit mixins from parent
getLifecycleCallbacks ( string $event ) : array	Gets the registered lifecycle callbacks for an event.
getMixins ( ) : array	Return the JCR mixins to be used for this node.
getName ( )	{@inheritDoc}
getNamespace ( ) : string	The namespace this Document class belongs to.
getNodeType ( ) : string	Return the JCR node type to be used for this node.
getParentClasses ( ) : array	Return the mapped parent classes
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.
getTypeOfField ( $fieldName )	{@inheritDoc}
getUuidFieldName ( )
hasAssociation ( $fieldName )	{@inheritDoc}
hasField ( $fieldName )	{@inheritDoc}
hasLifecycleCallbacks ( string $lifecycleEvent ) : boolean	Whether the class has any attached lifecycle listeners or callbacks for a lifecycle event.
hasUniqueNodeType ( ) : boolean	Return true if this document has a unique node type among all mappings.
initializeReflection ( Doctrine\Common\Persistence\Mapping\ReflectionService $reflService )	Initializes a new ClassMetadata instance that will hold the object-relational mapping metadata of the class with the given name.
invokeLifecycleCallbacks ( string $lifecycleEvent, object $document, array $arguments = null )	Dispatches the lifecycle event of the given document to the registered lifecycle callbacks and lifecycle listeners.
isAssociationInverseSide ( $assocName )	{@inheritDoc}
isCollectionValuedAssociation ( $fieldName )	{@inheritDoc}
isIdGeneratorNone ( ) : boolean	Checks whether the class uses no id generator.
isIdGeneratorRepository ( ) : boolean	Checks whether the class will generate an id via the repository.
isIdentifier ( $fieldName )	{@inheritDoc}
isInheritedField ( $fieldName ) : boolean	Checks whether a mapped field is inherited from an entity superclass.
isLeaf ( ) : boolean	Return true if this is designated as a leaf node.
isNullable ( string $fieldName ) : boolean	Check if the field is nullable or not.
isSingleValuedAssociation ( $fieldName )	{@inheritDoc}
isUuid ( string $fieldName ) : boolean	Whether $fieldName is the universally unique identifier of the document.
isValidNodename ( string $nodeName ) : PHPCR\RepositoryException | null	Check if this node name is valid. Returns null if valid, an exception otherwise.
mapChild ( array $mapping, ClassMetadata $inherited = null )
mapChildren ( array $mapping, ClassMetadata $inherited = null )
mapDepth ( array $mapping, ClassMetadata $inherited = null )
mapField ( array $mapping, ClassMetadata $inherited = null )	Map a field.
mapId ( array $mapping, ClassMetadata $inherited = null )
mapLifecycleCallbacks ( array $mapping )
mapLocale ( array $mapping, ClassMetadata $inherited = null )
mapManyToMany ( $mapping, ClassMetadata $inherited = null )
mapManyToOne ( $mapping, ClassMetadata $inherited = null )
mapMixedReferrers ( array $mapping, ClassMetadata $inherited = null )
mapNode ( array $mapping, ClassMetadata $inherited = null )
mapNodename ( array $mapping, ClassMetadata $inherited = null )
mapParentDocument ( array $mapping, ClassMetadata $inherited = null )
mapReferrers ( array $mapping, ClassMetadata $inherited = null )
mapVersionCreated ( array $mapping, ClassMetadata $inherited = null )
mapVersionName ( array $mapping, ClassMetadata $inherited = null )
newInstance ( ) : object	Creates a new instance of the mapped class, without invoking the constructor.
setChildClasses ( array $childClasses )	Set the class names or interfaces that children of this document must be instance of.
setCustomRepositoryClassName ( string $repositoryClassName )	Registers a custom repository class for the document class.
setFieldValue ( object $document, string $field, mixed $value )	Sets the specified field to the specified value on the given document.
setIdentifier ( string $identifier )	INTERNAL: Sets the mapped identifier field of this class.
setIdentifierValue ( object $document, mixed $id )	Sets the document identifier of a document.
setInheritMixins ( boolean $inheritMixins )	Set whether to inherit mixins from parent
setIsLeaf ( boolean $isLeaf )	Set if this document should act as a leaf node.
setLifecycleCallbacks ( array $callbacks )	Sets the lifecycle callbacks for documents of this class.
setMixins ( array $mixins )	Set the JCR mixins
setNodeType ( string $nodeType )
setParentClasses ( array $parentClasses )	Set the mapped parent classes
setReferenceable ( boolean $referenceable )
setTranslator ( $translator )	Sets the translator strategy key
setUniqueNodeType ( boolean $uniqueNodeType )
setVersioned ( string | boolean $versionable )
validateChildClasses ( )	Validate that childClasses is empty if isLeaf is true.
validateClassMapping ( )	Finalize the mapping and make sure that it is consistent.
validateIdentifier ( )	Validate Identifier mapping, determine the strategy if none is explicitly set.
validateLifecycleCallbacks ( Doctrine\Common\Persistence\Mapping\ReflectionService $reflService )	Validate lifecycle callbacks
validateReferenceable ( )	Validate whether this class needs to be referenceable.
validateReferences ( )	Validate association targets actually exist.
validateTranslatables ( )	Validate translatable fields - ensure that the document has a translator strategy in place.
wakeupReflection ( Doctrine\Common\Persistence\Mapping\ReflectionService $reflService )	Restores some state that can not be serialized/unserialized.

Protected Methods

Method	Description
setIdGenerator ( string $generator )	Sets the ID generator used to generate IDs for instances of this class.
validateAndCompleteAssociationMapping ( $mapping, ClassMetadata $inherited = null, $phpcrLabel = 'property' )
validateAndCompleteFieldMapping ( array $mapping, ClassMetadata $inherited = null, boolean $isField = true, string $phpcrLabel = 'property' ) : mixed

Private Methods

Method	Description
determineIdStrategy ( )	Determine the id strategy for this document. Only call this if no explicit strategy was assigned.

Method Details

Property Details