• Home
• Doctrine
• ODM
• CouchDB
• Mapping
• ClassMetadata

PHP Class Doctrine\ODM\CouchDB\Mapping\ClassMetadata

ファイルを表示 Open project: doctrine/couchdb-odm Class Usage Examples

Public Properties

Property	Type	Description
$alsoLoadMethods	array	READ-ONLY: Array of fields to also load with a given method.
$associationsMappings	array	READ-ONLY
$attachmentDeclaredClass	string | null	If in an inheritance scenario the attachment field is on a super class, this is its name.
$attachmentField	string	Field that stores the attachments as a key->value array of file-names to attachment objects.
$customRepositoryClassName	string	(Optional).
$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.
$hasAttachments	boolean
$idGenerator
$identifier		READ-ONLY: The field name of the document identifier.
$inInheritanceHierachy		READ-ONLY: Is this entity in an inheritance hierachy?
$indexed	boolean	Is this class indexed? If yes, then a findAll() query can be executed for this type.
$indexes	array	An array of indexed fields, accessible through a generic view shipped with Doctrine.
$isEmbeddedDocument	boolean	READ-ONLY: Whether this class describes the mapping of a embedded document.
$isMappedSuperclass	boolean	READ-ONLY: Whether this class describes the mapping of a mapped superclass.
$isReadOnly	boolean	This should be set to true for value objects, for example attachments. Replacing the reference with a new value object will trigger an update.
$isVersioned	boolean	CouchDB documents are always versioned, this flag determines if this version is exposed to the userland.
$jsonNames	array	An array of json result-key-names to field-names
$name		READ-ONLY: The name of the document class.
$namespace	string	READ-ONLY: The namespace the document class is contained in.
$parentClasses		READ-ONLY: a list of all parent classes.
$reflClass	ReflectionClas\ReflectionClass	The ReflectionClass instance of the mapped class.
$reflFields	array	The ReflectionProperty instances of the mapped class.
$rootDocumentName		READ-ONLY: The root document class name.
$versionField	string	Version Field stores the CouchDB Revision

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.
__sleep ( ) : array	Determines which fields get serialized.
deriveChildMetadata ( ClassMetadata $child )	Used to derive a class metadata of the current instance for a mapped child class.
getAssociationMappedByTargetField ( $assocName )	{@inheritDoc}
getAssociationNames ( ) : array	A numerically indexed list of association names of this persistent class.
getAssociationTargetClass ( string $assocName ) : string	Returns the target class name of the given association.
getFieldMapping ( string $fieldName ) : array	Gets the mapping of a field.
getFieldNames ( ) : array	A numerically indexed list of field names of this persistent class.
getFieldValue ( object $document, string $field )	Gets the specified field's value off the given document.
getIdentifier ( ) : string	Gets the mapped identifier field of this class.
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.
getName ( ) : string	The name of this Document class.
getNamespace ( ) : string	The namespace this Document class belongs to.
getReflectionClass ( ) : ReflectionClas\ReflectionClass	Gets the ReflectionClass instance of the mapped class.
getReflectionProperties ( ) : array	Gets the ReflectionPropertys of the mapped class.
getReflectionProperty ( string $name ) : ReflectionPropert\ReflectionProperty	Gets a ReflectionProperty for a specific field of the mapped class.
getTypeOfField ( string $fieldName ) : Type	Gets the type of a field.
hasAssociation ( string $fieldName ) : boolean	Checks if the given field is a mapped association for this class.
hasField ( $fieldName ) : boolean	Checks whether the class has a (mapped) field with a certain name.
initializeReflection ( Doctrine\Common\Persistence\Mapping\ReflectionService $reflService ) : void	Initializes a new ClassMetadata instance that will hold the object-relational mapping metadata of the class with the given name.
isAssociationInverseSide ( $assocName )	{@inheritDoc}
isCollectionValuedAssociation ( $name )
isIdentifier ( string $fieldName ) : boolean	Checks whether a field is part of the identifier/primary key field(s).
isInheritedAssociation ( $field )
isInheritedField ( $field )
isSingleValuedAssociation ( string $fieldName ) : boolean	Checks if the given field is a mapped single valued association for this class.
mapAttachments ( string $fieldName )	Set the field that will contain attachments of this document.
mapEmbedded ( array $mapping )	Map an embedded object
mapField ( array $mapping )	Map a field.
mapManyToMany ( $mapping )
mapManyToOne ( $mapping )
markInheritanceRoot ( )
newInstance ( ) : object	Creates a new instance of the mapped class, without invoking the constructor.
setCustomRepositoryClass ( 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.
setParentClasses ( $classes )
wakeupReflection ( $reflService )	Restores some state that can not be serialized/unserialized.

Protected Methods

Method	Description
validateAndCompleteAssociationMapping ( $mapping )
validateAndCompleteFieldMapping ( $mapping )
validateAndCompleteReferenceMapping ( $mapping )

Private Methods

Method	Description
checkAndStoreIndexMapping ( $mapping )
storeAssociationMapping ( $mapping )

Method Details

Property Details