#26462

pending completion

Build # #26462

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/5c0bb2cb704e10edc3f93691aeda094cadd92f44">5c0bb2cb7<a href="https://github.com/api-platform/core/commit/5c0bb2cb704e10edc3f93691aeda094cadd92f44">">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/9ff295c6617c95f27a3c9624d290e1fd5a4f08bc">9ff295c66</a>">9ff295c66</a><a href="https://github.com/api-platform/core/commit/5c0bb2cb704e10edc3f93691aeda094cadd92f44"> into d008a593c">d008a593c</a>

Run Details

24 of 24 new or added lines in 1 file covered. (100.0%)

9490 of 11436 relevant lines covered (82.98%)

14.82 hits per line

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

96.83

/src/Hydra/Serializer/PartialCollectionViewNormalizer.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\Hydra\Serializer;

use ApiPlatform\Core\DataProvider\PaginatorInterface;
use ApiPlatform\Core\DataProvider\PartialPaginatorInterface;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use ApiPlatform\Core\Util\IriHelper;
use Symfony\Component\PropertyAccess\PropertyAccess;
use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
use Symfony\Component\Serializer\Exception\UnexpectedValueException;
use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;

/**
 * Adds a view key to the result of a paginated Hydra collection.
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 * @author Samuel ROZE <samuel.roze@gmail.com>
 */
final class PartialCollectionViewNormalizer implements NormalizerInterface, NormalizerAwareInterface, CacheableSupportsMethodInterface
{
    private $collectionNormalizer;
    private $pageParameterName;
    private $enabledParameterName;
    private $resourceMetadataFactory;
    private $propertyAccessor;

    public function __construct(NormalizerInterface $collectionNormalizer, string $pageParameterName = 'page', string $enabledParameterName = 'pagination', ResourceMetadataFactoryInterface $resourceMetadataFactory = null, PropertyAccessorInterface $propertyAccessor = null)
    {
        $this->collectionNormalizer = $collectionNormalizer;
        $this->pageParameterName = $pageParameterName;
        $this->enabledParameterName = $enabledParameterName;
        $this->resourceMetadataFactory = $resourceMetadataFactory;
        $this->propertyAccessor = $propertyAccessor ?? PropertyAccess::createPropertyAccessor();
    }

    /**
     * {@inheritdoc}
     */
    public function normalize($object, $format = null, array $context = [])
    {
        $data = $this->collectionNormalizer->normalize($object, $format, $context);
        if (!\is_array($data)) {
            throw new UnexpectedValueException('Expected data to be an array');
        }

        if (isset($context['api_sub_level'])) {
            return $data;
        }

        $currentPage = $lastPage = $itemsPerPage = $pageTotalItems = null;
        if ($paginated = ($object instanceof PartialPaginatorInterface)) {
            if ($object instanceof PaginatorInterface) {
                $paginated = 1. !== $lastPage = $object->getLastPage();
            } else {
                $itemsPerPage = $object->getItemsPerPage();
                $pageTotalItems = (float) \count($object);
            }

            $currentPage = $object->getCurrentPage();
        }

        $parsed = IriHelper::parseIri($context['request_uri'] ?? '/', $this->pageParameterName);
        $appliedFilters = $parsed['parameters'];
        unset($appliedFilters[$this->enabledParameterName]);

        if (!$appliedFilters && !$paginated) {
            return $data;
        }

        $cursorPaginationAttribute = null;
        $metadata = isset($context['resource_class']) && null !== $this->resourceMetadataFactory ? $this->resourceMetadataFactory->create($context['resource_class']) : null;
        $isPaginatedWithCursor = $paginated && null !== $metadata && null !== $cursorPaginationAttribute = $metadata->getCollectionOperationAttribute($context['collection_operation_name'] ?? $context['subresource_operation_name'], 'pagination_via_cursor', null, true);

        $data['hydra:view'] = ['@id' => null, '@type' => 'hydra:PartialCollectionView'];

        if ($isPaginatedWithCursor) {
            return $this->populateDataWithCursorBasedPagination($data, $parsed, $object, $cursorPaginationAttribute);
        }

        $data['hydra:view']['@id'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $paginated ? $currentPage : null);

        if ($paginated) {
            return $this->populateDataWithPagination($data, $parsed, $currentPage, $lastPage, $itemsPerPage, $pageTotalItems);
        }

        return $data;
    }

    /**
     * {@inheritdoc}
     */
    public function supportsNormalization($data, $format = null)
    {
        return $this->collectionNormalizer->supportsNormalization($data, $format);
    }

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

    /**
     * {@inheritdoc}
     */
    public function setNormalizer(NormalizerInterface $normalizer)
    {
        if ($this->collectionNormalizer instanceof NormalizerAwareInterface) {
            $this->collectionNormalizer->setNormalizer($normalizer);
        }
    }

