#24228

pending completion

Build # #24228

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/c51089f931ec63d9092c1b315995ea3e6ebeb683">c51089f93<a href="https://github.com/api-platform/core/commit/c51089f931ec63d9092c1b315995ea3e6ebeb683">">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/c0e5a37eafcc4b4f620709b3f4147313236fdfce">c0e5a37ea</a>">c0e5a37ea</a><a href="https://github.com/api-platform/core/commit/c51089f931ec63d9092c1b315995ea3e6ebeb683"> into bc52cac33">bc52cac33</a>

Run Details

6 of 6 new or added lines in 4 files covered. (100.0%)

8721 of 9598 relevant lines covered (90.86%)

16.48 hits per line

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

56.52

/src/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\Serializer;

use ApiPlatform\Core\Api\IriConverterInterface;
use ApiPlatform\Core\Api\ResourceClassResolverInterface;
use ApiPlatform\Core\DataProvider\ItemDataProviderInterface;
use ApiPlatform\Core\Exception\InvalidArgumentException;
use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
use Symfony\Component\Serializer\Exception\NotNormalizableValueException;
use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface;
use Symfony\Component\Serializer\NameConverter\NameConverterInterface;

/**
 * Generic item normalizer.
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 */
class ItemNormalizer extends AbstractItemNormalizer
{
    private $logger;

    public function __construct(PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, IriConverterInterface $iriConverter, ResourceClassResolverInterface $resourceClassResolver, PropertyAccessorInterface $propertyAccessor = null, NameConverterInterface $nameConverter = null, ClassMetadataFactoryInterface $classMetadataFactory = null, ItemDataProviderInterface $itemDataProvider = null, bool $allowPlainIdentifiers = false, LoggerInterface $logger = null, iterable $dataTransformers = [], ResourceMetadataFactoryInterface $resourceMetadataFactory = null)
    {
        parent::__construct($propertyNameCollectionFactory, $propertyMetadataFactory, $iriConverter, $resourceClassResolver, $propertyAccessor, $nameConverter, $classMetadataFactory, $itemDataProvider, $allowPlainIdentifiers, [], $dataTransformers, $resourceMetadataFactory);

        $this->logger = $logger ?: new NullLogger();
    }

    /**
     * {@inheritdoc}
     *
     * @throws NotNormalizableValueException
     */
    public function denormalize($data, $class, $format = null, array $context = [])
    {
        // Avoid issues with proxies if we populated the object
        if (isset($data['id']) && !isset($context[self::OBJECT_TO_POPULATE])) {
            if (isset($context['api_allow_update']) && true !== $context['api_allow_update']) {
                throw new NotNormalizableValueException('Update is not allowed for this operation.');
            }

            if (isset($context['resource_class'])) {
                $this->updateObjectToPopulate($data, $context);
            } else {
                // See https://github.com/api-platform/core/pull/2326 to understand this message.
                $this->logger->warning('The "resource_class" key is missing from the context.', [
                    'context' => $context,
                ]);
            }
        }

        return parent::denormalize($data, $class, $format, $context);
    }

