Classes List

Symfony\Component\Serializer\Mapping\AttributeMetadataInterface

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
<?php

/* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


namespace Symfony\Component\Serializer\Mapping;

/** * Stores metadata needed for serializing and deserializing attributes. * * Primarily, the metadata stores serialization groups. * * @internal * * @author Kévin Dunglas <dunglas@gmail.com> */
interface AttributeMetadataInterface
{
    /** * Gets the attribute name. * * @return string */
    public function getName();

    /** * Adds this attribute to the given group. * * @param string $group */
    public function addGroup($group);

    /** * Gets groups of this attribute. * * @return string[] */
    public function getGroups();

    /** * Sets the serialization max depth for this attribute. * * @param int|null $maxDepth */
    public function setMaxDepth($maxDepth);

    /** * Gets the serialization max depth for this attribute. * * @return int|null */
    public function getMaxDepth();

    /** * Merges an {@see AttributeMetadataInterface} with in the current one. */
    public function merge(self $attributeMetadata);
}