#27667

pending completion

Build # #27667

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/5bb51c11f23545d5a50c2cbcf448ead95448c23d">5bb51c11f<a href="https://github.com/api-platform/core/commit/5bb51c11f23545d5a50c2cbcf448ead95448c23d">">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/934a2cf743faa29e5e562a9f3907391b7bbba2aa">934a2cf74</a>">934a2cf74</a><a href="https://github.com/api-platform/core/commit/5bb51c11f23545d5a50c2cbcf448ead95448c23d"> into 5e2eb4d11">5e2eb4d11</a>

Run Details

219 of 219 new or added lines in 29 files covered. (100.0%)

13217 of 16018 relevant lines covered (82.51%)

14.84 hits per line

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

80.0

/src/Core/JsonApi/Serializer/EntrypointNormalizer.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\JsonApi\Serializer;

use ApiPlatform\Api\IriConverterInterface;
use ApiPlatform\Core\Api\Entrypoint;
use ApiPlatform\Core\Api\IriConverterInterface as LegacyIriConverterInterface;
use ApiPlatform\Core\Api\UrlGeneratorInterface;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
use ApiPlatform\Exception\InvalidArgumentException;
use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;

/**
 * Normalizes the API entrypoint.
 *
 * @author Amrouche Hamza <hamza.simperfit@gmail.com>
 * @author Kévin Dunglas <dunglas@gmail.com>
 */
final class EntrypointNormalizer implements NormalizerInterface, CacheableSupportsMethodInterface
{
    public const FORMAT = 'jsonapi';

    private $resourceMetadataFactory;
    private $iriConverter;
    private $urlGenerator;

    public function __construct($resourceMetadataFactory, $iriConverter, UrlGeneratorInterface $urlGenerator)
    {
        $this->resourceMetadataFactory = $resourceMetadataFactory;
        $this->iriConverter = $iriConverter;
        $this->urlGenerator = $urlGenerator;

        if ($iriConverter instanceof LegacyIriConverterInterface) {
            trigger_deprecation('api-platform/core', '2.7', sprintf('Use an implementation of "%s" instead of "%s".', IriConverterInterface::class, LegacyIriConverterInterface::class));
        }

        if (!$resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
            trigger_deprecation('api-platform/core', '2.7', sprintf('Use "%s" instead of "%s".', ResourceMetadataCollectionFactoryInterface::class, ResourceMetadataFactoryInterface::class));
        }
    }

    /**
     * {@inheritdoc}
     */
    public function normalize($object, $format = null, array $context = [])
    {
        $entrypoint = ['links' => ['self' => $this->urlGenerator->generate('api_entrypoint', [], UrlGeneratorInterface::ABS_URL)]];

        foreach ($object->getResourceNameCollection() as $resourceClass) {
            /** @var ResourceMetadata|ResourceMetadataCollection */
            $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);

            if ($resourceMetadata instanceof ResourceMetadata) {
                if (!$resourceMetadata->getCollectionOperations()) {
                    continue;
                }

                try {
                    $entrypoint['links'][lcfirst($resourceMetadata->getShortName())] = $this->iriConverter->getIriFromResourceClass($resourceClass, UrlGeneratorInterface::ABS_URL);
                } catch (InvalidArgumentException $ex) {
                    // Ignore resources without GET operations
                }
            }

            foreach ($resourceMetadata as $resource) {
                foreach ($resource->getOperations() as $operationName => $operation) {
                    if (!$operation->isCollection() || $operation->getUriVariables()) {
                        continue;
                    }

                    try {
                        $entrypoint['links'][lcfirst($resource->getShortName())] = $this->iriConverter instanceof IriConverterInterface ? $this->iriConverter->getIriFromResourceClass($resourceClass, $operationName, UrlGeneratorInterface::ABS_URL) : $this->iriConverter->getIriFromResourceClass($resourceClass, UrlGeneratorInterface::ABS_URL);
                    } catch (InvalidArgumentException $ex) {
                        // Ignore resources without GET operations
                    }
                }
            }
        }

