#27979

pending completion

Build # #27979

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/dc2ff0e17c94c6bcdfc8c5017a81bd2536c5bb69">dc2ff0e17<a href="https://github.com/api-platform/core/commit/dc2ff0e17c94c6bcdfc8c5017a81bd2536c5bb69">">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/f6e2622b1bc92e17bbe370d8fbce0f9d7f969650">f6e2622b1</a>">f6e2622b1</a><a href="https://github.com/api-platform/core/commit/dc2ff0e17c94c6bcdfc8c5017a81bd2536c5bb69"> into 1eaacf2b5">1eaacf2b5</a>

Run Details

21 of 21 new or added lines in 8 files covered. (100.0%)

9776 of 11715 relevant lines covered (83.45%)

14.81 hits per line

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

93.88

/src/Hydra/Serializer/CollectionFiltersNormalizer.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\Api\FilterCollection;
use ApiPlatform\Core\Api\FilterInterface;
use ApiPlatform\Core\Api\FilterLocatorTrait;
use ApiPlatform\Core\Api\OperationType;
use ApiPlatform\Core\Api\ResourceClassResolverInterface;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use Psr\Container\ContainerInterface;
use Symfony\Component\Serializer\Exception\UnexpectedValueException;
use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;

/**
 * Enhances the result of collection by adding the filters applied on collection.
 *
 * @author Samuel ROZE <samuel.roze@gmail.com>
 */
final class CollectionFiltersNormalizer implements NormalizerInterface, NormalizerAwareInterface, CacheableSupportsMethodInterface
{
    use FilterLocatorTrait;

    private $collectionNormalizer;
    private $resourceMetadataFactory;
    private $resourceClassResolver;

    /**
     * @param ContainerInterface|FilterCollection $filterLocator The new filter locator or the deprecated filter collection
     */
    public function __construct(NormalizerInterface $collectionNormalizer, ResourceMetadataFactoryInterface $resourceMetadataFactory, ResourceClassResolverInterface $resourceClassResolver, $filterLocator)
    {
        $this->setFilterLocator($filterLocator);

        $this->collectionNormalizer = $collectionNormalizer;
        $this->resourceMetadataFactory = $resourceMetadataFactory;
        $this->resourceClassResolver = $resourceClassResolver;
    }

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

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

