235 lines
10 KiB
PHP
235 lines
10 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\Loader;
|
|
|
|
use Doctrine\Common\Annotations\Reader;
|
|
use Symfony\Component\Serializer\Annotation\Context;
|
|
use Symfony\Component\Serializer\Annotation\DiscriminatorMap;
|
|
use Symfony\Component\Serializer\Annotation\Groups;
|
|
use Symfony\Component\Serializer\Annotation\Ignore;
|
|
use Symfony\Component\Serializer\Annotation\MaxDepth;
|
|
use Symfony\Component\Serializer\Annotation\SerializedName;
|
|
use Symfony\Component\Serializer\Annotation\SerializedPath;
|
|
use Symfony\Component\Serializer\Exception\MappingException;
|
|
use Symfony\Component\Serializer\Mapping\AttributeMetadata;
|
|
use Symfony\Component\Serializer\Mapping\AttributeMetadataInterface;
|
|
use Symfony\Component\Serializer\Mapping\ClassDiscriminatorMapping;
|
|
use Symfony\Component\Serializer\Mapping\ClassMetadataInterface;
|
|
|
|
/**
|
|
* Loader for Doctrine annotations and PHP 8 attributes.
|
|
*
|
|
* @author Kévin Dunglas <dunglas@gmail.com>
|
|
* @author Alexander M. Turek <me@derrabus.de>
|
|
*/
|
|
class AnnotationLoader implements LoaderInterface
|
|
{
|
|
private const KNOWN_ANNOTATIONS = [
|
|
DiscriminatorMap::class,
|
|
Groups::class,
|
|
Ignore::class,
|
|
MaxDepth::class,
|
|
SerializedName::class,
|
|
SerializedPath::class,
|
|
Context::class,
|
|
];
|
|
|
|
private $reader;
|
|
|
|
public function __construct(Reader $reader = null)
|
|
{
|
|
$this->reader = $reader;
|
|
}
|
|
|
|
public function loadClassMetadata(ClassMetadataInterface $classMetadata): bool
|
|
{
|
|
$reflectionClass = $classMetadata->getReflectionClass();
|
|
$className = $reflectionClass->name;
|
|
$loaded = false;
|
|
|
|
$attributesMetadata = $classMetadata->getAttributesMetadata();
|
|
|
|
foreach ($this->loadAnnotations($reflectionClass) as $annotation) {
|
|
if ($annotation instanceof DiscriminatorMap) {
|
|
$classMetadata->setClassDiscriminatorMapping(new ClassDiscriminatorMapping(
|
|
$annotation->getTypeProperty(),
|
|
$annotation->getMapping()
|
|
));
|
|
}
|
|
}
|
|
|
|
foreach ($reflectionClass->getProperties() as $property) {
|
|
if (!isset($attributesMetadata[$property->name])) {
|
|
$attributesMetadata[$property->name] = new AttributeMetadata($property->name);
|
|
$classMetadata->addAttributeMetadata($attributesMetadata[$property->name]);
|
|
}
|
|
|
|
if ($property->getDeclaringClass()->name === $className) {
|
|
foreach ($this->loadAnnotations($property) as $annotation) {
|
|
if ($annotation instanceof Groups) {
|
|
foreach ($annotation->getGroups() as $group) {
|
|
$attributesMetadata[$property->name]->addGroup($group);
|
|
}
|
|
} elseif ($annotation instanceof MaxDepth) {
|
|
$attributesMetadata[$property->name]->setMaxDepth($annotation->getMaxDepth());
|
|
} elseif ($annotation instanceof SerializedName) {
|
|
$attributesMetadata[$property->name]->setSerializedName($annotation->getSerializedName());
|
|
} elseif ($annotation instanceof SerializedPath) {
|
|
$attributesMetadata[$property->name]->setSerializedPath($annotation->getSerializedPath());
|
|
} elseif ($annotation instanceof Ignore) {
|
|
$attributesMetadata[$property->name]->setIgnore(true);
|
|
} elseif ($annotation instanceof Context) {
|
|
$this->setAttributeContextsForGroups($annotation, $attributesMetadata[$property->name]);
|
|
}
|
|
|
|
$loaded = true;
|
|
}
|
|
}
|
|
}
|
|
|
|
foreach ($reflectionClass->getMethods() as $method) {
|
|
if ($method->getDeclaringClass()->name !== $className) {
|
|
continue;
|
|
}
|
|
|
|
if (0 === stripos($method->name, 'get') && $method->getNumberOfRequiredParameters()) {
|
|
continue; /* matches the BC behavior in `Symfony\Component\Serializer\Normalizer\ObjectNormalizer::extractAttributes` */
|
|
}
|
|
|
|
$accessorOrMutator = preg_match('/^(get|is|has|set)(.+)$/i', $method->name, $matches);
|
|
if ($accessorOrMutator) {
|
|
$attributeName = lcfirst($matches[2]);
|
|
|
|
if (isset($attributesMetadata[$attributeName])) {
|
|
$attributeMetadata = $attributesMetadata[$attributeName];
|
|
} else {
|
|
$attributesMetadata[$attributeName] = $attributeMetadata = new AttributeMetadata($attributeName);
|
|
$classMetadata->addAttributeMetadata($attributeMetadata);
|
|
}
|
|
}
|
|
|
|
foreach ($this->loadAnnotations($method) as $annotation) {
|
|
if ($annotation instanceof Groups) {
|
|
if (!$accessorOrMutator) {
|
|
throw new MappingException(sprintf('Groups on "%s::%s()" cannot be added. Groups can only be added on methods beginning with "get", "is", "has" or "set".', $className, $method->name));
|
|
}
|
|
|
|
foreach ($annotation->getGroups() as $group) {
|
|
$attributeMetadata->addGroup($group);
|
|
}
|
|
} elseif ($annotation instanceof MaxDepth) {
|
|
if (!$accessorOrMutator) {
|
|
throw new MappingException(sprintf('MaxDepth on "%s::%s()" cannot be added. MaxDepth can only be added on methods beginning with "get", "is", "has" or "set".', $className, $method->name));
|
|
}
|
|
|
|
$attributeMetadata->setMaxDepth($annotation->getMaxDepth());
|
|
} elseif ($annotation instanceof SerializedName) {
|
|
if (!$accessorOrMutator) {
|
|
throw new MappingException(sprintf('SerializedName on "%s::%s()" cannot be added. SerializedName can only be added on methods beginning with "get", "is", "has" or "set".', $className, $method->name));
|
|
}
|
|
|
|
$attributeMetadata->setSerializedName($annotation->getSerializedName());
|
|
} elseif ($annotation instanceof SerializedPath) {
|
|
if (!$accessorOrMutator) {
|
|
throw new MappingException(sprintf('SerializedPath on "%s::%s()" cannot be added. SerializedPath can only be added on methods beginning with "get", "is", "has" or "set".', $className, $method->name));
|
|
}
|
|
|
|
$attributeMetadata->setSerializedPath($annotation->getSerializedPath());
|
|
} elseif ($annotation instanceof Ignore) {
|
|
if (!$accessorOrMutator) {
|
|
throw new MappingException(sprintf('Ignore on "%s::%s()" cannot be added. Ignore can only be added on methods beginning with "get", "is", "has" or "set".', $className, $method->name));
|
|
}
|
|
|
|
$attributeMetadata->setIgnore(true);
|
|
} elseif ($annotation instanceof Context) {
|
|
if (!$accessorOrMutator) {
|
|
throw new MappingException(sprintf('Context on "%s::%s()" cannot be added. Context can only be added on methods beginning with "get", "is", "has" or "set".', $className, $method->name));
|
|
}
|
|
|
|
$this->setAttributeContextsForGroups($annotation, $attributeMetadata);
|
|
}
|
|
|
|
$loaded = true;
|
|
}
|
|
}
|
|
|
|
return $loaded;
|
|
}
|
|
|
|
/**
|
|
* @param \ReflectionClass|\ReflectionMethod|\ReflectionProperty $reflector
|
|
*/
|
|
public function loadAnnotations(object $reflector): iterable
|
|
{
|
|
foreach ($reflector->getAttributes() as $attribute) {
|
|
if ($this->isKnownAttribute($attribute->getName())) {
|
|
try {
|
|
yield $attribute->newInstance();
|
|
} catch (\Error $e) {
|
|
if (\Error::class !== $e::class) {
|
|
throw $e;
|
|
}
|
|
$on = match (true) {
|
|
$reflector instanceof \ReflectionClass => ' on class '.$reflector->name,
|
|
$reflector instanceof \ReflectionMethod => sprintf(' on "%s::%s()"', $reflector->getDeclaringClass()->name, $reflector->name),
|
|
$reflector instanceof \ReflectionProperty => sprintf(' on "%s::$%s"', $reflector->getDeclaringClass()->name, $reflector->name),
|
|
default => '',
|
|
};
|
|
|
|
throw new MappingException(sprintf('Could not instantiate attribute "%s"%s.', $attribute->getName(), $on), 0, $e);
|
|
}
|
|
}
|
|
}
|
|
|
|
if (null === $this->reader) {
|
|
return;
|
|
}
|
|
|
|
if ($reflector instanceof \ReflectionClass) {
|
|
yield from $this->reader->getClassAnnotations($reflector);
|
|
}
|
|
if ($reflector instanceof \ReflectionMethod) {
|
|
yield from $this->reader->getMethodAnnotations($reflector);
|
|
}
|
|
if ($reflector instanceof \ReflectionProperty) {
|
|
yield from $this->reader->getPropertyAnnotations($reflector);
|
|
}
|
|
}
|
|
|
|
private function setAttributeContextsForGroups(Context $annotation, AttributeMetadataInterface $attributeMetadata): void
|
|
{
|
|
if ($annotation->getContext()) {
|
|
$attributeMetadata->setNormalizationContextForGroups($annotation->getContext(), $annotation->getGroups());
|
|
$attributeMetadata->setDenormalizationContextForGroups($annotation->getContext(), $annotation->getGroups());
|
|
}
|
|
|
|
if ($annotation->getNormalizationContext()) {
|
|
$attributeMetadata->setNormalizationContextForGroups($annotation->getNormalizationContext(), $annotation->getGroups());
|
|
}
|
|
|
|
if ($annotation->getDenormalizationContext()) {
|
|
$attributeMetadata->setDenormalizationContextForGroups($annotation->getDenormalizationContext(), $annotation->getGroups());
|
|
}
|
|
}
|
|
|
|
private function isKnownAttribute(string $attributeName): bool
|
|
{
|
|
foreach (self::KNOWN_ANNOTATIONS as $knownAnnotation) {
|
|
if (is_a($attributeName, $knownAnnotation, true)) {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
}
|