#25492

pending completion

Build # #25492

Build Type

push

github

Committed by

web-flow

Commit Message

<a href="https://github.com/api-platform/core/commit/<a class=hub.com/api-platform/core/commit/456c5e50e5250643779b307b2e221f0ed7146d24">456c5e50e<a href="https://github.com/api-platform/core/commit/456c5e50e5250643779b307b2e221f0ed7146d24">">Merge </a><a class="double-link" href="https://github.com/api-platform/core/commit/<a class="double-link" href="https://github.com/api-platform/core/commit/e7abe5ac51cc33369d9537c0d4d22c4be618e50e">e7abe5ac5</a>">e7abe5ac5</a><a href="https://github.com/api-platform/core/commit/456c5e50e5250643779b307b2e221f0ed7146d24"> into d83d50228">d83d50228</a>

Run Details

67 of 67 new or added lines in 10 files covered. (100.0%)

8654 of 10201 relevant lines covered (84.83%)

15.07 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

86.36

/src/Hal/Serializer/ItemNormalizer.php

<?php

/*
 * This file is part of the API Platform project.
 *
 * (c) Kévin Dunglas <dunglas@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace ApiPlatform\Core\Hal\Serializer;

use ApiPlatform\Core\Serializer\AbstractItemNormalizer;
use ApiPlatform\Core\Serializer\CacheKeyTrait;
use ApiPlatform\Core\Serializer\ContextTrait;
use ApiPlatform\Core\Util\ClassInfoTrait;
use Symfony\Component\Serializer\Exception\LogicException;
use Symfony\Component\Serializer\Exception\UnexpectedValueException;
use Symfony\Component\Serializer\Mapping\AttributeMetadataInterface;

/**
 * Converts between objects and array including HAL metadata.
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 */
final class ItemNormalizer extends AbstractItemNormalizer
{
    use CacheKeyTrait;
    use ClassInfoTrait;
    use ContextTrait;

    public const FORMAT = 'jsonhal';

    private $componentsCache = [];
    private $attributesMetadataCache = [];

    /**
     * {@inheritdoc}
     */
    public function supportsNormalization($data, $format = null): bool
    {
        return self::FORMAT === $format && parent::supportsNormalization($data, $format);
    }

    /**
     * {@inheritdoc}
     */
    public function normalize($object, $format = null, array $context = [])
    {
        if (null !== $this->getOutputClass($this->getObjectClass($object), $context)) {
            return parent::normalize($object, $format, $context);
        }

        if (!isset($context['cache_key'])) {
            $context['cache_key'] = $this->getCacheKey($format, $context);
        }

        $resourceClass = $this->resourceClassResolver->getResourceClass($object, $context['resource_class'] ?? null);
        $context = $this->initContext($resourceClass, $context);
        $iri = $this->iriConverter->getIriFromItem($object);
        $context['iri'] = $iri;
        $context['api_normalize'] = true;

        $data = parent::normalize($object, $format, $context);
        if (!\is_array($data)) {
            return $data;
        }

        $metadata = [
            '_links' => [
                'self' => [
                    'href' => $iri,
                ],
            ],
        ];
        $components = $this->getComponents($object, $format, $context);
        $metadata = $this->populateRelation($metadata, $object, $format, $context, $components, 'links');
        $metadata = $this->populateRelation($metadata, $object, $format, $context, $components, 'embedded');

        return $metadata + $data;
    }

    /**
     * {@inheritdoc}
     */
    public function supportsDenormalization($data, $type, $format = null): bool
    {
        // prevent the use of lower priority normalizers (e.g. serializer.normalizer.object) for this format
        return self::FORMAT === $format;
    }

    /**
     * {@inheritdoc}
     *
     * @throws LogicException
     */
    public function denormalize($data, $class, $format = null, array $context = [])
    {
        throw new LogicException(sprintf('%s is a read-only format.', self::FORMAT));
    }

    /**
     * {@inheritdoc}
     */
    protected function getAttributes($object, $format = null, array $context): array
    {
        return $this->getComponents($object, $format, $context)['states'];
    }

