#26138

pending completion

Build # #26138

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/79414378d1755badd23ecac1d92e3c26b90eba06">79414378d<a href="https://github.com/api-platform/core/commit/79414378d1755badd23ecac1d92e3c26b90eba06">">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/9775a97d81896dcfe328ba4fc64adb420986c291">9775a97d8</a>">9775a97d8</a><a href="https://github.com/api-platform/core/commit/79414378d1755badd23ecac1d92e3c26b90eba06"> into dd105c0fe">dd105c0fe</a>

Run Details

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

9364 of 11327 relevant lines covered (82.67%)

14.82 hits per line

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

96.88

/src/JsonApi/Serializer/CollectionNormalizer.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\Core\Api\ResourceClassResolverInterface;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use ApiPlatform\Core\Serializer\AbstractCollectionNormalizer;
use ApiPlatform\Core\Util\IriHelper;
use Symfony\Component\Serializer\Exception\UnexpectedValueException;

/**
 * Normalizes collections in the JSON API format.
 *
 * @author Kevin Dunglas <dunglas@gmail.com>
 * @author Hamza Amrouche <hamza@les-tilleuls.coop>
 * @author Baptiste Meyer <baptiste.meyer@gmail.com>
 */
final class CollectionNormalizer extends AbstractCollectionNormalizer
{
    public const FORMAT = 'jsonapi';

    public function __construct(ResourceClassResolverInterface $resourceClassResolver, string $pageParameterName, ResourceMetadataFactoryInterface $resourceMetadataFactory)
    {
        parent::__construct($resourceClassResolver, $pageParameterName, $resourceMetadataFactory);
    }

    /**
     * {@inheritdoc}
     */
    protected function getPaginationData($object, array $context = []): array
    {
        [$paginator, $paginated, $currentPage, $itemsPerPage, $lastPage, $pageTotalItems, $totalItems] = $this->getPaginationConfig($object, $context);
        $parsed = IriHelper::parseIri($context['uri'] ?? '/', $this->pageParameterName);

        $metadata = $this->resourceMetadataFactory->create($context['resource_class'] ?? '');
        $urlGenerationStrategy = $metadata->getAttribute('url_generation_strategy');

        $data = [
            'links' => [
                'self' => IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $paginated ? $currentPage : null, $urlGenerationStrategy),
            ],
        ];

        if ($paginated) {
            if (null !== $lastPage) {
                $data['links']['first'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, 1., $urlGenerationStrategy);
                $data['links']['last'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $lastPage, $urlGenerationStrategy);
            }

            if (1. !== $currentPage) {
                $data['links']['prev'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $currentPage - 1., $urlGenerationStrategy);
            }

            if (null !== $lastPage && $currentPage !== $lastPage || null === $lastPage && $pageTotalItems >= $itemsPerPage) {
                $data['links']['next'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $currentPage + 1., $urlGenerationStrategy);
            }
        }

        if (null !== $totalItems) {
            $data['meta']['totalItems'] = $totalItems;
        }

        if ($paginator) {
            $data['meta']['itemsPerPage'] = (int) $itemsPerPage;
            $data['meta']['currentPage'] = (int) $currentPage;
        }

