1. interface
  2. Symfony
  3. \
  4. Component
  5. \
  6. Serializer
  7. \
  8. Mapping
  9. \
  10. AttributeMetadataInterface

AttributeMetadataInterface

interface AttributeMetadataInterface

Stores metadata needed for serializing and deserializing attributes.

Primarily, the metadata stores serialization groups.

Methods

string
getName()

Gets the attribute name.

addGroup(string $group)

Adds this attribute to the given group.

string[]
getGroups()

Gets groups of this attribute.

setMaxDepth(int|null $maxDepth)

Sets the serialization max depth for this attribute.

int|null
getMaxDepth()

Gets the serialization max depth for this attribute.

setSerializedName(string $serializedName = null)

Sets the serialization name for this attribute.

string|null
getSerializedName()

Gets the serialization name for this attribute.

merge(AttributeMetadataInterface $attributeMetadata)

Merges an {see AttributeMetadataInterface} with in the current one.

Details

string getName()

Gets the attribute name.

Return Value

string

addGroup(string $group)

Adds this attribute to the given group.

Parameters

string $group

string[] getGroups()

Gets groups of this attribute.

Return Value

string[]

setMaxDepth(int|null $maxDepth)

Sets the serialization max depth for this attribute.

Parameters

int|null $maxDepth

int|null getMaxDepth()

Gets the serialization max depth for this attribute.

Return Value

int|null

setSerializedName(string $serializedName = null)

Sets the serialization name for this attribute.

Parameters

string $serializedName

string|null getSerializedName()

Gets the serialization name for this attribute.

Return Value

string|null

merge(AttributeMetadataInterface $attributeMetadata)

Merges an {see AttributeMetadataInterface} with in the current one.

Parameters

AttributeMetadataInterface $attributeMetadata