3904303394

Build Type

github

Committed by GitHub

Commit Message

Merge 2e0a3ceae into 965332bc8

Pull Request Pull Request #5332: Revert "chore(deprecation): Only use ValueResolverInterface if it exists"

Run Details

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

7939 of 12085 relevant lines covered (65.69%)

81.77 hits per line

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

0.0

/src/Doctrine/Odm/Filter/AbstractFilter.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\Doctrine\Odm\Filter;

use ApiPlatform\Doctrine\Common\PropertyHelperTrait;
use ApiPlatform\Doctrine\Odm\PropertyHelperTrait as MongoDbOdmPropertyHelperTrait;
use ApiPlatform\Metadata\Operation;
use Doctrine\ODM\MongoDB\Aggregation\Builder;
use Doctrine\Persistence\ManagerRegistry;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
use Symfony\Component\Serializer\NameConverter\NameConverterInterface;

/**
 * {@inheritdoc}
 *
 * Abstract class for easing the implementation of a filter.
 *
 * @author Alan Poulain <contact@alanpoulain.eu>
 */
abstract class AbstractFilter implements FilterInterface
{
    use MongoDbOdmPropertyHelperTrait;
    use PropertyHelperTrait;
    protected LoggerInterface $logger;

    public function __construct(protected ManagerRegistry $managerRegistry, LoggerInterface $logger = null, protected ?array $properties = null, protected ?NameConverterInterface $nameConverter = null)
    {
        $this->logger = $logger ?? new NullLogger();
    }

    /**
     * {@inheritdoc}
     */
    public function apply(Builder $aggregationBuilder, string $resourceClass, Operation $operation = null, array &$context = []): void
    {
        foreach ($context['filters'] as $property => $value) {
            $this->filterProperty($this->denormalizePropertyName($property), $value, $aggregationBuilder, $resourceClass, $operation, $context);
        }
    }

    /**
     * Passes a property through the filter.
     */
    abstract protected function filterProperty(string $property, $value, Builder $aggregationBuilder, string $resourceClass, Operation $operation = null, array &$context = []): void;

    protected function getManagerRegistry(): ManagerRegistry
    {
        return $this->managerRegistry;
    }

    protected function getProperties(): ?array
    {
        return $this->properties;
    }

    protected function getLogger(): LoggerInterface
    {
        return $this->logger;
    }

    /**
     * Determines whether the given property is enabled.
     */
    protected function isPropertyEnabled(string $property, string $resourceClass): bool
    {
        if (null === $this->properties) {
            // to ensure sanity, nested properties must still be explicitly enabled
            return !$this->isPropertyNested($property, $resourceClass);
        }

        return \array_key_exists($property, $this->properties);
    }

    protected function denormalizePropertyName(string|int $property): string
    {
        if (!$this->nameConverter instanceof NameConverterInterface) {
            return $property;
        }

        return implode('.', array_map($this->nameConverter->denormalize(...), explode('.', (string) $property)));
    }

    protected function normalizePropertyName(string $property): string
    {
        if (!$this->nameConverter instanceof NameConverterInterface) {
            return $property;
        }

        return implode('.', array_map($this->nameConverter->normalize(...), explode('.', $property)));
    }
}

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\Doctrine\Odm\Filter;
15
16	use ApiPlatform\Doctrine\Common\PropertyHelperTrait;
17	use ApiPlatform\Doctrine\Odm\PropertyHelperTrait as MongoDbOdmPropertyHelperTrait;
18	use ApiPlatform\Metadata\Operation;
19	use Doctrine\ODM\MongoDB\Aggregation\Builder;
20	use Doctrine\Persistence\ManagerRegistry;
21	use Psr\Log\LoggerInterface;
22	use Psr\Log\NullLogger;
23	use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
24
25	/**
26	* {@inheritdoc}
27	*
28	* Abstract class for easing the implementation of a filter.
29	*
30	* @author Alan Poulain <contact@alanpoulain.eu>
31	*/
32	abstract class AbstractFilter implements FilterInterface
33	{
34	use MongoDbOdmPropertyHelperTrait;
35	use PropertyHelperTrait;
36	protected LoggerInterface $logger;
37
38	public function __construct(protected ManagerRegistry $managerRegistry, LoggerInterface $logger = null, protected ?array $properties = null, protected ?NameConverterInterface $nameConverter = null)
39	{
40	$this->logger = $logger ?? new NullLogger();	×
41	}
42
43	/**
44	* {@inheritdoc}
45	*/
46	public function apply(Builder $aggregationBuilder, string $resourceClass, Operation $operation = null, array &$context = []): void
47	{
48	foreach ($context['filters'] as $property => $value) {	×
49	$this->filterProperty($this->denormalizePropertyName($property), $value, $aggregationBuilder, $resourceClass, $operation, $context);	×
50	}
51	}
52
53	/**
54	* Passes a property through the filter.
55	*/
56	abstract protected function filterProperty(string $property, $value, Builder $aggregationBuilder, string $resourceClass, Operation $operation = null, array &$context = []): void;
57
58	protected function getManagerRegistry(): ManagerRegistry
59	{
60	return $this->managerRegistry;	×
61	}
62
63	protected function getProperties(): ?array
64	{
65	return $this->properties;	×
66	}
67
68	protected function getLogger(): LoggerInterface
69	{
70	return $this->logger;	×
71	}
72
73	/**
74	* Determines whether the given property is enabled.
75	*/
76	protected function isPropertyEnabled(string $property, string $resourceClass): bool
77	{
78	if (null === $this->properties) {	×
79	// to ensure sanity, nested properties must still be explicitly enabled
80	return !$this->isPropertyNested($property, $resourceClass);	×
81	}
82
83	return \array_key_exists($property, $this->properties);	×
84	}
85
86	protected function denormalizePropertyName(string\|int $property): string
87	{
88	if (!$this->nameConverter instanceof NameConverterInterface) {	×
89	return $property;	×
90	}
91
92	return implode('.', array_map($this->nameConverter->denormalize(...), explode('.', (string) $property)));	×
93	}
94
95	protected function normalizePropertyName(string $property): string
96	{
97	if (!$this->nameConverter instanceof NameConverterInterface) {	×
98	return $property;	×
99	}
100
101	return implode('.', array_map($this->nameConverter->normalize(...), explode('.', $property)));	×
102	}
103	}

api-platform / core / 3904303394

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