annotate vendor/symfony/serializer/Mapping/AttributeMetadataInterface.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 129ea1e6d783
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 /*
Chris@0 4 * This file is part of the Symfony package.
Chris@0 5 *
Chris@0 6 * (c) Fabien Potencier <fabien@symfony.com>
Chris@0 7 *
Chris@0 8 * For the full copyright and license information, please view the LICENSE
Chris@0 9 * file that was distributed with this source code.
Chris@0 10 */
Chris@0 11
Chris@0 12 namespace Symfony\Component\Serializer\Mapping;
Chris@0 13
Chris@0 14 /**
Chris@0 15 * Stores metadata needed for serializing and deserializing attributes.
Chris@0 16 *
Chris@0 17 * Primarily, the metadata stores serialization groups.
Chris@0 18 *
Chris@0 19 * @internal
Chris@0 20 *
Chris@0 21 * @author Kévin Dunglas <dunglas@gmail.com>
Chris@0 22 */
Chris@0 23 interface AttributeMetadataInterface
Chris@0 24 {
Chris@0 25 /**
Chris@0 26 * Gets the attribute name.
Chris@0 27 *
Chris@0 28 * @return string
Chris@0 29 */
Chris@0 30 public function getName();
Chris@0 31
Chris@0 32 /**
Chris@0 33 * Adds this attribute to the given group.
Chris@0 34 *
Chris@0 35 * @param string $group
Chris@0 36 */
Chris@0 37 public function addGroup($group);
Chris@0 38
Chris@0 39 /**
Chris@0 40 * Gets groups of this attribute.
Chris@0 41 *
Chris@0 42 * @return string[]
Chris@0 43 */
Chris@0 44 public function getGroups();
Chris@0 45
Chris@0 46 /**
Chris@0 47 * Sets the serialization max depth for this attribute.
Chris@0 48 *
Chris@0 49 * @param int|null $maxDepth
Chris@0 50 */
Chris@0 51 public function setMaxDepth($maxDepth);
Chris@0 52
Chris@0 53 /**
Chris@0 54 * Gets the serialization max depth for this attribute.
Chris@0 55 *
Chris@0 56 * @return int|null
Chris@0 57 */
Chris@0 58 public function getMaxDepth();
Chris@0 59
Chris@0 60 /**
Chris@0 61 * Merges an {@see AttributeMetadataInterface} with in the current one.
Chris@0 62 */
Chris@17 63 public function merge(self $attributeMetadata);
Chris@0 64 }