10682869832

Committed 03 Sep 2024 12:24PM UTC coverage: 70.804%. Remained the same

Build # 10682869832

Build Type

push

github

Committed by

soyuka

Commit Message

docs: changelog v3.4.0-alpha.4

Run Details

3075 of 4343 relevant lines covered (70.8%)

75.56 hits per line

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

96.55

/src/Symfony/EventListener/JsonApi/TransformFieldsetsParametersListener.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\Symfony\EventListener\JsonApi;

use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
use Symfony\Component\HttpKernel\Event\RequestEvent;

/**
 * @see http://jsonapi.org/format/#fetching-sparse-fieldsets
 * @see https://api-platform.com/docs/core/filters#property-filter
 *
 * @author Baptiste Meyer <baptiste.meyer@gmail.com>
 */
final class TransformFieldsetsParametersListener
{
    public function __construct(private readonly ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory)
    {
    }

    public function onKernelRequest(RequestEvent $event): void
    {
        $request = $event->getRequest();
        if (($operation = $request->attributes->get('_api_operation')) && 'api_platform.symfony.main_controller' === $operation->getController()) {
            return;
        }

        $queryParameters = $request->query->all();
        $includeParameter = $queryParameters['include'] ?? null;
        $fieldsParameter = $queryParameters['fields'] ?? null;

        if (
            (!$fieldsParameter && !$includeParameter)
            || ($fieldsParameter && !\is_array($fieldsParameter))
            || (!\is_string($includeParameter))
            || 'jsonapi' !== $request->getRequestFormat()
            || !($resourceClass = $request->attributes->get('_api_resource_class'))
        ) {
            return;
        }

        $includeParameter = explode(',', $includeParameter);
        if (!$fieldsParameter) {
            $request->attributes->set('_api_included', $includeParameter);

            return;
        }

        $resourceMetadata = $this->resourceMetadataCollectionFactory->create($resourceClass);
        $resourceShortName = $resourceMetadata->getOperation()->getShortName();

        $properties = [];
        foreach ($fieldsParameter as $resourceType => $fields) {
            $fields = explode(',', (string) $fields);

            if ($resourceShortName === $resourceType) {
                $properties = array_merge($properties, $fields);
            } elseif (\in_array($resourceType, $includeParameter, true)) {
                $properties[$resourceType] = $fields;

                $request->attributes->set('_api_included', array_merge($request->attributes->get('_api_included', []), [$resourceType]));
            } else {
                $properties[$resourceType] = $fields;
            }
        }

        $request->attributes->set('_api_filter_property', $properties);
    }
}

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\Symfony\EventListener\JsonApi;
15
16	use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
17	use Symfony\Component\HttpKernel\Event\RequestEvent;
18
19	/**
20	* @see http://jsonapi.org/format/#fetching-sparse-fieldsets
21	* @see https://api-platform.com/docs/core/filters#property-filter
22	*
23	* @author Baptiste Meyer <baptiste.meyer@gmail.com>
24	*/
25	final class TransformFieldsetsParametersListener
26	{
27	public function __construct(private readonly ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory)
28	{
29	}	134✔
30
31	public function onKernelRequest(RequestEvent $event): void
32	{
33	$request = $event->getRequest();	134✔
34	if (($operation = $request->attributes->get('_api_operation')) && 'api_platform.symfony.main_controller' === $operation->getController()) {	134✔
35	return;	95✔
36	}
37
38	$queryParameters = $request->query->all();	46✔
39	$includeParameter = $queryParameters['include'] ?? null;	46✔
40	$fieldsParameter = $queryParameters['fields'] ?? null;	46✔
41
42	if (
43	(!$fieldsParameter && !$includeParameter)	46✔
44	\|\| ($fieldsParameter && !\is_array($fieldsParameter))	46✔
45	\|\| (!\is_string($includeParameter))	46✔
46	\|\| 'jsonapi' !== $request->getRequestFormat()	46✔
47	\|\| !($resourceClass = $request->attributes->get('_api_resource_class'))	46✔
48	) {
49	return;	38✔
50	}
51
52	$includeParameter = explode(',', $includeParameter);	8✔
53	if (!$fieldsParameter) {	8✔
54	$request->attributes->set('_api_included', $includeParameter);	4✔
55
56	return;	4✔
57	}
58
59	$resourceMetadata = $this->resourceMetadataCollectionFactory->create($resourceClass);	4✔
60	$resourceShortName = $resourceMetadata->getOperation()->getShortName();	4✔
61
62	$properties = [];	4✔
63	foreach ($fieldsParameter as $resourceType => $fields) {	4✔
64	$fields = explode(',', (string) $fields);	4✔
65
66	if ($resourceShortName === $resourceType) {	4✔
67	$properties = array_merge($properties, $fields);	4✔
68	} elseif (\in_array($resourceType, $includeParameter, true)) {	4✔
69	$properties[$resourceType] = $fields;	4✔
70
71	$request->attributes->set('_api_included', array_merge($request->attributes->get('_api_included', []), [$resourceType]));	4✔
72	} else {
73	$properties[$resourceType] = $fields;	×
74	}
75	}
76
77	$request->attributes->set('_api_filter_property', $properties);	4✔
78	}
79	}

api-platform / core / 10682869832

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