    private function cursorPaginationFields(array $fields, int $direction, $object)
    {
        $paginationFilters = [];

        foreach ($fields as $field) {
            $forwardRangeOperator = 'desc' === strtolower($field['direction']) ? 'lt' : 'gt';
            $backwardRangeOperator = 'gt' === $forwardRangeOperator ? 'lt' : 'gt';

            $operator = $direction > 0 ? $forwardRangeOperator : $backwardRangeOperator;

            $paginationFilters[$field['field']] = [
                $operator => (string) $this->propertyAccessor->getValue($object, $field['field']),
            ];
        }

        return $paginationFilters;
    }

    private function populateDataWithCursorBasedPagination(array $data, array $parsed, \Traversable $object, $cursorPaginationAttribute): array
    {
        $objects = iterator_to_array($object);
        $firstObject = current($objects);
        $lastObject = end($objects);

        $data['hydra:view']['@id'] = IriHelper::createIri($parsed['parts'], $parsed['parameters']);

        if (false !== $lastObject && \is_array($cursorPaginationAttribute)) {
            $data['hydra:view']['hydra:next'] = IriHelper::createIri($parsed['parts'], array_merge($parsed['parameters'], $this->cursorPaginationFields($cursorPaginationAttribute, 1, $lastObject)));
        }

        if (false !== $firstObject && \is_array($cursorPaginationAttribute)) {
            $data['hydra:view']['hydra:previous'] = IriHelper::createIri($parsed['parts'], array_merge($parsed['parameters'], $this->cursorPaginationFields($cursorPaginationAttribute, -1, $firstObject)));
        }

        return $data;
    }

