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

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents c2387f117808
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 objects of specific class.
Chris@0 16 *
Chris@0 17 * Primarily, the metadata stores the set of attributes to serialize or deserialize.
Chris@0 18 *
Chris@0 19 * There may only exist one metadata for each attribute according to its name.
Chris@0 20 *
Chris@0 21 * @internal
Chris@0 22 *
Chris@0 23 * @author Kévin Dunglas <dunglas@gmail.com>
Chris@0 24 */
Chris@0 25 interface ClassMetadataInterface
Chris@0 26 {
Chris@0 27 /**
Chris@0 28 * Returns the name of the backing PHP class.
Chris@0 29 *
Chris@0 30 * @return string The name of the backing class
Chris@0 31 */
Chris@0 32 public function getName();
Chris@0 33
Chris@0 34 /**
Chris@0 35 * Adds an {@link AttributeMetadataInterface}.
Chris@0 36 */
Chris@0 37 public function addAttributeMetadata(AttributeMetadataInterface $attributeMetadata);
Chris@0 38
Chris@0 39 /**
Chris@0 40 * Gets the list of {@link AttributeMetadataInterface}.
Chris@0 41 *
Chris@0 42 * @return AttributeMetadataInterface[]
Chris@0 43 */
Chris@0 44 public function getAttributesMetadata();
Chris@0 45
Chris@0 46 /**
Chris@0 47 * Merges a {@link ClassMetadataInterface} in the current one.
Chris@0 48 */
Chris@16 49 public function merge(self $classMetadata);
Chris@0 50
Chris@0 51 /**
Chris@0 52 * Returns a {@link \ReflectionClass} instance for this class.
Chris@0 53 *
Chris@0 54 * @return \ReflectionClass
Chris@0 55 */
Chris@0 56 public function getReflectionClass();
Chris@0 57 }