W3cubDocs

/Symfony 4.1

ClassMetadataInterface

interface ClassMetadataInterface

Stores metadata needed for serializing and deserializing objects of specific class.

Primarily, the metadata stores the set of attributes to serialize or deserialize.

There may only exist one metadata for each attribute according to its name.

Methods

string getName()

Returns the name of the backing PHP class.

addAttributeMetadata(AttributeMetadataInterface $attributeMetadata)

Adds an {@link AttributeMetadataInterface}.

AttributeMetadataInterface[] getAttributesMetadata()

Gets the list of {@link AttributeMetadataInterface}.

merge(ClassMetadataInterface $classMetadata)

Merges a {@link ClassMetadataInterface} in the current one.

ReflectionClass getReflectionClass()

Returns a {@link \ReflectionClass} instance for this class.

ClassDiscriminatorMapping|null getClassDiscriminatorMapping()
setClassDiscriminatorMapping(ClassDiscriminatorMapping $mapping = null)

Details

string getName()

Returns the name of the backing PHP class.

Return Value

string The name of the backing class

addAttributeMetadata(AttributeMetadataInterface $attributeMetadata)

Adds an {@link AttributeMetadataInterface}.

Parameters

AttributeMetadataInterface $attributeMetadata

AttributeMetadataInterface[] getAttributesMetadata()

Gets the list of {@link AttributeMetadataInterface}.

Return Value

AttributeMetadataInterface[]

merge(ClassMetadataInterface $classMetadata)

Merges a {@link ClassMetadataInterface} in the current one.

Parameters

ClassMetadataInterface $classMetadata

ReflectionClass getReflectionClass()

Returns a {@link \ReflectionClass} instance for this class.

Return Value

ReflectionClass

ClassDiscriminatorMapping|null getClassDiscriminatorMapping()

Return Value

ClassDiscriminatorMapping|null

setClassDiscriminatorMapping(ClassDiscriminatorMapping $mapping = null)

Parameters

ClassDiscriminatorMapping $mapping

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Serializer/Mapping/ClassMetadataInterface.html