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.

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

merge(AttributeMetadataInterface $attributeMetadata)

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

Parameters

AttributeMetadataInterface $attributeMetadata

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Serializer/Mapping/AttributeMetadataInterface.html