        return $data;
    }

    /**
     * {@inheritdoc}
     *
     * @throws UnexpectedValueException
     */
    protected function getItemsData($object, string $format = null, array $context = []): array
    {
        $data = [
            'data' => [],
        ];

        foreach ($object as $obj) {
            $item = $this->normalizer->normalize($obj, $format, $context);
            if (!\is_array($item)) {
                throw new UnexpectedValueException('Expected item to be an array');
            }

            if (!isset($item['data'])) {
                throw new UnexpectedValueException('The JSON API document must contain a "data" key.');
            }

            $data['data'][] = $item['data'];

            if (isset($item['included'])) {
                $data['included'] = array_values(array_unique(array_merge($data['included'] ?? [], $item['included']), SORT_REGULAR));
            }
        }

        return $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\JsonApi\Serializer;
15
16	use ApiPlatform\Core\Api\ResourceClassResolverInterface;
17	use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
18	use ApiPlatform\Core\Serializer\AbstractCollectionNormalizer;
19	use ApiPlatform\Core\Util\IriHelper;
20	use Symfony\Component\Serializer\Exception\UnexpectedValueException;
21
22	/**
23	* Normalizes collections in the JSON API format.
24	*
25	* @author Kevin Dunglas <dunglas@gmail.com>
26	* @author Hamza Amrouche <hamza@les-tilleuls.coop>
27	* @author Baptiste Meyer <baptiste.meyer@gmail.com>
28	*/
29	final class CollectionNormalizer extends AbstractCollectionNormalizer
30	{
31	public const FORMAT = 'jsonapi';
32
33	public function __construct(ResourceClassResolverInterface $resourceClassResolver, string $pageParameterName, ResourceMetadataFactoryInterface $resourceMetadataFactory)
34	{
35	parent::__construct($resourceClassResolver, $pageParameterName, $resourceMetadataFactory);	36✔
36	}	36✔
37
38	/**
39	* {@inheritdoc}
40	*/
41	protected function getPaginationData($object, array $context = []): array
42	{
43	[$paginator, $paginated, $currentPage, $itemsPerPage, $lastPage, $pageTotalItems, $totalItems] = $this->getPaginationConfig($object, $context);	5✔
44	$parsed = IriHelper::parseIri($context['uri'] ?? '/', $this->pageParameterName);	5✔
45
46	$metadata = $this->resourceMetadataFactory->create($context['resource_class'] ?? '');	5✔
47	$urlGenerationStrategy = $metadata->getAttribute('url_generation_strategy');	5✔
48
49	$data = [
50	'links' => [
51	'self' => IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $paginated ? $currentPage : null, $urlGenerationStrategy),	5✔
52	],
53	];
54
55	if ($paginated) {	5✔
56	if (null !== $lastPage) {	2✔
57	$data['links']['first'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, 1., $urlGenerationStrategy);	1✔
58	$data['links']['last'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $lastPage, $urlGenerationStrategy);	1✔
59	}
60
61	if (1. !== $currentPage) {	2✔
62	$data['links']['prev'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $currentPage - 1., $urlGenerationStrategy);	2✔
63	}
64
65	if (null !== $lastPage && $currentPage !== $lastPage \|\| null === $lastPage && $pageTotalItems >= $itemsPerPage) {	2✔
66	$data['links']['next'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $currentPage + 1., $urlGenerationStrategy);	2✔
67	}
68	}
69
70	if (null !== $totalItems) {	5✔
71	$data['meta']['totalItems'] = $totalItems;	4✔
72	}
73
74	if ($paginator) {	5✔
75	$data['meta']['itemsPerPage'] = (int) $itemsPerPage;	2✔
76	$data['meta']['currentPage'] = (int) $currentPage;	2✔
77	}
78
79	return $data;	5✔
80	}
81
82	/**
83	* {@inheritdoc}
84	*
85	* @throws UnexpectedValueException
86	*/
87	protected function getItemsData($object, string $format = null, array $context = []): array
88	{
89	$data = [
90	'data' => [],	5✔
91	];
92
93	foreach ($object as $obj) {	5✔
94	$item = $this->normalizer->normalize($obj, $format, $context);	5✔
95	if (!\is_array($item)) {	5✔
96	throw new UnexpectedValueException('Expected item to be an array');	×
97	}
98
99	if (!isset($item['data'])) {	5✔
100	throw new UnexpectedValueException('The JSON API document must contain a "data" key.');	1✔
101	}
102
103	$data['data'][] = $item['data'];	4✔
104
105	if (isset($item['included'])) {	4✔
106	$data['included'] = array_values(array_unique(array_merge($data['included'] ?? [], $item['included']), SORT_REGULAR));	1✔
107	}
108	}
109
110	return $data;	4✔
111	}
112	}

api-platform / core / #26138

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