#26703

pending completion

Build # #26703

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/c14853148704c95968160449a38e1e90d5ac642f">c14853148<a href="https://github.com/api-platform/core/commit/c14853148704c95968160449a38e1e90d5ac642f">">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/2e02825a3f483fee995f7ede22880cc776bf29d1">2e02825a3</a>">2e02825a3</a><a href="https://github.com/api-platform/core/commit/c14853148704c95968160449a38e1e90d5ac642f"> into cecd948a1">cecd948a1</a>

Run Details

3 of 3 new or added lines in 1 file covered. (100.0%)

9560 of 11511 relevant lines covered (83.05%)

14.12 hits per line

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

0.0

/src/Bridge/Doctrine/MongoDbOdm/Filter/ExistsFilter.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\Doctrine\MongoDbOdm\Filter;

use ApiPlatform\Core\Bridge\Doctrine\Common\Filter\ExistsFilterInterface;
use ApiPlatform\Core\Bridge\Doctrine\Common\Filter\ExistsFilterTrait;
use Doctrine\ODM\MongoDB\Aggregation\Builder;
use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
use Doctrine\Persistence\ManagerRegistry;
use Psr\Log\LoggerInterface;
use Symfony\Component\Serializer\NameConverter\NameConverterInterface;

/**
 * Filters the collection by whether a property value exists or not.
 *
 * For each property passed, if the resource does not have such property or if
 * the value is not one of ( "true" | "false" | "1" | "0" ) the property is ignored.
 *
 * A query parameter with key but no value is treated as `true`, e.g.:
 * Request: GET /products?exists[brand]
 * Interpretation: filter products which have a brand
 *
 * @experimental
 *
 * @author Teoh Han Hui <teohhanhui@gmail.com>
 * @author Alan Poulain <contact@alanpoulain.eu>
 */
final class ExistsFilter extends AbstractFilter implements ExistsFilterInterface
{
    use ExistsFilterTrait;

    public function __construct(ManagerRegistry $managerRegistry, LoggerInterface $logger = null, array $properties = null, string $existsParameterName = self::QUERY_PARAMETER_KEY, NameConverterInterface $nameConverter = null)
    {
        parent::__construct($managerRegistry, $logger, $properties, $nameConverter);

        $this->existsParameterName = $existsParameterName;
    }

    /**
     * {@inheritdoc}
     */
    public function apply(Builder $aggregationBuilder, string $resourceClass, string $operationName = null, array &$context = [])
    {
        if (!\is_array($context['filters'][$this->existsParameterName] ?? null)) {
            $context['exists_deprecated_syntax'] = true;
            parent::apply($aggregationBuilder, $resourceClass, $operationName, $context);

            return;
        }

        foreach ($context['filters'][$this->existsParameterName] as $property => $value) {
            $this->filterProperty($this->denormalizePropertyName($property), $value, $aggregationBuilder, $resourceClass, $operationName, $context);
        }
    }

    /**
     * {@inheritdoc}
     */
    protected function filterProperty(string $property, $value, Builder $aggregationBuilder, string $resourceClass, string $operationName = null, array &$context = [])
    {
        if (
            (($context['exists_deprecated_syntax'] ?? false) && !isset($value[self::QUERY_PARAMETER_KEY])) ||
            !$this->isPropertyEnabled($property, $resourceClass) ||
            !$this->isPropertyMapped($property, $resourceClass, true) ||
            !$this->isNullableField($property, $resourceClass)
        ) {
            return;
        }

        $value = $this->normalizeValue($value, $property);
        if (null === $value) {
            return;
        }

        $matchField = $property;

        if ($this->isPropertyNested($property, $resourceClass)) {
            [$matchField] = $this->addLookupsForNestedProperty($property, $aggregationBuilder, $resourceClass);
        }

        $aggregationBuilder->match()->field($matchField)->{$value ? 'notEqual' : 'equals'}(null);
    }

