#26560

pending completion

Build # #26560

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/0f5ebd2c17e7e891333412f10bdb050a780808a8">0f5ebd2c1<a href="https://github.com/api-platform/core/commit/0f5ebd2c17e7e891333412f10bdb050a780808a8">">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/045537be8d9746645e3b3fa5a007bf9fad784e44">045537be8</a>">045537be8</a><a href="https://github.com/api-platform/core/commit/0f5ebd2c17e7e891333412f10bdb050a780808a8"> into 39167de2b">39167de2b</a>

Run Details

8 of 8 new or added lines in 5 files covered. (100.0%)

9503 of 11450 relevant lines covered (83.0%)

14.89 hits per line

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

94.74

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

use ApiPlatform\Core\Api\IriConverterInterface;
use ApiPlatform\Core\Exception\InvalidArgumentException;
use ApiPlatform\Core\JsonLd\AnonymousContextBuilderInterface;
use ApiPlatform\Core\Metadata\Property\PropertyMetadata;
use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;

/**
 * Decorates the output with JSON-LD metadata when appropriate, but otherwise just
 * passes through to the decorated normalizer.
 */
final class ObjectNormalizer implements NormalizerInterface, CacheableSupportsMethodInterface
{
    use JsonLdContextTrait;

    public const FORMAT = 'jsonld';

    private $decorated;
    private $iriConverter;
    private $anonymousContextBuilder;

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

    /**
     * {@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']);
        }

        /*
         * Converts the normalized data array of a resource into an IRI, if the
         * normalized data array is empty.
         *
         * This is useful when traversing from a non-resource towards an attribute
         * which is a resource, as we do not have the benefit of {@see PropertyMetadata::isReadableLink}.
         *
         * It must not be propagated to subresources, as {@see PropertyMetadata::isReadableLink}
         * should take effect.
         */
        $context['api_empty_resource_as_iri'] = true;

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

        if (isset($originalResource)) {
            try {
                $context['output']['iri'] = $this->iriConverter->getIriFromItem($originalResource);
            } catch (InvalidArgumentException $e) {
                // The original resource has no identifiers
            }
            $context['api_resource'] = $originalResource;
        }

        $metadata = $this->createJsonLdContext($this->anonymousContextBuilder, $object, $context);

        return $metadata + $data;
    }
}

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\JsonLd\Serializer;
15
16	use ApiPlatform\Core\Api\IriConverterInterface;
17	use ApiPlatform\Core\Exception\InvalidArgumentException;
18	use ApiPlatform\Core\JsonLd\AnonymousContextBuilderInterface;
19	use ApiPlatform\Core\Metadata\Property\PropertyMetadata;
20	use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
21	use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
22
23	/**
24	* Decorates the output with JSON-LD metadata when appropriate, but otherwise just
25	* passes through to the decorated normalizer.
26	*/
27	final class ObjectNormalizer implements NormalizerInterface, CacheableSupportsMethodInterface
28	{
29	use JsonLdContextTrait;
30
31	public const FORMAT = 'jsonld';
32
33	private $decorated;
34	private $iriConverter;
35	private $anonymousContextBuilder;
36
37	public function __construct(NormalizerInterface $decorated, IriConverterInterface $iriConverter, AnonymousContextBuilderInterface $anonymousContextBuilder)
38	{
39	$this->decorated = $decorated;	34✔
40	$this->iriConverter = $iriConverter;	34✔
41	$this->anonymousContextBuilder = $anonymousContextBuilder;	34✔
42	}	34✔
43
44	/**
45	* {@inheritdoc}
46	*/
47	public function supportsNormalization($data, $format = null, array $context = []): bool
48	{
49	return self::FORMAT === $format && $this->decorated->supportsNormalization($data, $format, $context);	10✔
50	}
51
52	/**
53	* {@inheritdoc}
54	*/
55	public function hasCacheableSupportsMethod(): bool
56	{
57	return $this->decorated instanceof CacheableSupportsMethodInterface && $this->decorated->hasCacheableSupportsMethod();	10✔
58	}
59
60	/**
61	* {@inheritdoc}
62	*/
63	public function normalize($object, $format = null, array $context = [])
64	{
65	if (isset($context['api_resource'])) {	4✔
66	$originalResource = $context['api_resource'];	2✔
67	unset($context['api_resource']);	2✔
68	}
69
70	/*
71	* Converts the normalized data array of a resource into an IRI, if the
72	* normalized data array is empty.
73	*
74	* This is useful when traversing from a non-resource towards an attribute
75	* which is a resource, as we do not have the benefit of {@see PropertyMetadata::isReadableLink}.
76	*
77	* It must not be propagated to subresources, as {@see PropertyMetadata::isReadableLink}
78	* should take effect.
79	*/
80	$context['api_empty_resource_as_iri'] = true;	4✔
81
82	$data = $this->decorated->normalize($object, $format, $context);	4✔
83	if (!\is_array($data) \|\| !$data) {	4✔
84	return $data;	1✔
85	}
86
87	if (isset($originalResource)) {	3✔
88	try {
89	$context['output']['iri'] = $this->iriConverter->getIriFromItem($originalResource);	2✔
90	} catch (InvalidArgumentException $e) {	×
91	// The original resource has no identifiers
92	}
93	$context['api_resource'] = $originalResource;	2✔
94	}
95
96	$metadata = $this->createJsonLdContext($this->anonymousContextBuilder, $object, $context);	3✔
97
98	return $metadata + $data;	3✔
99	}
100	}

api-platform / core / #26560

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