#25150

pending completion

Build # #25150

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/f0989f763d63ae421f37c870408158659db5d7e4">f0989f763<a href="https://github.com/api-platform/core/commit/f0989f763d63ae421f37c870408158659db5d7e4">">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/3051d1ee31516c9ae78bb65d2f057c9260dd840b">3051d1ee3</a>">3051d1ee3</a><a href="https://github.com/api-platform/core/commit/f0989f763d63ae421f37c870408158659db5d7e4"> into f8ccee087">f8ccee087</a>

Run Details

8133 of 9630 relevant lines covered (84.45%)

14.83 hits per line

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

29.41

/src/Hal/Serializer/ObjectNormalizer.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\Api\IriConverterInterface;
use Symfony\Component\Serializer\Exception\LogicException;
use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;

/**
 * Decorates the output with JSON HAL metadata when appropriate, but otherwise
 * just passes through to the decorated normalizer.
 */
final class ObjectNormalizer implements NormalizerInterface, DenormalizerInterface, CacheableSupportsMethodInterface
{
    public const FORMAT = 'jsonhal';

    private $decorated;
    private $iriConverter;

    public function __construct(NormalizerInterface $decorated, IriConverterInterface $iriConverter)
    {
        $this->decorated = $decorated;
        $this->iriConverter = $iriConverter;
    }

    /**
     * {@inheritdoc}
     */
    public function supportsNormalization($data, $format = null, array $context = []): bool
    {
        return self::FORMAT === $format && $this->decorated->supportsNormalization($data, $format, $context);
    }

    /**
     * {@inheritdoc}
     */
    public function hasCacheableSupportsMethod(): bool
    {
        return $this->decorated instanceof CacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod();
    }

    /**
     * {@inheritdoc}
     */
    public function normalize($object, $format = null, array $context = [])
    {
        if (isset($context['api_resource'])) {
            $originalResource = $context['api_resource'];
            unset($context['api_resource']);
        }

        $data = $this->decorated->normalize($object, $format, $context);
        if (!\is_array($data)) {
            return $data;
        }

        if (!isset($originalResource)) {
            return $data;
        }

        $metadata = [
            '_links' => [
                'self' => [
                    'href' => $this->iriConverter->getIriFromItem($originalResource),
                ],
            ],
        ];

        return $metadata + $data;
    }

    /**
     * {@inheritdoc}
     */
    public function supportsDenormalization($data, $type, $format = null, array $context = []): 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));
    }
}

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\Api\IriConverterInterface;
17	use Symfony\Component\Serializer\Exception\LogicException;
18	use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
19	use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
20	use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
21
22	/**
23	* Decorates the output with JSON HAL metadata when appropriate, but otherwise
24	* just passes through to the decorated normalizer.
25	*/
26	final class ObjectNormalizer implements NormalizerInterface, DenormalizerInterface, CacheableSupportsMethodInterface
27	{
28	public const FORMAT = 'jsonhal';
29
30	private $decorated;
31	private $iriConverter;
32
33	public function __construct(NormalizerInterface $decorated, IriConverterInterface $iriConverter)
34	{
35	$this->decorated = $decorated;	34✔
36	$this->iriConverter = $iriConverter;	34✔
37	}	34✔
38
39	/**
40	* {@inheritdoc}
41	*/
42	public function supportsNormalization($data, $format = null, array $context = []): bool
43	{
44	return self::FORMAT === $format && $this->decorated->supportsNormalization($data, $format, $context);	14✔
45	}
46
47	/**
48	* {@inheritdoc}
49	*/
50	public function hasCacheableSupportsMethod(): bool
51	{
52	return $this->decorated instanceof CacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod();	14✔
53	}
54
55	/**
56	* {@inheritdoc}
57	*/
58	public function normalize($object, $format = null, array $context = [])
59	{
60	if (isset($context['api_resource'])) {	×
61	$originalResource = $context['api_resource'];	×
62	unset($context['api_resource']);	×
63	}
64
65	$data = $this->decorated->normalize($object, $format, $context);	×
66	if (!\is_array($data)) {	×
67	return $data;	×
68	}
69
70	if (!isset($originalResource)) {	×
71	return $data;	×
72	}
73
74	$metadata = [
75	'_links' => [
76	'self' => [
77	'href' => $this->iriConverter->getIriFromItem($originalResource),	×
78	],
79	],
80	];
81
82	return $metadata + $data;	×
83	}
84
85	/**
86	* {@inheritdoc}
87	*/
88	public function supportsDenormalization($data, $type, $format = null, array $context = []): bool
89	{
90	// prevent the use of lower priority normalizers (e.g. serializer.normalizer.object) for this format
91	return self::FORMAT === $format;	×
92	}
93
94	/**
95	* {@inheritdoc}
96	*
97	* @throws LogicException
98	*/
99	public function denormalize($data, $class, $format = null, array $context = [])
100	{
101	throw new LogicException(sprintf('%s is a read-only format.', self::FORMAT));	×
102	}
103	}

api-platform / core / #25150

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