        return $entrypoint;
    }

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

    /**
     * {@inheritdoc}
     */
    public function hasCacheableSupportsMethod(): bool
    {
        return 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\JsonApi\Serializer;
15
16	use ApiPlatform\Api\IriConverterInterface;
17	use ApiPlatform\Core\Api\Entrypoint;
18	use ApiPlatform\Core\Api\IriConverterInterface as LegacyIriConverterInterface;
19	use ApiPlatform\Core\Api\UrlGeneratorInterface;
20	use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
21	use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
22	use ApiPlatform\Exception\InvalidArgumentException;
23	use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
24	use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
25	use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
26	use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
27
28	/**
29	* Normalizes the API entrypoint.
30	*
31	* @author Amrouche Hamza <hamza.simperfit@gmail.com>
32	* @author Kévin Dunglas <dunglas@gmail.com>
33	*/
34	final class EntrypointNormalizer implements NormalizerInterface, CacheableSupportsMethodInterface
35	{
36	public const FORMAT = 'jsonapi';
37
38	private $resourceMetadataFactory;
39	private $iriConverter;
40	private $urlGenerator;
41
42	public function __construct($resourceMetadataFactory, $iriConverter, UrlGeneratorInterface $urlGenerator)
43	{
44	$this->resourceMetadataFactory = $resourceMetadataFactory;	33✔
45	$this->iriConverter = $iriConverter;	33✔
46	$this->urlGenerator = $urlGenerator;	33✔
47
48	if ($iriConverter instanceof LegacyIriConverterInterface) {	33✔
49	trigger_deprecation('api-platform/core', '2.7', sprintf('Use an implementation of "%s" instead of "%s".', IriConverterInterface::class, LegacyIriConverterInterface::class));	2✔
50	}
51
52	if (!$resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {	33✔
53	trigger_deprecation('api-platform/core', '2.7', sprintf('Use "%s" instead of "%s".', ResourceMetadataCollectionFactoryInterface::class, ResourceMetadataFactoryInterface::class));	2✔
54	}
55	}	33✔
56
57	/**
58	* {@inheritdoc}
59	*/
60	public function normalize($object, $format = null, array $context = [])
61	{
62	$entrypoint = ['links' => ['self' => $this->urlGenerator->generate('api_entrypoint', [], UrlGeneratorInterface::ABS_URL)]];	1✔
63
64	foreach ($object->getResourceNameCollection() as $resourceClass) {	1✔
65	/** @var ResourceMetadata\|ResourceMetadataCollection */
66	$resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);	1✔
67
68	if ($resourceMetadata instanceof ResourceMetadata) {	1✔
69	if (!$resourceMetadata->getCollectionOperations()) {	1✔
70	continue;	1✔
71	}
72
73	try {
74	$entrypoint['links'][lcfirst($resourceMetadata->getShortName())] = $this->iriConverter->getIriFromResourceClass($resourceClass, UrlGeneratorInterface::ABS_URL);	1✔
75	} catch (InvalidArgumentException $ex) {	1✔
76	// Ignore resources without GET operations
77	}
78	}
79
80	foreach ($resourceMetadata as $resource) {	1✔
81	foreach ($resource->getOperations() as $operationName => $operation) {	×
82	if (!$operation->isCollection() \|\| $operation->getUriVariables()) {	×
83	continue;	×
84	}
85
86	try {
87	$entrypoint['links'][lcfirst($resource->getShortName())] = $this->iriConverter instanceof IriConverterInterface ? $this->iriConverter->getIriFromResourceClass($resourceClass, $operationName, UrlGeneratorInterface::ABS_URL) : $this->iriConverter->getIriFromResourceClass($resourceClass, UrlGeneratorInterface::ABS_URL);	×
88	} catch (InvalidArgumentException $ex) {	×
89	// Ignore resources without GET operations
90	}
91	}
92	}
93	}
94
95	return $entrypoint;	1✔
96	}
97
98	/**
99	* {@inheritdoc}
100	*/
101	public function supportsNormalization($data, $format = null)
102	{
103	return self::FORMAT === $format && $data instanceof Entrypoint;	25✔
104	}
105
106	/**
107	* {@inheritdoc}
108	*/
109	public function hasCacheableSupportsMethod(): bool
110	{
111	return true;	25✔
112	}
113	}

api-platform / core / #27667

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