#25625

pending completion

Build # #25625

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/bb07bcc2fa00919430d0ea1e6f3c8e6ea844b816">bb07bcc2f<a href="https://github.com/api-platform/core/commit/bb07bcc2fa00919430d0ea1e6f3c8e6ea844b816">">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/1d58ffe5e5e5bf4a1533c0a7a03a32a2d8e6c19b">1d58ffe5e</a>">1d58ffe5e</a><a href="https://github.com/api-platform/core/commit/bb07bcc2fa00919430d0ea1e6f3c8e6ea844b816"> into 61202269e">61202269e</a>

Run Details

35 of 35 new or added lines in 10 files covered. (100.0%)

5679 of 11519 relevant lines covered (49.3%)

55.36 hits per line

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

0.0

/src/Bridge/Elasticsearch/DataProvider/Extension/AbstractFilterExtension.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\Bridge\Elasticsearch\DataProvider\Extension;

use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use Psr\Container\ContainerInterface;

/**
 * Abstract class for easing the implementation of a filter extension.
 *
 * @experimental
 *
 * @author Baptiste Meyer <baptiste.meyer@gmail.com>
 */
abstract class AbstractFilterExtension implements RequestBodySearchCollectionExtensionInterface
{
    private $resourceMetadataFactory;
    private $filterLocator;

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

    /**
     * {@inheritdoc}
     */
    public function applyToCollection(array $requestBody, string $resourceClass, ?string $operationName = null, array $context = []): array
    {
        $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
        $resourceFilters = $resourceMetadata->getCollectionOperationAttribute($operationName, 'filters', [], true);

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

        $context['filters'] = $context['filters'] ?? [];
        $clauseBody = [];

        foreach ($resourceFilters as $filterId) {
            if ($this->filterLocator->has($filterId) && is_a($filter = $this->filterLocator->get($filterId), $this->getFilterInterface(), true)) {
                $clauseBody = $filter->apply($clauseBody, $resourceClass, $operationName, $context);
            }
        }

        if (!$clauseBody) {
            return $requestBody;
        }

        return $this->alterRequestBody($requestBody, $clauseBody);
    }

    /**
     * Gets the related filter interface.
     */
    abstract protected function getFilterInterface(): string;

    /**
     * Alters the request body.
     */
    abstract protected function alterRequestBody(array $requestBody, array $clauseBody): array;
}

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\Bridge\Elasticsearch\DataProvider\Extension;
15
16	use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
17	use Psr\Container\ContainerInterface;
18
19	/**
20	* Abstract class for easing the implementation of a filter extension.
21	*
22	* @experimental
23	*
24	* @author Baptiste Meyer <baptiste.meyer@gmail.com>
25	*/
26	abstract class AbstractFilterExtension implements RequestBodySearchCollectionExtensionInterface
27	{
28	private $resourceMetadataFactory;
29	private $filterLocator;
30
31	public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory, ContainerInterface $filterLocator)
32	{	×
33	$this->resourceMetadataFactory = $resourceMetadataFactory;	×
34	$this->filterLocator = $filterLocator;	×
35	}	×
36
37	/**
38	* {@inheritdoc}
39	*/
40	public function applyToCollection(array $requestBody, string $resourceClass, ?string $operationName = null, array $context = []): array
41	{	×
42	$resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);	×
43	$resourceFilters = $resourceMetadata->getCollectionOperationAttribute($operationName, 'filters', [], true);	×
44
45	if (!$resourceFilters) {	×
46	return $requestBody;	×
47	}	×
48
49	$context['filters'] = $context['filters'] ?? [];	×
50	$clauseBody = [];	×
51
52	foreach ($resourceFilters as $filterId) {	×
53	if ($this->filterLocator->has($filterId) && is_a($filter = $this->filterLocator->get($filterId), $this->getFilterInterface(), true)) {	×
54	$clauseBody = $filter->apply($clauseBody, $resourceClass, $operationName, $context);	×
55	}	×
56	}	×
57
58	if (!$clauseBody) {	×
59	return $requestBody;	×
60	}	×
61
62	return $this->alterRequestBody($requestBody, $clauseBody);	×
63	}	×
64
65	/**
66	* Gets the related filter interface.
67	*/
68	abstract protected function getFilterInterface(): string;
69
70	/**
71	* Alters the request body.
72	*/
73	abstract protected function alterRequestBody(array $requestBody, array $clauseBody): array;
74	}

api-platform / core / #25625

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