11276503720

Committed 10 Oct 2024 02:49PM CUT coverage: 61.85%. Remained the same

Build # 11276503720

Build Type

push

github

Committed by

web-flow

Commit Message

doc: error guide remove useless configuration (#6712)

Co-authored-by: Kévin Dunglas <kevin@dunglas.fr>

Run Details

11394 of 18422 relevant lines covered (61.85%)

66.73 hits per line

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

100.0

/src/Symfony/EventListener/JsonApi/TransformSortingParametersListener.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 Symfony\Component\HttpKernel\Event\RequestEvent;

/**
 * @see http://jsonapi.org/format/#fetching-sorting
 * @see https://api-platform.com/docs/core/filters#order-filter
 *
 * @author Héctor Hurtarte <hectorh30@gmail.com>
 * @author Baptiste Meyer <baptiste.meyer@gmail.com>
 */
final class TransformSortingParametersListener
{
    public function __construct(private readonly string $orderParameterName = 'order')
    {
    }

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

        $orderParameter = $request->query->all()['sort'] ?? null;

        if (
            null === $orderParameter
            || \is_array($orderParameter)
            || 'jsonapi' !== $request->getRequestFormat()
        ) {
            return;
        }

        $orderParametersArray = explode(',', (string) $orderParameter);
        $transformedOrderParametersArray = [];

        foreach ($orderParametersArray as $orderParameter) {
            $sorting = 'asc';

            if ('-' === ($orderParameter[0] ?? null)) {
                $sorting = 'desc';
                $orderParameter = substr($orderParameter, 1);
            }

            $transformedOrderParametersArray[$orderParameter] = $sorting;
        }

        $filters = $request->attributes->get('_api_filters', []);
        $filters[$this->orderParameterName] = $transformedOrderParametersArray;
        $request->attributes->set('_api_filters', $filters);
    }
}

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 Symfony\Component\HttpKernel\Event\RequestEvent;
17
18	/**
19	* @see http://jsonapi.org/format/#fetching-sorting
20	* @see https://api-platform.com/docs/core/filters#order-filter
21	*
22	* @author Héctor Hurtarte <hectorh30@gmail.com>
23	* @author Baptiste Meyer <baptiste.meyer@gmail.com>
24	*/
25	final class TransformSortingParametersListener
26	{
27	public function __construct(private readonly string $orderParameterName = 'order')
28	{
29	}	126✔
30
31	public function onKernelRequest(RequestEvent $event): void
32	{
33	$request = $event->getRequest();	126✔
34	if (($operation = $request->attributes->get('_api_operation')) && 'api_platform.symfony.main_controller' === $operation->getController()) {	126✔
35	return;	95✔
36	}
37
38	$orderParameter = $request->query->all()['sort'] ?? null;	38✔
39
40	if (
41	null === $orderParameter	38✔
42	\|\| \is_array($orderParameter)	38✔
43	\|\| 'jsonapi' !== $request->getRequestFormat()	38✔
44	) {
45	return;	34✔
46	}
47
48	$orderParametersArray = explode(',', (string) $orderParameter);	4✔
49	$transformedOrderParametersArray = [];	4✔
50
51	foreach ($orderParametersArray as $orderParameter) {	4✔
52	$sorting = 'asc';	4✔
53
54	if ('-' === ($orderParameter[0] ?? null)) {	4✔
55	$sorting = 'desc';	4✔
56	$orderParameter = substr($orderParameter, 1);	4✔
57	}
58
59	$transformedOrderParametersArray[$orderParameter] = $sorting;	4✔
60	}
61
62	$filters = $request->attributes->get('_api_filters', []);	4✔
63	$filters[$this->orderParameterName] = $transformedOrderParametersArray;	4✔
64	$request->attributes->set('_api_filters', $filters);	4✔
65	}
66	}

api-platform / core / 11276503720

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