227 lines
		
	
	
		
			6.5 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
		
		
			
		
	
	
			227 lines
		
	
	
		
			6.5 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
| 
								 | 
							
								<?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;
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								use Symfony\Component\PropertyAccess\PropertyPath;
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								/**
							 | 
						||
| 
								 | 
							
								 * @author Kévin Dunglas <dunglas@gmail.com>
							 | 
						||
| 
								 | 
							
								 */
							 | 
						||
| 
								 | 
							
								class AttributeMetadata implements AttributeMetadataInterface
							 | 
						||
| 
								 | 
							
								{
							 | 
						||
| 
								 | 
							
								    /**
							 | 
						||
| 
								 | 
							
								     * @internal This property is public in order to reduce the size of the
							 | 
						||
| 
								 | 
							
								     *           class' serialized representation. Do not access it. Use
							 | 
						||
| 
								 | 
							
								     *           {@link getName()} instead.
							 | 
						||
| 
								 | 
							
								     */
							 | 
						||
| 
								 | 
							
								    public string $name;
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    /**
							 | 
						||
| 
								 | 
							
								     * @internal This property is public in order to reduce the size of the
							 | 
						||
| 
								 | 
							
								     *           class' serialized representation. Do not access it. Use
							 | 
						||
| 
								 | 
							
								     *           {@link getGroups()} instead.
							 | 
						||
| 
								 | 
							
								     */
							 | 
						||
| 
								 | 
							
								    public array $groups = [];
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    /**
							 | 
						||
| 
								 | 
							
								     * @internal This property is public in order to reduce the size of the
							 | 
						||
| 
								 | 
							
								     *           class' serialized representation. Do not access it. Use
							 | 
						||
| 
								 | 
							
								     *           {@link getMaxDepth()} instead.
							 | 
						||
| 
								 | 
							
								     */
							 | 
						||
| 
								 | 
							
								    public ?int $maxDepth = null;
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    /**
							 | 
						||
| 
								 | 
							
								     * @internal This property is public in order to reduce the size of the
							 | 
						||
| 
								 | 
							
								     *           class' serialized representation. Do not access it. Use
							 | 
						||
| 
								 | 
							
								     *           {@link getSerializedName()} instead.
							 | 
						||
| 
								 | 
							
								     */
							 | 
						||
| 
								 | 
							
								    public ?string $serializedName = null;
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    /**
							 | 
						||
| 
								 | 
							
								     * @internal This property is public in order to reduce the size of the
							 | 
						||
| 
								 | 
							
								     *           class' serialized representation. Do not access it. Use
							 | 
						||
| 
								 | 
							
								     *           {@link getSerializedPath()} instead.
							 | 
						||
| 
								 | 
							
								     */
							 | 
						||
| 
								 | 
							
								    public ?PropertyPath $serializedPath = null;
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    /**
							 | 
						||
| 
								 | 
							
								     * @internal This property is public in order to reduce the size of the
							 | 
						||
| 
								 | 
							
								     *           class' serialized representation. Do not access it. Use
							 | 
						||
| 
								 | 
							
								     *           {@link isIgnored()} instead.
							 | 
						||
| 
								 | 
							
								     */
							 | 
						||
| 
								 | 
							
								    public bool $ignore = false;
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    /**
							 | 
						||
| 
								 | 
							
								     * @var array[] Normalization contexts per group name ("*" applies to all groups)
							 | 
						||
| 
								 | 
							
								     *
							 | 
						||
| 
								 | 
							
								     * @internal This property is public in order to reduce the size of the
							 | 
						||
| 
								 | 
							
								     *           class' serialized representation. Do not access it. Use
							 | 
						||
| 
								 | 
							
								     *           {@link getNormalizationContexts()} instead.
							 | 
						||
| 
								 | 
							
								     */
							 | 
						||
| 
								 | 
							
								    public array $normalizationContexts = [];
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    /**
							 | 
						||
| 
								 | 
							
								     * @var array[] Denormalization contexts per group name ("*" applies to all groups)
							 | 
						||
| 
								 | 
							
								     *
							 | 
						||
| 
								 | 
							
								     * @internal This property is public in order to reduce the size of the
							 | 
						||
| 
								 | 
							
								     *           class' serialized representation. Do not access it. Use
							 | 
						||
| 
								 | 
							
								     *           {@link getDenormalizationContexts()} instead.
							 | 
						||
| 
								 | 
							
								     */
							 | 
						||
| 
								 | 
							
								    public array $denormalizationContexts = [];
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    public function __construct(string $name)
							 | 
						||
| 
								 | 
							
								    {
							 | 
						||
| 
								 | 
							
								        $this->name = $name;
							 | 
						||
| 
								 | 
							
								    }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    public function getName(): string
							 | 
						||
| 
								 | 
							
								    {
							 | 
						||
| 
								 | 
							
								        return $this->name;
							 | 
						||
| 
								 | 
							
								    }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    public function addGroup(string $group): void
							 | 
						||
| 
								 | 
							
								    {
							 | 
						||
| 
								 | 
							
								        if (!\in_array($group, $this->groups, true)) {
							 | 
						||
| 
								 | 
							
								            $this->groups[] = $group;
							 | 
						||
| 
								 | 
							
								        }
							 | 
						||
| 
								 | 
							
								    }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    public function getGroups(): array
							 | 
						||
| 
								 | 
							
								    {
							 | 
						||
| 
								 | 
							
								        return $this->groups;
							 | 
						||
| 
								 | 
							
								    }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    public function setMaxDepth(?int $maxDepth): void
							 | 
						||
| 
								 | 
							
								    {
							 | 
						||
| 
								 | 
							
								        $this->maxDepth = $maxDepth;
							 | 
						||
| 
								 | 
							
								    }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    public function getMaxDepth(): ?int
							 | 
						||
| 
								 | 
							
								    {
							 | 
						||
| 
								 | 
							
								        return $this->maxDepth;
							 | 
						||
| 
								 | 
							
								    }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    public function setSerializedName(?string $serializedName): void
							 | 
						||
| 
								 | 
							
								    {
							 | 
						||
| 
								 | 
							
								        $this->serializedName = $serializedName;
							 | 
						||
| 
								 | 
							
								    }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    public function getSerializedName(): ?string
							 | 
						||
| 
								 | 
							
								    {
							 | 
						||
| 
								 | 
							
								        return $this->serializedName;
							 | 
						||
| 
								 | 
							
								    }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    public function setSerializedPath(?PropertyPath $serializedPath = null): void
							 | 
						||
| 
								 | 
							
								    {
							 | 
						||
| 
								 | 
							
								        $this->serializedPath = $serializedPath;
							 | 
						||
| 
								 | 
							
								    }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    public function getSerializedPath(): ?PropertyPath
							 | 
						||
| 
								 | 
							
								    {
							 | 
						||
| 
								 | 
							
								        return $this->serializedPath;
							 | 
						||
| 
								 | 
							
								    }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    public function setIgnore(bool $ignore): void
							 | 
						||
| 
								 | 
							
								    {
							 | 
						||
| 
								 | 
							
								        $this->ignore = $ignore;
							 | 
						||
| 
								 | 
							
								    }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    public function isIgnored(): bool
							 | 
						||
| 
								 | 
							
								    {
							 | 
						||
| 
								 | 
							
								        return $this->ignore;
							 | 
						||
| 
								 | 
							
								    }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    public function getNormalizationContexts(): array
							 | 
						||
| 
								 | 
							
								    {
							 | 
						||
| 
								 | 
							
								        return $this->normalizationContexts;
							 | 
						||
| 
								 | 
							
								    }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    public function getNormalizationContextForGroups(array $groups): array
							 | 
						||
| 
								 | 
							
								    {
							 | 
						||
| 
								 | 
							
								        $contexts = [];
							 | 
						||
| 
								 | 
							
								        foreach ($groups as $group) {
							 | 
						||
| 
								 | 
							
								            $contexts[] = $this->normalizationContexts[$group] ?? [];
							 | 
						||
| 
								 | 
							
								        }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								        return array_merge($this->normalizationContexts['*'] ?? [], ...$contexts);
							 | 
						||
| 
								 | 
							
								    }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    public function setNormalizationContextForGroups(array $context, array $groups = []): void
							 | 
						||
| 
								 | 
							
								    {
							 | 
						||
| 
								 | 
							
								        if (!$groups) {
							 | 
						||
| 
								 | 
							
								            $this->normalizationContexts['*'] = $context;
							 | 
						||
| 
								 | 
							
								        }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								        foreach ($groups as $group) {
							 | 
						||
| 
								 | 
							
								            $this->normalizationContexts[$group] = $context;
							 | 
						||
| 
								 | 
							
								        }
							 | 
						||
| 
								 | 
							
								    }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    public function getDenormalizationContexts(): array
							 | 
						||
| 
								 | 
							
								    {
							 | 
						||
| 
								 | 
							
								        return $this->denormalizationContexts;
							 | 
						||
| 
								 | 
							
								    }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    public function getDenormalizationContextForGroups(array $groups): array
							 | 
						||
| 
								 | 
							
								    {
							 | 
						||
| 
								 | 
							
								        $contexts = [];
							 | 
						||
| 
								 | 
							
								        foreach ($groups as $group) {
							 | 
						||
| 
								 | 
							
								            $contexts[] = $this->denormalizationContexts[$group] ?? [];
							 | 
						||
| 
								 | 
							
								        }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								        return array_merge($this->denormalizationContexts['*'] ?? [], ...$contexts);
							 | 
						||
| 
								 | 
							
								    }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    public function setDenormalizationContextForGroups(array $context, array $groups = []): void
							 | 
						||
| 
								 | 
							
								    {
							 | 
						||
| 
								 | 
							
								        if (!$groups) {
							 | 
						||
| 
								 | 
							
								            $this->denormalizationContexts['*'] = $context;
							 | 
						||
| 
								 | 
							
								        }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								        foreach ($groups as $group) {
							 | 
						||
| 
								 | 
							
								            $this->denormalizationContexts[$group] = $context;
							 | 
						||
| 
								 | 
							
								        }
							 | 
						||
| 
								 | 
							
								    }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    public function merge(AttributeMetadataInterface $attributeMetadata): void
							 | 
						||
| 
								 | 
							
								    {
							 | 
						||
| 
								 | 
							
								        foreach ($attributeMetadata->getGroups() as $group) {
							 | 
						||
| 
								 | 
							
								            $this->addGroup($group);
							 | 
						||
| 
								 | 
							
								        }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								        // Overwrite only if not defined
							 | 
						||
| 
								 | 
							
								        $this->maxDepth ??= $attributeMetadata->getMaxDepth();
							 | 
						||
| 
								 | 
							
								        $this->serializedName ??= $attributeMetadata->getSerializedName();
							 | 
						||
| 
								 | 
							
								        $this->serializedPath ??= $attributeMetadata->getSerializedPath();
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								        // Overwrite only if both contexts are empty
							 | 
						||
| 
								 | 
							
								        if (!$this->normalizationContexts && !$this->denormalizationContexts) {
							 | 
						||
| 
								 | 
							
								            $this->normalizationContexts = $attributeMetadata->getNormalizationContexts();
							 | 
						||
| 
								 | 
							
								            $this->denormalizationContexts = $attributeMetadata->getDenormalizationContexts();
							 | 
						||
| 
								 | 
							
								        }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								        if ($ignore = $attributeMetadata->isIgnored()) {
							 | 
						||
| 
								 | 
							
								            $this->ignore = $ignore;
							 | 
						||
| 
								 | 
							
								        }
							 | 
						||
| 
								 | 
							
								    }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    /**
							 | 
						||
| 
								 | 
							
								     * Returns the names of the properties that should be serialized.
							 | 
						||
| 
								 | 
							
								     *
							 | 
						||
| 
								 | 
							
								     * @return string[]
							 | 
						||
| 
								 | 
							
								     */
							 | 
						||
| 
								 | 
							
								    public function __sleep(): array
							 | 
						||
| 
								 | 
							
								    {
							 | 
						||
| 
								 | 
							
								        return ['name', 'groups', 'maxDepth', 'serializedName', 'serializedPath', 'ignore', 'normalizationContexts', 'denormalizationContexts'];
							 | 
						||
| 
								 | 
							
								    }
							 | 
						||
| 
								 | 
							
								}
							 |