    /**
     * {@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['resource_class']) || isset($context['api_sub_level'])) {
            return $data;
        }

        $resourceClass = $this->resourceClassResolver->getResourceClass($object, $context['resource_class']);
        $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);

        $operationName = $context['collection_operation_name'] ?? null;
        if (null === $operationName) {
            $resourceFilters = $resourceMetadata->getAttribute('filters', []);
        } elseif (OperationType::SUBRESOURCE === ($context['operation_type'] ?? null)) {
            $resourceFilters = $resourceMetadata->getSubresourceOperationAttribute($operationName, 'filters', [], true);
        } else {
            $resourceFilters = $resourceMetadata->getCollectionOperationAttribute($operationName, 'filters', [], true);
        }

        if (!$resourceFilters) {
            return $data;
        }

        $requestParts = parse_url($context['request_uri'] ?? '');
        if (!\is_array($requestParts)) {
            return $data;
        }

        $currentFilters = [];
        foreach ($resourceFilters as $filterId) {
            if ($filter = $this->getFilter($filterId)) {
                $currentFilters[] = $filter;
            }
        }

        if ($currentFilters) {
            $data['hydra:search'] = $this->getSearch($resourceClass, $requestParts, $currentFilters);
        }

        return $data;
    }

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

    /**
     * Returns the content of the Hydra search property.
     *
     * @param FilterInterface[] $filters
     */
    private function getSearch(string $resourceClass, array $parts, array $filters): array
    {
        $variables = [];
        $mapping = [];
        foreach ($filters as $filter) {
            foreach ($filter->getDescription($resourceClass) as $variable => $data) {
                $variables[] = $variable;
                $mapping[] = [
                    '@type' => 'IriTemplateMapping',
                    'variable' => $variable,
                    'property' => $data['property'],
                    'required' => $data['required'],
                ];
            }
        }

        return [
            '@type' => 'hydra:IriTemplate',
            'hydra:template' => sprintf('%s{?%s}', $parts['path'], implode(',', $variables)),
            'hydra:variableRepresentation' => 'BasicRepresentation',
            'hydra:mapping' => $mapping,
        ];
    }
}

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\Api\FilterCollection;
17	use ApiPlatform\Core\Api\FilterInterface;
18	use ApiPlatform\Core\Api\FilterLocatorTrait;
19	use ApiPlatform\Core\Api\OperationType;
20	use ApiPlatform\Core\Api\ResourceClassResolverInterface;
21	use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
22	use Psr\Container\ContainerInterface;
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	* Enhances the result of collection by adding the filters applied on collection.
30	*
31	* @author Samuel ROZE <samuel.roze@gmail.com>
32	*/
33	final class CollectionFiltersNormalizer implements NormalizerInterface, NormalizerAwareInterface, CacheableSupportsMethodInterface
34	{
35	use FilterLocatorTrait;
36
37	private $collectionNormalizer;
38	private $resourceMetadataFactory;
39	private $resourceClassResolver;
40
41	/**
42	* @param ContainerInterface\|FilterCollection $filterLocator The new filter locator or the deprecated filter collection
43	*/
44	public function __construct(NormalizerInterface $collectionNormalizer, ResourceMetadataFactoryInterface $resourceMetadataFactory, ResourceClassResolverInterface $resourceClassResolver, $filterLocator)
45	{
46	$this->setFilterLocator($filterLocator);	40✔
47
48	$this->collectionNormalizer = $collectionNormalizer;	39✔
49	$this->resourceMetadataFactory = $resourceMetadataFactory;	39✔
50	$this->resourceClassResolver = $resourceClassResolver;	39✔
51	}	39✔
52
53	/**
54	* {@inheritdoc}
55	*/
56	public function supportsNormalization($data, $format = null): bool
57	{
58	return $this->collectionNormalizer->supportsNormalization($data, $format);	18✔
59	}
60
61	/**
62	* {@inheritdoc}
63	*/
64	public function hasCacheableSupportsMethod(): bool
65	{
66	return $this->collectionNormalizer instanceof CacheableSupportsMethodInterface && $this->collectionNormalizer->hasCacheableSupportsMethod();	18✔
67	}
68
69	/**
70	* {@inheritdoc}
71	*/
72	public function normalize($object, $format = null, array $context = [])
73	{
74	$data = $this->collectionNormalizer->normalize($object, $format, $context);	17✔
75	if (!\is_array($data)) {	17✔
76	throw new UnexpectedValueException('Expected data to be an array');	×
77	}
78
79	if (!isset($context['resource_class']) \|\| isset($context['api_sub_level'])) {	17✔
80	return $data;	6✔
81	}
82
83	$resourceClass = $this->resourceClassResolver->getResourceClass($object, $context['resource_class']);	11✔
84	$resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);	11✔
85
86	$operationName = $context['collection_operation_name'] ?? null;	11✔
87	if (null === $operationName) {	11✔
88	$resourceFilters = $resourceMetadata->getAttribute('filters', []);	3✔
89	} elseif (OperationType::SUBRESOURCE === ($context['operation_type'] ?? null)) {	8✔
90	$resourceFilters = $resourceMetadata->getSubresourceOperationAttribute($operationName, 'filters', [], true);	×
91	} else {
92	$resourceFilters = $resourceMetadata->getCollectionOperationAttribute($operationName, 'filters', [], true);	8✔
93	}
94
95	if (!$resourceFilters) {	11✔
96	return $data;	5✔
97	}
98
99	$requestParts = parse_url($context['request_uri'] ?? '');	6✔
100	if (!\is_array($requestParts)) {	6✔
101	return $data;	×
102	}
103
104	$currentFilters = [];	6✔
105	foreach ($resourceFilters as $filterId) {	6✔
106	if ($filter = $this->getFilter($filterId)) {	6✔
107	$currentFilters[] = $filter;	5✔
108	}
109	}
110
111	if ($currentFilters) {	6✔
112	$data['hydra:search'] = $this->getSearch($resourceClass, $requestParts, $currentFilters);	5✔
113	}
114
115	return $data;	6✔
116	}
117
118	/**
119	* {@inheritdoc}
120	*/
121	public function setNormalizer(NormalizerInterface $normalizer)
122	{
123	if ($this->collectionNormalizer instanceof NormalizerAwareInterface) {	31✔
124	$this->collectionNormalizer->setNormalizer($normalizer);	31✔
125	}
126	}	31✔
127
128	/**
129	* Returns the content of the Hydra search property.
130	*
131	* @param FilterInterface[] $filters
132	*/
133	private function getSearch(string $resourceClass, array $parts, array $filters): array
134	{
135	$variables = [];	5✔
136	$mapping = [];	5✔
137	foreach ($filters as $filter) {	5✔
138	foreach ($filter->getDescription($resourceClass) as $variable => $data) {	5✔
139	$variables[] = $variable;	5✔
140	$mapping[] = [	5✔
141	'@type' => 'IriTemplateMapping',	5✔
142	'variable' => $variable,	5✔
143	'property' => $data['property'],	5✔
144	'required' => $data['required'],	5✔
145	];
146	}
147	}
148
149	return [
150	'@type' => 'hydra:IriTemplate',	5✔
151	'hydra:template' => sprintf('%s{?%s}', $parts['path'], implode(',', $variables)),	5✔
152	'hydra:variableRepresentation' => 'BasicRepresentation',	5✔
153	'hydra:mapping' => $mapping,	5✔
154	];
155	}
156	}

api-platform / core / #27979

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