• Home
• Doctrine
• Search
• Mapping
• ClassMetadata

PHP Class Doctrine\Search\Mapping\ClassMetadata

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 (public/protected members get the whole class name, namespace inclusive, prepended to every property in the serialized representation). Show file Open project: doctrine/search Class Usage Examples

Public Properties

Property	Type	Description
$boost	float
$className	string
$fieldMappings	array | Doctrine\Search\Mapping\Annotations\ElasticField[]	The ReflectionProperty instances of the mapped class.
$identifier	string	The field name of the identifier
$index	string
$numberOfReplicas	integer
$numberOfShards	integer
$parameters	array	The ReflectionProperty parameters of the mapped class.
$parent	string
$reflClass	ReflectionClass	The ReflectionClass instance of the mapped class.
$reflFields	ReflectionClass	The ReflectionClass instance of the mapped class.
$rootMappings	array | Doctrine\Search\Mapping\Annotations\ElasticRoot[]	Additional root annotations of the mapped class.
$source	boolean
$timeToLive	integer
$type	string
$value	integer

Public Methods

Method	Description
__construct ( $documentName )
__sleep ( ) : array	Determines which fields get serialized.
getAssociationMappedByTargetField ( $assocName )
getAssociationNames ( ) : array	Currently not necessary but needed by Interface
getAssociationTargetClass ( string $assocName ) : string	Currently not necessary but needed by Interface
getFieldNames ( ) : array	A numerically indexed list of field names of this persistent class.
getIdentifier ( ) : array	Gets the mapped identifier field name.
getIdentifierFieldNames ( ) : array	Returns an array of identifier field names numerically indexed.
getIdentifierValues ( object $object ) : array	Return the identifier of this object as an array with field name as key.
getName ( ) : string	Get fully-qualified class name of this persistent class.
getReflectionClass ( ) : ReflectionClass	Gets the ReflectionClass instance for this mapped class.
getTypeOfField ( string $fieldName ) : string	Returns a type name of this field.
hasAssociation ( string $fieldName ) : boolean	Checks if the given field is a mapped association for this class.
hasField ( string $fieldName ) : boolean	Checks if the given field is a mapped property for this class.
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 )
isCollectionValuedAssociation ( string $fieldName ) : boolean	Checks if the given field is a mapped collection valued association for this class.
isIdentifier ( string $fieldName ) : boolean	Checks if the given field name is a mapped identifier for this class.
isSingleValuedAssociation ( string $fieldName ) : boolean	Checks if the given field is a mapped single valued association for this class.
mapField ( array $mapping ) : void	Adds a mapped field to the class.
mapParameter ( array $mapping ) : void	Adds a mapped parameter to the class.
mapRoot ( array $mapping = [] )	Adds a root mapping to the class.
setIdentifier ( mixed $identifier )	INTERNAL: Sets the mapped identifier key field of this class.
wakeupReflection ( Doctrine\Common\Persistence\Mapping\ReflectionService $reflService ) : void	Restores some state that can not be serialized/unserialized.

Method Details

Property Details