#27532

pending completion

Build # #27532

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/2f0ca62c1fe1846db8e8eb86ccfde6ebb1eb2232">2f0ca62c1<a href="https://github.com/api-platform/core/commit/2f0ca62c1fe1846db8e8eb86ccfde6ebb1eb2232">">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/0bd540dec7e2abcf66d66dc68ffbdda38db79b70">0bd540dec</a>">0bd540dec</a><a href="https://github.com/api-platform/core/commit/2f0ca62c1fe1846db8e8eb86ccfde6ebb1eb2232"> into 9f7f1e117">9f7f1e117</a>

Run Details

3418 of 3418 new or added lines in 141 files covered. (100.0%)

9271 of 15309 relevant lines covered (60.56%)

89.06 hits per line

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

85.19

/src/Core/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\ResourceClassResolverInterface;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
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, $resourceMetadataFactory, ResourceClassResolverInterface $resourceClassResolver, $filterLocator)
    {
        $this->setFilterLocator($filterLocator);

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

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

    /**
     * {@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 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']);
        $resourceFilters = null;

        if ($this->resourceMetadataFactory instanceof ResourceMetadataFactoryInterface) {
            $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);

            $operationName = $context['collection_operation_name'] ?? null;
            if (null === $operationName) {
                $resourceFilters = $resourceMetadata->getAttribute('filters', []);
            } else {
                $resourceFilters = $resourceMetadata->getCollectionOperationAttribute($operationName, 'filters', [], true);
            }
        } elseif ($this->resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
            $operation = $context['operation'] ?? $this->resourceMetadataFactory->create($resourceClass)->getOperation($context['operation_name'] ?? null);
            $resourceFilters = $operation->getFilters();
        }

        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\ResourceClassResolverInterface;
20	use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
21	use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
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, $resourceMetadataFactory, ResourceClassResolverInterface $resourceClassResolver, $filterLocator)
45	{
46	$this->setFilterLocator($filterLocator);	696✔
47
48	$this->collectionNormalizer = $collectionNormalizer;	696✔
49	$this->resourceMetadataFactory = $resourceMetadataFactory;	696✔
50	$this->resourceClassResolver = $resourceClassResolver;	696✔
51
52	if (!$resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {	696✔
53	trigger_deprecation('api-platform/core', '2.7', sprintf('Use "%s" instead of "%s".', ResourceMetadataCollectionFactoryInterface::class, ResourceMetadataFactoryInterface::class));	×
54	}
55	}	696✔
56
57	/**
58	* {@inheritdoc}
59	*/
60	public function supportsNormalization($data, $format = null)
61	{
62	return $this->collectionNormalizer->supportsNormalization($data, $format);	563✔
63	}
64
65	/**
66	* {@inheritdoc}
67	*/
68	public function hasCacheableSupportsMethod(): bool
69	{
70	return $this->collectionNormalizer instanceof CacheableSupportsMethodInterface && $this->collectionNormalizer->hasCacheableSupportsMethod();	563✔
71	}
72
73	/**
74	* {@inheritdoc}
75	*/
76	public function normalize($object, $format = null, array $context = [])
77	{
78	$data = $this->collectionNormalizer->normalize($object, $format, $context);	243✔
79	if (!\is_array($data)) {	243✔
80	throw new UnexpectedValueException('Expected data to be an array');	×
81	}
82
83	if (!isset($context['resource_class']) \|\| isset($context['api_sub_level'])) {	243✔
84	return $data;	168✔
85	}
86
87	$resourceClass = $this->resourceClassResolver->getResourceClass($object, $context['resource_class']);	163✔
88	$resourceFilters = null;	163✔
89
90	if ($this->resourceMetadataFactory instanceof ResourceMetadataFactoryInterface) {	163✔
91	$resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);	×
92
93	$operationName = $context['collection_operation_name'] ?? null;	×
94	if (null === $operationName) {	×
95	$resourceFilters = $resourceMetadata->getAttribute('filters', []);	×
96	} else {
97	$resourceFilters = $resourceMetadata->getCollectionOperationAttribute($operationName, 'filters', [], true);	×
98	}
99	} elseif ($this->resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {	163✔
100	$operation = $context['operation'] ?? $this->resourceMetadataFactory->create($resourceClass)->getOperation($context['operation_name'] ?? null);	163✔
101	$resourceFilters = $operation->getFilters();	163✔
102	}
103
104	if (!$resourceFilters) {	163✔
105	return $data;	46✔
106	}
107
108	$requestParts = parse_url($context['request_uri'] ?? '');	117✔
109	if (!\is_array($requestParts)) {	117✔
110	return $data;	×
111	}
112
113	$currentFilters = [];	117✔
114	foreach ($resourceFilters as $filterId) {	117✔
115	if ($filter = $this->getFilter($filterId)) {	117✔
116	$currentFilters[] = $filter;	117✔
117	}
118	}
119
120	if ($currentFilters) {	117✔
121	$data['hydra:search'] = $this->getSearch($resourceClass, $requestParts, $currentFilters);	117✔
122	}
123
124	return $data;	117✔
125	}
126
127	/**
128	* {@inheritdoc}
129	*/
130	public function setNormalizer(NormalizerInterface $normalizer)
131	{
132	if ($this->collectionNormalizer instanceof NormalizerAwareInterface) {	696✔
133	$this->collectionNormalizer->setNormalizer($normalizer);	696✔
134	}
135	}	696✔
136
137	/**
138	* Returns the content of the Hydra search property.
139	*
140	* @param FilterInterface[] $filters
141	*/
142	private function getSearch(string $resourceClass, array $parts, array $filters): array
143	{
144	$variables = [];	117✔
145	$mapping = [];	117✔
146	foreach ($filters as $filter) {	117✔
147	foreach ($filter->getDescription($resourceClass) as $variable => $data) {	117✔
148	$variables[] = $variable;	117✔
149	$mapping[] = [	117✔
150	'@type' => 'IriTemplateMapping',	117✔
151	'variable' => $variable,	117✔
152	'property' => $data['property'],	117✔
153	'required' => $data['required'],	117✔
154	];
155	}
156	}
157
158	return [
159	'@type' => 'hydra:IriTemplate',	117✔
160	'hydra:template' => sprintf('%s{?%s}', $parts['path'], implode(',', $variables)),	117✔
161	'hydra:variableRepresentation' => 'BasicRepresentation',	117✔
162	'hydra:mapping' => $mapping,	117✔
163	];
164	}
165	}

api-platform / core / #27532

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