class AttributeLoader
Same name in this branch
- 11.1.x vendor/symfony/validator/Mapping/Loader/AttributeLoader.php \Symfony\Component\Validator\Mapping\Loader\AttributeLoader
Loader for PHP attributes.
@author Kévin Dunglas <dunglas@gmail.com> @author Alexander M. Turek <me@derrabus.de> @author Alexandre Daubois <alex.daubois@gmail.com>
Hierarchy
- class \Symfony\Component\Serializer\Mapping\Loader\AttributeLoader implements \Symfony\Component\Serializer\Mapping\Loader\LoaderInterface
Expanded class hierarchy of AttributeLoader
File
-
vendor/
symfony/ serializer/ Mapping/ Loader/ AttributeLoader.php, line 34
Namespace
Symfony\Component\Serializer\Mapping\LoaderView source
class AttributeLoader implements LoaderInterface {
private const KNOWN_ATTRIBUTES = [
DiscriminatorMap::class,
Groups::class,
Ignore::class,
MaxDepth::class,
SerializedName::class,
SerializedPath::class,
Context::class,
];
public function __construct() {
}
public function loadClassMetadata(ClassMetadataInterface $classMetadata) : bool {
$reflectionClass = $classMetadata->getReflectionClass();
$className = $reflectionClass->name;
$loaded = false;
$classGroups = [];
$classContextAttribute = null;
$attributesMetadata = $classMetadata->getAttributesMetadata();
foreach ($this->loadAttributes($reflectionClass) as $attribute) {
match (true) { $attribute instanceof DiscriminatorMap => $classMetadata->setClassDiscriminatorMapping(new ClassDiscriminatorMapping($attribute->getTypeProperty(), $attribute->getMapping())),
$attribute instanceof Groups => $classGroups = $attribute->getGroups(),
$attribute instanceof Context => $classContextAttribute = $attribute,
default => null,
};
}
foreach ($reflectionClass->getProperties() as $property) {
if (!isset($attributesMetadata[$property->name])) {
$attributesMetadata[$property->name] = new AttributeMetadata($property->name);
$classMetadata->addAttributeMetadata($attributesMetadata[$property->name]);
}
$attributeMetadata = $attributesMetadata[$property->name];
if ($property->getDeclaringClass()->name === $className) {
if ($classContextAttribute) {
$this->setAttributeContextsForGroups($classContextAttribute, $attributeMetadata);
}
foreach ($classGroups as $group) {
$attributeMetadata->addGroup($group);
}
foreach ($this->loadAttributes($property) as $attribute) {
$loaded = true;
if ($attribute instanceof Groups) {
foreach ($attribute->getGroups() as $group) {
$attributeMetadata->addGroup($group);
}
continue;
}
match (true) { $attribute instanceof MaxDepth => $attributeMetadata->setMaxDepth($attribute->getMaxDepth()),
$attribute instanceof SerializedName => $attributeMetadata->setSerializedName($attribute->getSerializedName()),
$attribute instanceof SerializedPath => $attributeMetadata->setSerializedPath($attribute->getSerializedPath()),
$attribute instanceof Ignore => $attributeMetadata->setIgnore(true),
$attribute instanceof Context => $this->setAttributeContextsForGroups($attribute, $attributeMetadata),
default => null,
};
}
}
}
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 && !ctype_lower($matches[2][0])) {
$attributeName = lcfirst($matches[2]);
if (isset($attributesMetadata[$attributeName])) {
$attributeMetadata = $attributesMetadata[$attributeName];
}
else {
$attributesMetadata[$attributeName] = $attributeMetadata = new AttributeMetadata($attributeName);
$classMetadata->addAttributeMetadata($attributeMetadata);
}
}
foreach ($this->loadAttributes($method) as $attribute) {
if ($attribute 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 ($attribute->getGroups() as $group) {
$attributeMetadata->addGroup($group);
}
}
elseif ($attribute 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($attribute->getMaxDepth());
}
elseif ($attribute 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($attribute->getSerializedName());
}
elseif ($attribute 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($attribute->getSerializedPath());
}
elseif ($attribute instanceof Ignore) {
if ($accessorOrMutator) {
$attributeMetadata->setIgnore(true);
}
}
elseif ($attribute 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($attribute, $attributeMetadata);
}
$loaded = true;
}
}
return $loaded;
}
private function loadAttributes(\ReflectionMethod|\ReflectionClass|\ReflectionProperty $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);
}
}
}
}
private function setAttributeContextsForGroups(Context $attribute, AttributeMetadataInterface $attributeMetadata) : void {
$context = $attribute->getContext();
$groups = $attribute->getGroups();
$normalizationContext = $attribute->getNormalizationContext();
$denormalizationContext = $attribute->getDenormalizationContext();
if ($normalizationContext || $context) {
$attributeMetadata->setNormalizationContextForGroups($normalizationContext ?: $context, $groups);
}
if ($denormalizationContext || $context) {
$attributeMetadata->setDenormalizationContextForGroups($denormalizationContext ?: $context, $groups);
}
}
private function isKnownAttribute(string $attributeName) : bool {
foreach (self::KNOWN_ATTRIBUTES as $knownAttribute) {
if (is_a($attributeName, $knownAttribute, true)) {
return true;
}
}
return false;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
AttributeLoader::isKnownAttribute | private | function | ||
AttributeLoader::KNOWN_ATTRIBUTES | private | constant | ||
AttributeLoader::loadAttributes | private | function | ||
AttributeLoader::loadClassMetadata | public | function | Overrides LoaderInterface::loadClassMetadata | |
AttributeLoader::setAttributeContextsForGroups | private | function | ||
AttributeLoader::__construct | public | function |