#25641

pending completion

Build # #25641

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/60e55ad4a32eadae4c60bc3bb2500c5850e7b351">60e55ad4a<a href="https://github.com/api-platform/core/commit/60e55ad4a32eadae4c60bc3bb2500c5850e7b351">">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/ff60de751e0f6713eef834c36e0e733bd2341231">ff60de751</a>">ff60de751</a><a href="https://github.com/api-platform/core/commit/60e55ad4a32eadae4c60bc3bb2500c5850e7b351"> into 9ccf57835">9ccf57835</a>

Run Details

37 of 37 new or added lines in 12 files covered. (100.0%)

8663 of 10225 relevant lines covered (84.72%)

15.06 hits per line

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

92.86

/src/JsonApi/EventListener/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\Core\JsonApi\EventListener;

use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use Symfony\Component\HttpFoundation\InputBag;
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
{
    private $resourceMetadataFactory;

    public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory)
    {
        $this->resourceMetadataFactory = $resourceMetadataFactory;
    }

    public function onKernelRequest(RequestEvent $event): void
    {
        $request = $event->getRequest();

        $includeParameter = $request->query->get('include');
        $fieldsParameter = class_exists(InputBag::class) ? $request->query->all('fields') : $request->query->get('fields');

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

        if (
            ($fieldsParameter && !\is_array($fieldsParameter)) ||
            (!\is_string($includeParameter))
        ) {
            return;
        }

        $properties = [];

        $includeParameter = explode(',', $includeParameter ?? '');

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

            return;
        }

        $resourceShortName = $this->resourceMetadataFactory->create($resourceClass)->getShortName();

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

api-platform / core / #25641

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