15133993414

Committed 20 May 2025 09:30AM UTC coverage: 26.313% (-1.2%) from 27.493%

Build # 15133993414

Build Type

Pull #7161

github

Committed by

web-flow

Commit Message

Merge e2c03d45f into 5459ba375

Pull Request Pull Request #7161: fix(metadata): infer parameter string type from schema

Run Details

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

11019 existing lines in 363 files now uncovered.

12898 of 49018 relevant lines covered (26.31%)

34.33 hits per line

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

66.67

/src/Doctrine/Common/Filter/ExistsFilterTrait.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\Common\Filter;

use ApiPlatform\Doctrine\Common\PropertyHelperTrait;
use ApiPlatform\Metadata\Exception\InvalidArgumentException;
use Psr\Log\LoggerInterface;

/**
 * Trait for filtering the collection by whether a property value exists or not.
 *
 * @author Teoh Han Hui <teohhanhui@gmail.com>
 * @author Alan Poulain <contact@alanpoulain.eu>
 */
trait ExistsFilterTrait
{
    use PropertyHelperTrait;

    /**
     * @var string Keyword used to retrieve the value
     */
    private readonly string $existsParameterName;

    /**
     * {@inheritdoc}
     */
    public function getDescription(string $resourceClass): array
    {
        $description = [];

        $properties = $this->getProperties();
        if (null === $properties) {
            $properties = array_fill_keys($this->getClassMetadata($resourceClass)->getFieldNames(), null);
        }

        foreach ($properties as $property => $unused) {
            if (!$this->isPropertyMapped($property, $resourceClass, true) || !$this->isNullableField($property, $resourceClass)) {
                continue;
            }
            $propertyName = $this->normalizePropertyName($property);
            $description[\sprintf('%s[%s]', $this->existsParameterName, $propertyName)] = [
                'property' => $propertyName,
                'type' => 'bool',
                'required' => false,
            ];
        }

        return $description;
    }

    /**
     * Determines whether the given property refers to a nullable field.
     */
    abstract protected function isNullableField(string $property, string $resourceClass): bool;

    abstract protected function getProperties(): ?array;

    abstract protected function getLogger(): LoggerInterface;

    abstract protected function normalizePropertyName(string $property): string;

    private function normalizeValue($value, string $property): ?bool
    {
        if (\in_array($value, [true, 'true', '1', '', null], true)) {
            return true;
        }

        if (\in_array($value, [false, 'false', '0'], true)) {
            return false;
        }

        $this->getLogger()->notice('Invalid filter ignored', [
            'exception' => new InvalidArgumentException(\sprintf('Invalid value for "%s[%s]", expected one of ( "%s" )', $this->existsParameterName, $property, implode('" | "', [
                'true',
                'false',
                '1',
                '0',
            ]))),
        ]);

        return null;
    }
}

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\Common\Filter;
15
16	use ApiPlatform\Doctrine\Common\PropertyHelperTrait;
17	use ApiPlatform\Metadata\Exception\InvalidArgumentException;
18	use Psr\Log\LoggerInterface;
19
20	/**
21	* Trait for filtering the collection by whether a property value exists or not.
22	*
23	* @author Teoh Han Hui <teohhanhui@gmail.com>
24	* @author Alan Poulain <contact@alanpoulain.eu>
25	*/
26	trait ExistsFilterTrait
27	{
28	use PropertyHelperTrait;
29
30	/**
31	* @var string Keyword used to retrieve the value
32	*/
33	private readonly string $existsParameterName;
34
35	/**
36	* {@inheritdoc}
37	*/
38	public function getDescription(string $resourceClass): array
39	{
UNCOV 40	$description = [];	219✔
41
UNCOV 42	$properties = $this->getProperties();	219✔
UNCOV 43	if (null === $properties) {	219✔
UNCOV 44	$properties = array_fill_keys($this->getClassMetadata($resourceClass)->getFieldNames(), null);	2✔
45	}
46
UNCOV 47	foreach ($properties as $property => $unused) {	218✔
UNCOV 48	if (!$this->isPropertyMapped($property, $resourceClass, true) \|\| !$this->isNullableField($property, $resourceClass)) {	218✔
UNCOV 49	continue;	84✔
50	}
UNCOV 51	$propertyName = $this->normalizePropertyName($property);	216✔
UNCOV 52	$description[\sprintf('%s[%s]', $this->existsParameterName, $propertyName)] = [	216✔
UNCOV 53	'property' => $propertyName,	216✔
UNCOV 54	'type' => 'bool',	216✔
UNCOV 55	'required' => false,	216✔
UNCOV 56	];	216✔
57	}
58
UNCOV 59	return $description;	218✔
60	}
61
62	/**
63	* Determines whether the given property refers to a nullable field.
64	*/
65	abstract protected function isNullableField(string $property, string $resourceClass): bool;
66
67	abstract protected function getProperties(): ?array;
68
69	abstract protected function getLogger(): LoggerInterface;
70
71	abstract protected function normalizePropertyName(string $property): string;
72
73	private function normalizeValue($value, string $property): ?bool
74	{
UNCOV 75	if (\in_array($value, [true, 'true', '1', '', null], true)) {	12✔
UNCOV 76	return true;	7✔
77	}
78
UNCOV 79	if (\in_array($value, [false, 'false', '0'], true)) {	5✔
UNCOV 80	return false;	5✔
81	}
82
83	$this->getLogger()->notice('Invalid filter ignored', [	×
84	'exception' => new InvalidArgumentException(\sprintf('Invalid value for "%s[%s]", expected one of ( "%s" )', $this->existsParameterName, $property, implode('" \| "', [	×
85	'true',	×
86	'false',	×
87	'1',	×
88	'0',	×
89	]))),	×
90	]);	×
91
92	return null;	×
93	}
94	}

api-platform / core / 15133993414

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