interface AttributeMetadataInterface

Stores metadata needed for serializing and deserializing attributes.

Primarily, the metadata stores serialization groups.

Methods

string
getName()

Gets the attribute name.

void
addGroup(string$group)

Adds this attribute to the given group.

array
getGroups()

Gets groups of this attribute.

void
setMaxDepth(int|null$maxDepth)

Sets the serialization max depth for this attribute.

int|null
getMaxDepth()

Gets the serialization max depth for this attribute.

void
setSerializedName(string|null$serializedName)

Sets the serialization name for this attribute.

string|null
getSerializedName()

Gets the serialization name for this attribute.

void
setSerializedPath(PropertyPath|null$serializedPath)

No description

PropertyPath|null
getSerializedPath()

No description

void
setIgnore(bool$ignore)

Sets if this attribute must be ignored or not.

bool
isIgnored()

Gets if this attribute is ignored or not.

void
merge(AttributeMetadataInterface$attributeMetadata)

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

array
getNormalizationContexts()

Gets all the normalization contexts per group ("*" being the base context applied to all groups).

array
getNormalizationContextForGroups(array$groups)

Gets the computed normalization contexts for given groups.

void
setNormalizationContextForGroups(array$context,array$groups =[])

Sets the normalization context for given groups.

array
getDenormalizationContexts()

Gets all the denormalization contexts per group ("*" being the base context applied to all groups).

array
getDenormalizationContextForGroups(array$groups)

Gets the computed denormalization contexts for given groups.

void
setDenormalizationContextForGroups(array$context,array$groups =[])

Sets the denormalization context for given groups.

Details

string getName()

Gets the attribute name.

Return Value

string

void addGroup(string$group)

Adds this attribute to the given group.

Parameters

string $group

Return Value

void

array getGroups()

Gets groups of this attribute.

Return Value

array

void setMaxDepth(int|null$maxDepth)

Sets the serialization max depth for this attribute.

Parameters

int|null $maxDepth

Return Value

void

int|null getMaxDepth()

Gets the serialization max depth for this attribute.

Return Value

int|null

void setSerializedName(string|null$serializedName)

Sets the serialization name for this attribute.

Parameters

string|null $serializedName

Return Value

void

string|null getSerializedName()

Gets the serialization name for this attribute.

Return Value

string|null

void setSerializedPath(PropertyPath|null$serializedPath)

Parameters

PropertyPath|null $serializedPath

Return Value

void

PropertyPath|null getSerializedPath()

Return Value

PropertyPath|null

void setIgnore(bool$ignore)

Sets if this attribute must be ignored or not.

Parameters

bool $ignore

Return Value

void

bool isIgnored()

Gets if this attribute is ignored or not.

Return Value

bool

void merge(AttributeMetadataInterface$attributeMetadata)

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

Parameters

AttributeMetadataInterface $attributeMetadata

Return Value

void

array getNormalizationContexts()

Gets all the normalization contexts per group ("*" being the base context applied to all groups).

Return Value

array

array getNormalizationContextForGroups(array$groups)

Gets the computed normalization contexts for given groups.

Parameters

array $groups

Return Value

array

void setNormalizationContextForGroups(array$context,array$groups =[])

Sets the normalization context for given groups.

Parameters

array $context
array $groups

Return Value

void

array getDenormalizationContexts()

Gets all the denormalization contexts per group ("*" being the base context applied to all groups).

Return Value

array

array getDenormalizationContextForGroups(array$groups)

Gets the computed denormalization contexts for given groups.

Parameters

array $groups

Return Value

array

void setDenormalizationContextForGroups(array$context,array$groups =[])

Sets the denormalization context for given groups.

Parameters

array $context
array $groups

Return Value

void