You are here

AttributeMetadataInterface.php in Zircon Profile 8

Same filename and directory in other branches
  1. 8.0 vendor/symfony/serializer/Mapping/AttributeMetadataInterface.php

File

vendor/symfony/serializer/Mapping/AttributeMetadataInterface.php
View source
<?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.
 *
 * @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();

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

}

Interfaces

Namesort descending Description
AttributeMetadataInterface Stores metadata needed for serializing and deserializing attributes.