13814792797

Committed 12 Mar 2025 03:09PM UTC coverage: 5.889% (-1.4%) from 7.289%

Build # 13814792797

Build Type

Pull #7012

github

Committed by

web-flow

Commit Message

Merge 199d44919 into 284937039

Pull Request Pull Request #7012: doc: comment typo in ApiResource.php

Run Details

10048 of 170615 relevant lines covered (5.89%)

5.17 hits per line

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

72.97

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

use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
use ApiPlatform\Metadata\ResourceClassResolverInterface;
use ApiPlatform\Metadata\Util\IriHelper;
use ApiPlatform\Serializer\AbstractCollectionNormalizer;
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, ResourceMetadataCollectionFactoryInterface $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);

        $operation = $context['operation'] ?? $this->getOperation($context);
        $urlGenerationStrategy = $operation->getUrlGenerationStrategy();

        $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\JsonApi\Serializer;
15
16	use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
17	use ApiPlatform\Metadata\ResourceClassResolverInterface;
18	use ApiPlatform\Metadata\Util\IriHelper;
19	use ApiPlatform\Serializer\AbstractCollectionNormalizer;
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, ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory)
34	{
35	parent::__construct($resourceClassResolver, $pageParameterName, $resourceMetadataFactory);	387✔
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);	15✔
44	$parsed = IriHelper::parseIri($context['uri'] ?? '/', $this->pageParameterName);	15✔
45
46	$operation = $context['operation'] ?? $this->getOperation($context);	15✔
47	$urlGenerationStrategy = $operation->getUrlGenerationStrategy();	15✔
48
49	$data = [	15✔
50	'links' => [	15✔
51	'self' => IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $paginated ? $currentPage : null, $urlGenerationStrategy),	15✔
52	],	15✔
53	];	15✔
54
55	if ($paginated) {	15✔
56	if (null !== $lastPage) {	×
57	$data['links']['first'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, 1., $urlGenerationStrategy);	×
58	$data['links']['last'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $lastPage, $urlGenerationStrategy);	×
59	}
60
61	if (1. !== $currentPage) {	×
62	$data['links']['prev'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $currentPage - 1., $urlGenerationStrategy);	×
63	}
64
65	if (null !== $lastPage && $currentPage !== $lastPage \|\| null === $lastPage && $pageTotalItems >= $itemsPerPage) {	×
66	$data['links']['next'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $currentPage + 1., $urlGenerationStrategy);	×
67	}
68	}
69
70	if (null !== $totalItems) {	15✔
71	$data['meta']['totalItems'] = $totalItems;	12✔
72	}
73
74	if ($paginator) {	15✔
75	$data['meta']['itemsPerPage'] = (int) $itemsPerPage;	6✔
76	$data['meta']['currentPage'] = (int) $currentPage;	6✔
77	}
78
79	return $data;	15✔
80	}
81
82	/**
83	* {@inheritdoc}
84	*
85	* @throws UnexpectedValueException
86	*/
87	protected function getItemsData($object, ?string $format = null, array $context = []): array
88	{
89	$data = [	15✔
90	'data' => [],	15✔
91	];	15✔
92
93	foreach ($object as $obj) {	15✔
94	$item = $this->normalizer->normalize($obj, $format, $context);	15✔
95	if (!\is_array($item)) {	15✔
96	throw new UnexpectedValueException('Expected item to be an array');	×
97	}
98
99	if (!isset($item['data'])) {	15✔
100	throw new UnexpectedValueException('The JSON API document must contain a "data" key.');	×
101	}
102
103	$data['data'][] = $item['data'];	15✔
104
105	if (isset($item['included'])) {	15✔
106	$data['included'] = array_values(array_unique(array_merge($data['included'] ?? [], $item['included']), \SORT_REGULAR));	×
107	}
108	}
109
110	return $data;	15✔
111	}
112	}

api-platform / core / 13814792797

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