    /**
     * {@inheritdoc}
     */
    protected function isNullableField(string $property, string $resourceClass): bool
    {
        $propertyParts = $this->splitPropertyParts($property, $resourceClass);
        $metadata = $this->getNestedMetadata($resourceClass, $propertyParts['associations']);

        $field = $propertyParts['field'];

        return $metadata instanceof ClassMetadata && $metadata->hasField($field) ? $metadata->isNullable($field) : false;
    }
}

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\Doctrine\MongoDbOdm\Filter;
15
16	use ApiPlatform\Core\Bridge\Doctrine\Common\Filter\ExistsFilterInterface;
17	use ApiPlatform\Core\Bridge\Doctrine\Common\Filter\ExistsFilterTrait;
18	use Doctrine\ODM\MongoDB\Aggregation\Builder;
19	use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
20	use Doctrine\Persistence\ManagerRegistry;
21	use Psr\Log\LoggerInterface;
22	use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
23
24	/**
25	* Filters the collection by whether a property value exists or not.
26	*
27	* For each property passed, if the resource does not have such property or if
28	* the value is not one of ( "true" \| "false" \| "1" \| "0" ) the property is ignored.
29	*
30	* A query parameter with key but no value is treated as `true`, e.g.:
31	* Request: GET /products?exists[brand]
32	* Interpretation: filter products which have a brand
33	*
34	* @experimental
35	*
36	* @author Teoh Han Hui <teohhanhui@gmail.com>
37	* @author Alan Poulain <contact@alanpoulain.eu>
38	*/
39	final class ExistsFilter extends AbstractFilter implements ExistsFilterInterface
40	{
41	use ExistsFilterTrait;
42
43	public function __construct(ManagerRegistry $managerRegistry, LoggerInterface $logger = null, array $properties = null, string $existsParameterName = self::QUERY_PARAMETER_KEY, NameConverterInterface $nameConverter = null)
44	{
45	parent::__construct($managerRegistry, $logger, $properties, $nameConverter);	×
46
47	$this->existsParameterName = $existsParameterName;	×
48	}	×
49
50	/**
51	* {@inheritdoc}
52	*/
53	public function apply(Builder $aggregationBuilder, string $resourceClass, string $operationName = null, array &$context = [])
54	{
55	if (!\is_array($context['filters'][$this->existsParameterName] ?? null)) {	×
56	$context['exists_deprecated_syntax'] = true;	×
57	parent::apply($aggregationBuilder, $resourceClass, $operationName, $context);	×
58
59	return;	×
60	}
61
62	foreach ($context['filters'][$this->existsParameterName] as $property => $value) {	×
63	$this->filterProperty($this->denormalizePropertyName($property), $value, $aggregationBuilder, $resourceClass, $operationName, $context);	×
64	}
65	}	×
66
67	/**
68	* {@inheritdoc}
69	*/
70	protected function filterProperty(string $property, $value, Builder $aggregationBuilder, string $resourceClass, string $operationName = null, array &$context = [])
71	{
72	if (
73	(($context['exists_deprecated_syntax'] ?? false) && !isset($value[self::QUERY_PARAMETER_KEY])) \|\|	×
74	!$this->isPropertyEnabled($property, $resourceClass) \|\|	×
75	!$this->isPropertyMapped($property, $resourceClass, true) \|\|	×
76	!$this->isNullableField($property, $resourceClass)	×
77	) {
78	return;	×
79	}
80
81	$value = $this->normalizeValue($value, $property);	×
82	if (null === $value) {	×
83	return;	×
84	}
85
86	$matchField = $property;	×
87
88	if ($this->isPropertyNested($property, $resourceClass)) {	×
89	[$matchField] = $this->addLookupsForNestedProperty($property, $aggregationBuilder, $resourceClass);	×
90	}
91
92	$aggregationBuilder->match()->field($matchField)->{$value ? 'notEqual' : 'equals'}(null);	×
93	}	×
94
95	/**
96	* {@inheritdoc}
97	*/
98	protected function isNullableField(string $property, string $resourceClass): bool
99	{
100	$propertyParts = $this->splitPropertyParts($property, $resourceClass);	×
101	$metadata = $this->getNestedMetadata($resourceClass, $propertyParts['associations']);	×
102
103	$field = $propertyParts['field'];	×
104
105	return $metadata instanceof ClassMetadata && $metadata->hasField($field) ? $metadata->isNullable($field) : false;	×
106	}
107	}

api-platform / core / #26703

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