vendor/symfony/serializer/Mapping/AttributeMetadata.php line 133

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Serializer\Mapping;
  14. use Symfony\Component\PropertyAccess\PropertyPath;
  16. /**
  17.  * @author Kévin Dunglas <dunglas@gmail.com>
  18.  */
  19. class AttributeMetadata implements AttributeMetadataInterface
  20. {
  21.     /**
  22.      * @internal This property is public in order to reduce the size of the
  23.      *           class' serialized representation. Do not access it. Use
  24.      *           {@link getName()} instead.
  25.      */
  26.     public $name;
  28.     /**
  29.      * @internal This property is public in order to reduce the size of the
  30.      *           class' serialized representation. Do not access it. Use
  31.      *           {@link getGroups()} instead.
  32.      */
  33.     public $groups = [];
  35.     /**
  36.      * @var int|null
  37.      *
  38.      * @internal This property is public in order to reduce the size of the
  39.      *           class' serialized representation. Do not access it. Use
  40.      *           {@link getMaxDepth()} instead.
  41.      */
  42.     public $maxDepth;
  44.     /**
  45.      * @var string|null
  46.      *
  47.      * @internal This property is public in order to reduce the size of the
  48.      *           class' serialized representation. Do not access it. Use
  49.      *           {@link getSerializedName()} instead.
  50.      */
  51.     public $serializedName;
  53.     /**
  54.      * @internal This property is public in order to reduce the size of the
  55.      *           class' serialized representation. Do not access it. Use
  56.      *           {@link getSerializedPath()} instead.
  57.      */
  58.     public ?PropertyPath $serializedPath = null;
  60.     /**
  61.      * @var bool
  62.      *
  63.      * @internal This property is public in order to reduce the size of the
  64.      *           class' serialized representation. Do not access it. Use
  65.      *           {@link isIgnored()} instead.
  66.      */
  67.     public $ignore = false;
  69.     /**
  70.      * @var array[] Normalization contexts per group name ("*" applies to all groups)
  71.      *
  72.      * @internal This property is public in order to reduce the size of the
  73.      *           class' serialized representation. Do not access it. Use
  74.      *           {@link getNormalizationContexts()} instead.
  75.      */
  76.     public $normalizationContexts = [];
  78.     /**
  79.      * @var array[] Denormalization contexts per group name ("*" applies to all groups)
  80.      *
  81.      * @internal This property is public in order to reduce the size of the
  82.      *           class' serialized representation. Do not access it. Use
  83.      *           {@link getDenormalizationContexts()} instead.
  84.      */
  85.     public $denormalizationContexts = [];
  87.     public function __construct(string $name)
  88.     {
  89.         $this->name = $name;
  90.     }
  92.     public function getName(): string
  93.     {
  94.         return $this->name;
  95.     }
  97.     public function addGroup(string $group)
  98.     {
  99.         if (!\in_array($group, $this->groups)) {
  100.             $this->groups[] = $group;
  101.         }
  102.     }
  104.     public function getGroups(): array
  105.     {
  106.         return $this->groups;
  107.     }
  109.     public function setMaxDepth(?int $maxDepth)
  110.     {
  111.         $this->maxDepth = $maxDepth;
  112.     }
  114.     public function getMaxDepth(): ?int
  115.     {
  116.         return $this->maxDepth;
  117.     }
  119.     public function setSerializedName(string $serializedName = null)
  120.     {
  121.         if (1 > \func_num_args()) {
  122.             trigger_deprecation('symfony/serializer', '6.2', 'Calling "%s()" without any arguments is deprecated, pass null explicitly instead.', __METHOD__);
  123.         }
  125.         $this->serializedName = $serializedName;
  126.     }
  128.     public function getSerializedName(): ?string
  129.     {
  130.         return $this->serializedName;
  131.     }
  133.     public function setSerializedPath(PropertyPath $serializedPath = null): void
  134.     {
  135.         $this->serializedPath = $serializedPath;
  136.     }
  138.     public function getSerializedPath(): ?PropertyPath
  139.     {
  140.         return $this->serializedPath;
  141.     }
  143.     public function setIgnore(bool $ignore)
  144.     {
  145.         $this->ignore = $ignore;
  146.     }
  148.     public function isIgnored(): bool
  149.     {
  150.         return $this->ignore;
  151.     }
  153.     public function getNormalizationContexts(): array
  154.     {
  155.         return $this->normalizationContexts;
  156.     }
  158.     public function getNormalizationContextForGroups(array $groups): array
  159.     {
  160.         $contexts = [];
  161.         foreach ($groups as $group) {
  162.             $contexts[] = $this->normalizationContexts[$group] ?? [];
  163.         }
  165.         return array_merge($this->normalizationContexts['*'] ?? [], ...$contexts);
  166.     }
  168.     public function setNormalizationContextForGroups(array $context, array $groups = []): void
  169.     {
  170.         if (!$groups) {
  171.             $this->normalizationContexts['*'] = $context;
  172.         }
  174.         foreach ($groups as $group) {
  175.             $this->normalizationContexts[$group] = $context;
  176.         }
  177.     }
  179.     public function getDenormalizationContexts(): array
  180.     {
  181.         return $this->denormalizationContexts;
  182.     }
  184.     public function getDenormalizationContextForGroups(array $groups): array
  185.     {
  186.         $contexts = [];
  187.         foreach ($groups as $group) {
  188.             $contexts[] = $this->denormalizationContexts[$group] ?? [];
  189.         }
  191.         return array_merge($this->denormalizationContexts['*'] ?? [], ...$contexts);
  192.     }
  194.     public function setDenormalizationContextForGroups(array $context, array $groups = []): void
  195.     {
  196.         if (!$groups) {
  197.             $this->denormalizationContexts['*'] = $context;
  198.         }
  200.         foreach ($groups as $group) {
  201.             $this->denormalizationContexts[$group] = $context;
  202.         }
  203.     }
  205.     public function merge(AttributeMetadataInterface $attributeMetadata)
  206.     {
  207.         foreach ($attributeMetadata->getGroups() as $group) {
  208.             $this->addGroup($group);
  209.         }
  211.         // Overwrite only if not defined
  212.         $this->maxDepth ??= $attributeMetadata->getMaxDepth();
  213.         $this->serializedName ??= $attributeMetadata->getSerializedName();
  214.         $this->serializedPath ??= $attributeMetadata->getSerializedPath();
  216.         // Overwrite only if both contexts are empty
  217.         if (!$this->normalizationContexts && !$this->denormalizationContexts) {
  218.             $this->normalizationContexts = $attributeMetadata->getNormalizationContexts();
  219.             $this->denormalizationContexts = $attributeMetadata->getDenormalizationContexts();
  220.         }
  222.         if ($ignore = $attributeMetadata->isIgnored()) {
  223.             $this->ignore = $ignore;
  224.         }
  225.     }
  227.     /**
  228.      * Returns the names of the properties that should be serialized.
  229.      *
  230.      * @return string[]
  231.      */
  232.     public function __sleep(): array
  233.     {
  234.         return ['name', 'groups', 'maxDepth', 'serializedName', 'serializedPath', 'ignore', 'normalizationContexts', 'denormalizationContexts'];
  235.     }
  236. }