    private function populateDataWithPagination(array $data, array $parsed, ?float $currentPage, ?float $lastPage, ?float $itemsPerPage, ?float $pageTotalItems): array
    {
        if (null !== $lastPage) {
            $data['hydra:view']['hydra:first'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, 1.);
            $data['hydra:view']['hydra:last'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $lastPage);
        }

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

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

        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\Hydra\Serializer;
15
16	use ApiPlatform\Core\DataProvider\PaginatorInterface;
17	use ApiPlatform\Core\DataProvider\PartialPaginatorInterface;
18	use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
19	use ApiPlatform\Core\Util\IriHelper;
20	use Symfony\Component\PropertyAccess\PropertyAccess;
21	use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
22	use Symfony\Component\Serializer\Exception\UnexpectedValueException;
23	use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
24	use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
25	use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
26
27	/**
28	* Adds a view key to the result of a paginated Hydra collection.
29	*
30	* @author Kévin Dunglas <dunglas@gmail.com>
31	* @author Samuel ROZE <samuel.roze@gmail.com>
32	*/
33	final class PartialCollectionViewNormalizer implements NormalizerInterface, NormalizerAwareInterface, CacheableSupportsMethodInterface
34	{
35	private $collectionNormalizer;
36	private $pageParameterName;
37	private $enabledParameterName;
38	private $resourceMetadataFactory;
39	private $propertyAccessor;
40
41	public function __construct(NormalizerInterface $collectionNormalizer, string $pageParameterName = 'page', string $enabledParameterName = 'pagination', ResourceMetadataFactoryInterface $resourceMetadataFactory = null, PropertyAccessorInterface $propertyAccessor = null)
42	{
43	$this->collectionNormalizer = $collectionNormalizer;	37✔
44	$this->pageParameterName = $pageParameterName;	37✔
45	$this->enabledParameterName = $enabledParameterName;	37✔
46	$this->resourceMetadataFactory = $resourceMetadataFactory;	37✔
47	$this->propertyAccessor = $propertyAccessor ?? PropertyAccess::createPropertyAccessor();	37✔
48	}	37✔
49
50	/**
51	* {@inheritdoc}
52	*/
53	public function normalize($object, $format = null, array $context = [])
54	{
55	$data = $this->collectionNormalizer->normalize($object, $format, $context);	14✔
56	if (!\is_array($data)) {	14✔
57	throw new UnexpectedValueException('Expected data to be an array');	×
58	}
59
60	if (isset($context['api_sub_level'])) {	14✔
61	return $data;	2✔
62	}
63
64	$currentPage = $lastPage = $itemsPerPage = $pageTotalItems = null;	12✔
65	if ($paginated = ($object instanceof PartialPaginatorInterface)) {	12✔
66	if ($object instanceof PaginatorInterface) {	9✔
67	$paginated = 1. !== $lastPage = $object->getLastPage();	8✔
68	} else {
69	$itemsPerPage = $object->getItemsPerPage();	1✔
70	$pageTotalItems = (float) \count($object);	1✔
71	}
72
73	$currentPage = $object->getCurrentPage();	9✔
74	}
75
76	$parsed = IriHelper::parseIri($context['request_uri'] ?? '/', $this->pageParameterName);	12✔
77	$appliedFilters = $parsed['parameters'];	12✔
78	unset($appliedFilters[$this->enabledParameterName]);	12✔
79
80	if (!$appliedFilters && !$paginated) {	12✔
81	return $data;	9✔
82	}
83
84	$cursorPaginationAttribute = null;	3✔
85	$metadata = isset($context['resource_class']) && null !== $this->resourceMetadataFactory ? $this->resourceMetadataFactory->create($context['resource_class']) : null;	3✔
86	$isPaginatedWithCursor = $paginated && null !== $metadata && null !== $cursorPaginationAttribute = $metadata->getCollectionOperationAttribute($context['collection_operation_name'] ?? $context['subresource_operation_name'], 'pagination_via_cursor', null, true);	3✔
87
88	$data['hydra:view'] = ['@id' => null, '@type' => 'hydra:PartialCollectionView'];	3✔
89
90	if ($isPaginatedWithCursor) {	3✔
91	return $this->populateDataWithCursorBasedPagination($data, $parsed, $object, $cursorPaginationAttribute);	1✔
92	}
93
94	$data['hydra:view']['@id'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $paginated ? $currentPage : null);	2✔
95
96	if ($paginated) {	2✔
97	return $this->populateDataWithPagination($data, $parsed, $currentPage, $lastPage, $itemsPerPage, $pageTotalItems);	2✔
98	}
99
100	return $data;	×
101	}
102
103	/**
104	* {@inheritdoc}
105	*/
106	public function supportsNormalization($data, $format = null)
107	{
108	return $this->collectionNormalizer->supportsNormalization($data, $format);	20✔
109	}
110
111	/**
112	* {@inheritdoc}
113	*/
114	public function hasCacheableSupportsMethod(): bool
115	{
116	return $this->collectionNormalizer instanceof CacheableSupportsMethodInterface && $this->collectionNormalizer->hasCacheableSupportsMethod();	20✔
117	}
118
119	/**
120	* {@inheritdoc}
121	*/
122	public function setNormalizer(NormalizerInterface $normalizer)
123	{
124	if ($this->collectionNormalizer instanceof NormalizerAwareInterface) {	31✔
125	$this->collectionNormalizer->setNormalizer($normalizer);	31✔
126	}
127	}	31✔
128
129	private function cursorPaginationFields(array $fields, int $direction, $object)
130	{
131	$paginationFilters = [];	1✔
132
133	foreach ($fields as $field) {	1✔
134	$forwardRangeOperator = 'desc' === strtolower($field['direction']) ? 'lt' : 'gt';	1✔
135	$backwardRangeOperator = 'gt' === $forwardRangeOperator ? 'lt' : 'gt';	1✔
136
137	$operator = $direction > 0 ? $forwardRangeOperator : $backwardRangeOperator;	1✔
138
139	$paginationFilters[$field['field']] = [	1✔
140	$operator => (string) $this->propertyAccessor->getValue($object, $field['field']),	1✔
141	];
142	}
143
144	return $paginationFilters;	1✔
145	}
146
147	private function populateDataWithCursorBasedPagination(array $data, array $parsed, \Traversable $object, $cursorPaginationAttribute): array
148	{
149	$objects = iterator_to_array($object);	1✔
150	$firstObject = current($objects);	1✔
151	$lastObject = end($objects);	1✔
152
153	$data['hydra:view']['@id'] = IriHelper::createIri($parsed['parts'], $parsed['parameters']);	1✔
154
155	if (false !== $lastObject && \is_array($cursorPaginationAttribute)) {	1✔
156	$data['hydra:view']['hydra:next'] = IriHelper::createIri($parsed['parts'], array_merge($parsed['parameters'], $this->cursorPaginationFields($cursorPaginationAttribute, 1, $lastObject)));	1✔
157	}
158
159	if (false !== $firstObject && \is_array($cursorPaginationAttribute)) {	1✔
160	$data['hydra:view']['hydra:previous'] = IriHelper::createIri($parsed['parts'], array_merge($parsed['parameters'], $this->cursorPaginationFields($cursorPaginationAttribute, -1, $firstObject)));	1✔
161	}
162
163	return $data;	1✔
164	}
165
166	private function populateDataWithPagination(array $data, array $parsed, ?float $currentPage, ?float $lastPage, ?float $itemsPerPage, ?float $pageTotalItems): array
167	{
168	if (null !== $lastPage) {	2✔
169	$data['hydra:view']['hydra:first'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, 1.);	1✔
170	$data['hydra:view']['hydra:last'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $lastPage);	1✔
171	}
172
173	if (1. !== $currentPage) {	2✔
174	$data['hydra:view']['hydra:previous'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $currentPage - 1.);	2✔
175	}
176
177	if ((null !== $lastPage && $currentPage < $lastPage) \|\| (null === $lastPage && null === $lastPage && $pageTotalItems >= $itemsPerPage)) {	2✔
178	$data['hydra:view']['hydra:next'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $currentPage + 1.);	2✔
179	}
180
181	return $data;	2✔
182	}
183	}

api-platform / core / #26462

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