    /**
     * Gets HAL components of the resource: states, links and embedded.
     *
     * @param object $object
     */
    private function getComponents($object, ?string $format, array $context): array
    {
        $cacheKey = $this->getObjectClass($object).'-'.$context['cache_key'];

        if (isset($this->componentsCache[$cacheKey])) {
            return $this->componentsCache[$cacheKey];
        }

        $attributes = parent::getAttributes($object, $format, $context);
        $options = $this->getFactoryOptions($context);

        $components = [
            'states' => [],
            'links' => [],
            'embedded' => [],
        ];

        foreach ($attributes as $attribute) {
            $propertyMetadata = $this->propertyMetadataFactory->create($context['resource_class'], $attribute, $options);

            $type = $propertyMetadata->getType();
            $isOne = $isMany = false;

            if (null !== $type) {
                if ($type->isCollection()) {
                    $valueType = $type->getCollectionValueType();
                    $isMany = null !== $valueType && ($className = $valueType->getClassName()) && $this->resourceClassResolver->isResourceClass($className);
                } else {
                    $className = $type->getClassName();
                    $isOne = $className && $this->resourceClassResolver->isResourceClass($className);
                }
            }

            if (!$isOne && !$isMany) {
                $components['states'][] = $attribute;
                continue;
            }

            $relation = ['name' => $attribute, 'cardinality' => $isOne ? 'one' : 'many'];
            if ($propertyMetadata->isReadableLink()) {
                $components['embedded'][] = $relation;
            }

            $components['links'][] = $relation;
        }

        if (false !== $context['cache_key']) {
            $this->componentsCache[$cacheKey] = $components;
        }

        return $components;
    }

    /**
     * Populates _links and _embedded keys.
     *
     * @param object $object
     */
    private function populateRelation(array $data, $object, ?string $format, array $context, array $components, string $type): array
    {
        $class = $this->getObjectClass($object);

        $attributesMetadata = \array_key_exists($class, $this->attributesMetadataCache) ?
            $this->attributesMetadataCache[$class] :
            $this->attributesMetadataCache[$class] = $this->classMetadataFactory ? $this->classMetadataFactory->getMetadataFor($class)->getAttributesMetadata() : null;

        $key = '_'.$type;
        foreach ($components[$type] as $relation) {
            if (null !== $attributesMetadata && $this->isMaxDepthReached($attributesMetadata, $class, $relation['name'], $context)) {
                continue;
            }

            $attributeValue = $this->getAttributeValue($object, $relation['name'], $format, $context);
            if (empty($attributeValue)) {
                continue;
            }

            $relationName = $relation['name'];
            if ($this->nameConverter) {
                $relationName = $this->nameConverter->normalize($relationName, $class, $format, $context);
            }

            if ('one' === $relation['cardinality']) {
                if ('links' === $type) {
                    $data[$key][$relationName]['href'] = $this->getRelationIri($attributeValue);
                    continue;
                }

                $data[$key][$relationName] = $attributeValue;
                continue;
            }

            // many
            $data[$key][$relationName] = [];
            foreach ($attributeValue as $rel) {
                if ('links' === $type) {
                    $rel = ['href' => $this->getRelationIri($rel)];
                }

                $data[$key][$relationName][] = $rel;
            }
        }

        return $data;
    }

    /**
     * Gets the IRI of the given relation.
     *
     * @throws UnexpectedValueException
     */
    private function getRelationIri($rel): string
    {
        if (!(\is_array($rel) || \is_string($rel))) {
            throw new UnexpectedValueException('Expected relation to be an IRI or array');
        }

        return \is_string($rel) ? $rel : $rel['_links']['self']['href'];
    }

    /**
     * Is the max depth reached for the given attribute?
     *
     * @param AttributeMetadataInterface[] $attributesMetadata
     */
    private function isMaxDepthReached(array $attributesMetadata, string $class, string $attribute, array &$context): bool
    {
        if (
            !($context[self::ENABLE_MAX_DEPTH] ?? false) ||
            !isset($attributesMetadata[$attribute]) ||
            null === $maxDepth = $attributesMetadata[$attribute]->getMaxDepth()
        ) {
            return false;
        }

        $key = sprintf(self::DEPTH_KEY_PATTERN, $class, $attribute);
        if (!isset($context[$key])) {
            $context[$key] = 1;

            return false;
        }

        if ($context[$key] === $maxDepth) {
            return true;
        }

        ++$context[$key];

        return false;
    }
}