    private function updateObjectToPopulate(array $data, array &$context): void
    {
        try {
            $context[self::OBJECT_TO_POPULATE] = $this->iriConverter->getItemFromIri((string) $data['id'], $context + ['fetch_data' => true]);
        } catch (InvalidArgumentException $e) {
            $identifier = null;
            $options = $this->getFactoryOptions($context);

            foreach ($this->propertyNameCollectionFactory->create($context['resource_class'], $options) as $propertyName) {
                if (true === $this->propertyMetadataFactory->create($context['resource_class'], $propertyName)->isIdentifier()) {
                    $identifier = $propertyName;
                    break;
                }
            }

            if (null === $identifier) {
                throw $e;
            }

            $context[self::OBJECT_TO_POPULATE] = $this->iriConverter->getItemFromIri(sprintf('%s/%s', $this->iriConverter->getIriFromResourceClass($context['resource_class']), $data[$identifier]), $context + ['fetch_data' => true]);
        }
    }
}

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\Serializer;
15
16	use ApiPlatform\Core\Api\IriConverterInterface;
17	use ApiPlatform\Core\Api\ResourceClassResolverInterface;
18	use ApiPlatform\Core\DataProvider\ItemDataProviderInterface;
19	use ApiPlatform\Core\Exception\InvalidArgumentException;
20	use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
21	use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
22	use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
23	use Psr\Log\LoggerInterface;
24	use Psr\Log\NullLogger;
25	use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
26	use Symfony\Component\Serializer\Exception\NotNormalizableValueException;
27	use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface;
28	use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
29
30	/**
31	* Generic item normalizer.
32	*
33	* @author Kévin Dunglas <dunglas@gmail.com>
34	*/
35	class ItemNormalizer extends AbstractItemNormalizer
36	{
37	private $logger;
38
39	public function __construct(PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, IriConverterInterface $iriConverter, ResourceClassResolverInterface $resourceClassResolver, PropertyAccessorInterface $propertyAccessor = null, NameConverterInterface $nameConverter = null, ClassMetadataFactoryInterface $classMetadataFactory = null, ItemDataProviderInterface $itemDataProvider = null, bool $allowPlainIdentifiers = false, LoggerInterface $logger = null, iterable $dataTransformers = [], ResourceMetadataFactoryInterface $resourceMetadataFactory = null)
40	{
41	parent::__construct($propertyNameCollectionFactory, $propertyMetadataFactory, $iriConverter, $resourceClassResolver, $propertyAccessor, $nameConverter, $classMetadataFactory, $itemDataProvider, $allowPlainIdentifiers, [], $dataTransformers, $resourceMetadataFactory);	44✔
42
43	$this->logger = $logger ?: new NullLogger();	44✔
44	}	44✔
45
46	/**
47	* {@inheritdoc}
48	*
49	* @throws NotNormalizableValueException
50	*/
51	public function denormalize($data, $class, $format = null, array $context = [])
52	{
53	// Avoid issues with proxies if we populated the object
54	if (isset($data['id']) && !isset($context[self::OBJECT_TO_POPULATE])) {	8✔
55	if (isset($context['api_allow_update']) && true !== $context['api_allow_update']) {	3✔
56	throw new NotNormalizableValueException('Update is not allowed for this operation.');	1✔
57	}
58
59	if (isset($context['resource_class'])) {	2✔
60	$this->updateObjectToPopulate($data, $context);	1✔
61	} else {
62	// See https://github.com/api-platform/core/pull/2326 to understand this message.
63	$this->logger->warning('The "resource_class" key is missing from the context.', [	1✔
64	'context' => $context,	1✔
65	]);
66	}
67	}
68
69	return parent::denormalize($data, $class, $format, $context);	7✔
70	}
71
72	private function updateObjectToPopulate(array $data, array &$context): void
73	{
74	try {
75	$context[self::OBJECT_TO_POPULATE] = $this->iriConverter->getItemFromIri((string) $data['id'], $context + ['fetch_data' => true]);	1✔
76	} catch (InvalidArgumentException $e) {	×
77	$identifier = null;	×
78	$options = $this->getFactoryOptions($context);	×
79
80	foreach ($this->propertyNameCollectionFactory->create($context['resource_class'], $options) as $propertyName) {	×
81	if (true === $this->propertyMetadataFactory->create($context['resource_class'], $propertyName)->isIdentifier()) {	×
82	$identifier = $propertyName;	×
83	break;	×
84	}
85	}
86
87	if (null === $identifier) {	×
88	throw $e;	×
89	}
90
91	$context[self::OBJECT_TO_POPULATE] = $this->iriConverter->getItemFromIri(sprintf('%s/%s', $this->iriConverter->getIriFromResourceClass($context['resource_class']), $data[$identifier]), $context + ['fetch_data' => true]);	×
92	}
93	}	1✔
94	}

api-platform / core / #24228

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