#27678

pending completion

Build # #27678

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/d984de8a7d7ada2dde753e098df9ed662a0fcd96">d984de8a7<a href="https://github.com/api-platform/core/commit/d984de8a7d7ada2dde753e098df9ed662a0fcd96">">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/7d8660be8748d6fa23fe27b4dbc764b67c7d2331">7d8660be8</a>">7d8660be8</a><a href="https://github.com/api-platform/core/commit/d984de8a7d7ada2dde753e098df9ed662a0fcd96"> into 11fa1e785">11fa1e785</a>

Run Details

47 of 47 new or added lines in 34 files covered. (100.0%)

13190 of 15992 relevant lines covered (82.48%)

14.82 hits per line

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

94.29

/src/Core/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 ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
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', $resourceMetadataFactory = null, PropertyAccessorInterface $propertyAccessor = null)
    {
        $this->collectionNormalizer = $collectionNormalizer;
        $this->pageParameterName = $pageParameterName;
        $this->enabledParameterName = $enabledParameterName;
        $this->resourceMetadataFactory = $resourceMetadataFactory;

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

        $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;
        }

        $isPaginatedWithCursor = false;
        $cursorPaginationAttribute = null;
        if ($this->resourceMetadataFactory instanceof ResourceMetadataFactoryInterface && isset($context['resource_class']) && $paginated) {
            $metadata = $this->resourceMetadataFactory->create($context['resource_class']);
            $isPaginatedWithCursor = null !== $cursorPaginationAttribute = $metadata->getCollectionOperationAttribute($context['collection_operation_name'] ?? $context['subresource_operation_name'], 'pagination_via_cursor', null, true);
        } elseif ($this->resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface && isset($context['resource_class']) && $paginated) {
            $operation = $this->resourceMetadataFactory->create($context['resource_class'])->getOperation($context['operation_name'] ?? null);
            $isPaginatedWithCursor = [] !== $cursorPaginationAttribute = ($operation->getPaginationViaCursor() ?? []);
        }

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

api-platform / core / #27678

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