1	<?php
2
3	/*
4	* This file is part of the API Platform project.
5	*
6	* (c) Kévin Dunglas <dunglas@gmail.com>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11
12	declare(strict_types=1);
13
14	namespace ApiPlatform\Core\Hal\Serializer;
15
16	use ApiPlatform\Core\Serializer\AbstractItemNormalizer;
17	use ApiPlatform\Core\Serializer\CacheKeyTrait;
18	use ApiPlatform\Core\Serializer\ContextTrait;
19	use ApiPlatform\Core\Util\ClassInfoTrait;
20	use Symfony\Component\Serializer\Exception\LogicException;
21	use Symfony\Component\Serializer\Exception\UnexpectedValueException;
22	use Symfony\Component\Serializer\Mapping\AttributeMetadataInterface;
23
24	/**
25	* Converts between objects and array including HAL metadata.
26	*
27	* @author Kévin Dunglas <dunglas@gmail.com>
28	*/
29	final class ItemNormalizer extends AbstractItemNormalizer
30	{
31	use CacheKeyTrait;
32	use ClassInfoTrait;
33	use ContextTrait;
34
35	public const FORMAT = 'jsonhal';
36
37	private $componentsCache = [];
38	private $attributesMetadataCache = [];
39
40	/**
41	* {@inheritdoc}
42	*/
43	public function supportsNormalization($data, $format = null): bool
44	{
45	return self::FORMAT === $format && parent::supportsNormalization($data, $format);	22✔
46	}
47
48	/**
49	* {@inheritdoc}
50	*/
51	public function normalize($object, $format = null, array $context = [])
52	{
53	if (null !== $this->getOutputClass($this->getObjectClass($object), $context)) {	3✔
54	return parent::normalize($object, $format, $context);	×
55	}
56
57	if (!isset($context['cache_key'])) {	3✔
58	$context['cache_key'] = $this->getCacheKey($format, $context);	3✔
59	}
60
61	$resourceClass = $this->resourceClassResolver->getResourceClass($object, $context['resource_class'] ?? null);	3✔
62	$context = $this->initContext($resourceClass, $context);	3✔
63	$iri = $this->iriConverter->getIriFromItem($object);	3✔
64	$context['iri'] = $iri;	3✔
65	$context['api_normalize'] = true;	3✔
66
67	$data = parent::normalize($object, $format, $context);	3✔
68	if (!\is_array($data)) {	3✔
69	return $data;	×
70	}
71
72	$metadata = [
73	'_links' => [
74	'self' => [
75	'href' => $iri,	3✔
76	],
77	],
78	];
79	$components = $this->getComponents($object, $format, $context);	3✔
80	$metadata = $this->populateRelation($metadata, $object, $format, $context, $components, 'links');	3✔
81	$metadata = $this->populateRelation($metadata, $object, $format, $context, $components, 'embedded');	3✔
82
83	return $metadata + $data;	3✔
84	}
85
86	/**
87	* {@inheritdoc}
88	*/
89	public function supportsDenormalization($data, $type, $format = null): bool
90	{
91	// prevent the use of lower priority normalizers (e.g. serializer.normalizer.object) for this format
92	return self::FORMAT === $format;	4✔
93	}
94
95	/**
96	* {@inheritdoc}
97	*
98	* @throws LogicException
99	*/
100	public function denormalize($data, $class, $format = null, array $context = [])
101	{
102	throw new LogicException(sprintf('%s is a read-only format.', self::FORMAT));	1✔
103	}
104
105	/**
106	* {@inheritdoc}
107	*/
108	protected function getAttributes($object, $format = null, array $context): array
109	{
110	return $this->getComponents($object, $format, $context)['states'];	3✔
111	}
112
113	/**
114	* Gets HAL components of the resource: states, links and embedded.
115	*
116	* @param object $object
117	*/
118	private function getComponents($object, ?string $format, array $context): array
119	{
120	$cacheKey = $this->getObjectClass($object).'-'.$context['cache_key'];	3✔
121
122	if (isset($this->componentsCache[$cacheKey])) {	3✔
123	return $this->componentsCache[$cacheKey];	2✔
124	}
125
126	$attributes = parent::getAttributes($object, $format, $context);	3✔
127	$options = $this->getFactoryOptions($context);	3✔
128
129	$components = [
130	'states' => [],	3✔
131	'links' => [],
132	'embedded' => [],
133	];
134
135	foreach ($attributes as $attribute) {	3✔
136	$propertyMetadata = $this->propertyMetadataFactory->create($context['resource_class'], $attribute, $options);	3✔
137
138	$type = $propertyMetadata->getType();	3✔
139	$isOne = $isMany = false;	3✔
140
141	if (null !== $type) {	3✔
142	if ($type->isCollection()) {	3✔
143	$valueType = $type->getCollectionValueType();	×
144	$isMany = null !== $valueType && ($className = $valueType->getClassName()) && $this->resourceClassResolver->isResourceClass($className);	×
145	} else {
146	$className = $type->getClassName();	3✔
147	$isOne = $className && $this->resourceClassResolver->isResourceClass($className);	3✔
148	}
149	}
150
151	if (!$isOne && !$isMany) {	3✔
152	$components['states'][] = $attribute;	3✔
153	continue;	3✔
154	}
155
156	$relation = ['name' => $attribute, 'cardinality' => $isOne ? 'one' : 'many'];	3✔
157	if ($propertyMetadata->isReadableLink()) {	3✔
158	$components['embedded'][] = $relation;	1✔
159	}
160
161	$components['links'][] = $relation;	3✔
162	}
163
164	if (false !== $context['cache_key']) {	3✔
165	$this->componentsCache[$cacheKey] = $components;	2✔
166	}
167
168	return $components;	3✔
169	}
170
171	/**
172	* Populates _links and _embedded keys.
173	*
174	* @param object $object
175	*/
176	private function populateRelation(array $data, $object, ?string $format, array $context, array $components, string $type): array
177	{
178	$class = $this->getObjectClass($object);	3✔
179
180	$attributesMetadata = \array_key_exists($class, $this->attributesMetadataCache) ?	3✔
181	$this->attributesMetadataCache[$class] :	3✔
182	$this->attributesMetadataCache[$class] = $this->classMetadataFactory ? $this->classMetadataFactory->getMetadataFor($class)->getAttributesMetadata() : null;	3✔
183
184	$key = '_'.$type;	3✔
185	foreach ($components[$type] as $relation) {	3✔
186	if (null !== $attributesMetadata && $this->isMaxDepthReached($attributesMetadata, $class, $relation['name'], $context)) {	3✔
187	continue;	1✔
188	}
189
190	$attributeValue = $this->getAttributeValue($object, $relation['name'], $format, $context);	3✔
191	if (empty($attributeValue)) {	3✔
192	continue;	1✔
193	}
194
195	$relationName = $relation['name'];	3✔
196	if ($this->nameConverter) {	3✔
197	$relationName = $this->nameConverter->normalize($relationName, $class, $format, $context);	2✔
198	}
199
200	if ('one' === $relation['cardinality']) {	3✔
201	if ('links' === $type) {	3✔
202	$data[$key][$relationName]['href'] = $this->getRelationIri($attributeValue);	3✔
203	continue;	3✔
204	}
205
206	$data[$key][$relationName] = $attributeValue;	1✔
207	continue;	1✔
208	}
209
210	// many
211	$data[$key][$relationName] = [];	×
212	foreach ($attributeValue as $rel) {	×
213	if ('links' === $type) {	×
214	$rel = ['href' => $this->getRelationIri($rel)];	×
215	}
216
217	$data[$key][$relationName][] = $rel;	×
218	}
219	}
220
221	return $data;	3✔
222	}
223
224	/**
225	* Gets the IRI of the given relation.
226	*
227	* @throws UnexpectedValueException
228	*/
229	private function getRelationIri($rel): string
230	{
231	if (!(\is_array($rel) \|\| \is_string($rel))) {	3✔
232	throw new UnexpectedValueException('Expected relation to be an IRI or array');	×
233	}
234
235	return \is_string($rel) ? $rel : $rel['_links']['self']['href'];	3✔
236	}
237
238	/**
239	* Is the max depth reached for the given attribute?
240	*
241	* @param AttributeMetadataInterface[] $attributesMetadata
242	*/
243	private function isMaxDepthReached(array $attributesMetadata, string $class, string $attribute, array &$context): bool
244	{
245	if (
246	!($context[self::ENABLE_MAX_DEPTH] ?? false) \|\|	1✔
247	!isset($attributesMetadata[$attribute]) \|\|	1✔
248	null === $maxDepth = $attributesMetadata[$attribute]->getMaxDepth()	1✔
249	) {
250	return false;	1✔
251	}
252
253	$key = sprintf(self::DEPTH_KEY_PATTERN, $class, $attribute);	1✔
254	if (!isset($context[$key])) {	1✔
255	$context[$key] = 1;	1✔
256
257	return false;	1✔
258	}
259
260	if ($context[$key] === $maxDepth) {	1✔
261	return true;	1✔
262	}
263
264	++$context[$key];	×
265
266	return false;	×
267	}
268	}

api-platform / core / #25492

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous