20001323174

Committed 07 Dec 2025 08:10AM UTC coverage: 25.292% (+0.001%) from 25.291%

Build # 20001323174

Build Type

push

github

Committed by

soyuka

Commit Message

chore: bump metadata to 4.3.x-dev

Run Details

14642 of 57891 relevant lines covered (25.29%)

28.94 hits per line

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

25.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\Filter\ManagerRegistryAwareInterface;
use ApiPlatform\Doctrine\Common\Filter\PropertyAwareFilterInterface;
use ApiPlatform\Doctrine\Common\PropertyHelperTrait;
use ApiPlatform\Doctrine\Odm\PropertyHelperTrait as MongoDbOdmPropertyHelperTrait;
use ApiPlatform\Metadata\Exception\RuntimeException;
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, PropertyAwareFilterInterface, ManagerRegistryAwareInterface
{
    use MongoDbOdmPropertyHelperTrait;
    use PropertyHelperTrait;
    protected LoggerInterface $logger;

    public function __construct(
        protected ?ManagerRegistry $managerRegistry = null,
        ?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.
     *
     * @param array<string, mixed> $context
     *
     * @param-out array<string, mixed> $context
     */
    abstract protected function filterProperty(string $property, mixed $value, Builder $aggregationBuilder, string $resourceClass, ?Operation $operation = null, array &$context = []): void;

    public function hasManagerRegistry(): bool
    {
        return $this->managerRegistry instanceof ManagerRegistry;
    }

    public function getManagerRegistry(): ManagerRegistry
    {
        if (!$this->hasManagerRegistry()) {
            throw new RuntimeException('ManagerRegistry must be initialized before accessing it.');
        }

        return $this->managerRegistry;
    }

    public function setManagerRegistry(ManagerRegistry $managerRegistry): void
    {
        $this->managerRegistry = $managerRegistry;
    }

    /**
     * @return array<string, mixed>|null
     */
    public function getProperties(): ?array
    {
        return $this->properties;
    }

    /**
     * @param array<string, mixed> $properties
     */
    public function setProperties(array $properties): void
    {
        $this->properties = $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 (string) $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\Filter\ManagerRegistryAwareInterface;
17	use ApiPlatform\Doctrine\Common\Filter\PropertyAwareFilterInterface;
18	use ApiPlatform\Doctrine\Common\PropertyHelperTrait;
19	use ApiPlatform\Doctrine\Odm\PropertyHelperTrait as MongoDbOdmPropertyHelperTrait;
20	use ApiPlatform\Metadata\Exception\RuntimeException;
21	use ApiPlatform\Metadata\Operation;
22	use Doctrine\ODM\MongoDB\Aggregation\Builder;
23	use Doctrine\Persistence\ManagerRegistry;
24	use Psr\Log\LoggerInterface;
25	use Psr\Log\NullLogger;
26	use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
27
28	/**
29	* {@inheritdoc}
30	*
31	* Abstract class for easing the implementation of a filter.
32	*
33	* @author Alan Poulain <contact@alanpoulain.eu>
34	*/
35	abstract class AbstractFilter implements FilterInterface, PropertyAwareFilterInterface, ManagerRegistryAwareInterface
36	{
37	use MongoDbOdmPropertyHelperTrait;
38	use PropertyHelperTrait;
39	protected LoggerInterface $logger;
40
41	public function __construct(
42	protected ?ManagerRegistry $managerRegistry = null,
43	?LoggerInterface $logger = null,
44	protected ?array $properties = null,
45	protected ?NameConverterInterface $nameConverter = null,
46	) {
47	$this->logger = $logger ?? new NullLogger();	2✔
48	}
49
50	/**
51	* {@inheritdoc}
52	*/
53	public function apply(Builder $aggregationBuilder, string $resourceClass, ?Operation $operation = null, array &$context = []): void
54	{
55	foreach ($context['filters'] as $property => $value) {	×
56	$this->filterProperty($this->denormalizePropertyName($property), $value, $aggregationBuilder, $resourceClass, $operation, $context);	×
57	}
58	}
59
60	/**
61	* Passes a property through the filter.
62	*
63	* @param array<string, mixed> $context
64	*
65	* @param-out array<string, mixed> $context
66	*/
67	abstract protected function filterProperty(string $property, mixed $value, Builder $aggregationBuilder, string $resourceClass, ?Operation $operation = null, array &$context = []): void;
68
69	public function hasManagerRegistry(): bool
70	{
71	return $this->managerRegistry instanceof ManagerRegistry;	2✔
72	}
73
74	public function getManagerRegistry(): ManagerRegistry
75	{
76	if (!$this->hasManagerRegistry()) {	2✔
77	throw new RuntimeException('ManagerRegistry must be initialized before accessing it.');	×
78	}
79
80	return $this->managerRegistry;	2✔
81	}
82
83	public function setManagerRegistry(ManagerRegistry $managerRegistry): void
84	{
85	$this->managerRegistry = $managerRegistry;	×
86	}
87
88	/**
89	* @return array<string, mixed>\|null
90	*/
91	public function getProperties(): ?array
92	{
93	return $this->properties;	2✔
94	}
95
96	/**
97	* @param array<string, mixed> $properties
98	*/
99	public function setProperties(array $properties): void
100	{
101	$this->properties = $properties;	×
102	}
103
104	protected function getLogger(): LoggerInterface
105	{
106	return $this->logger;	×
107	}
108
109	/**
110	* Determines whether the given property is enabled.
111	*/
112	protected function isPropertyEnabled(string $property, string $resourceClass): bool
113	{
114	if (null === $this->properties) {	×
115	// to ensure sanity, nested properties must still be explicitly enabled
116	return !$this->isPropertyNested($property, $resourceClass);	×
117	}
118
119	return \array_key_exists($property, $this->properties);	×
120	}
121
122	protected function denormalizePropertyName(string\|int $property): string
123	{
124	if (!$this->nameConverter instanceof NameConverterInterface) {	×
125	return (string) $property;	×
126	}
127
128	return implode('.', array_map($this->nameConverter->denormalize(...), explode('.', (string) $property)));	×
129	}
130
131	protected function normalizePropertyName(string $property): string
132	{
133	if (!$this->nameConverter instanceof NameConverterInterface) {	×
134	return $property;	×
135	}
136
137	return implode('.', array_map($this->nameConverter->normalize(...), explode('.', $property)));	×
138	}
139	}

api-platform / core / 20001323174

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