/
BooleanFilter.php
118 lines (102 loc) · 3.77 KB
/
BooleanFilter.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
<?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.
*/
namespace ApiPlatform\Core\Bridge\Doctrine\Orm\Filter;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
use ApiPlatform\Core\Exception\InvalidArgumentException;
use Doctrine\DBAL\Types\Type as DBALType;
use Doctrine\ORM\QueryBuilder;
/**
* Filters the collection by boolean values.
*
* Filters collection on equality of boolean properties. The value is specified
* as one of ( "true" | "false" | "1" | "0" ) in the query.
*
* 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.
*
* @author Amrouche Hamza <hamza.simperfit@gmail.com>
* @author Teoh Han Hui <teohhanhui@gmail.com>
*/
class BooleanFilter extends AbstractFilter
{
/**
* {@inheritdoc}
*/
public function getDescription(string $resourceClass) : array
{
$description = [];
$properties = $this->properties;
if (null === $properties) {
$properties = array_fill_keys($this->getClassMetadata($resourceClass)->getFieldNames(), null);
}
foreach ($properties as $property => $unused) {
if (!$this->isPropertyMapped($property, $resourceClass) || !$this->isBooleanField($property, $resourceClass)) {
continue;
}
$description[$property] = [
'property' => $property,
'type' => 'bool',
'required' => false,
];
}
return $description;
}
/**
* {@inheritdoc}
*/
protected function filterProperty(string $property, $value, QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $operationName = null)
{
if (
!$this->isPropertyEnabled($property) ||
!$this->isPropertyMapped($property, $resourceClass) ||
!$this->isBooleanField($property, $resourceClass)
) {
return;
}
if (in_array($value, ['true', '1'], true)) {
$value = true;
} elseif (in_array($value, ['false', '0'], true)) {
$value = false;
} else {
$this->logger->notice('Invalid filter ignored', [
'exception' => new InvalidArgumentException(sprintf('Invalid boolean value for "%s" property, expected one of ( "%s" )', $property, implode('" | "', [
'true',
'false',
'1',
'0',
]))),
]);
return;
}
$alias = 'o';
$field = $property;
if ($this->isPropertyNested($property)) {
list($alias, $field) = $this->addJoinsForNestedProperty($property, $alias, $queryBuilder, $queryNameGenerator);
}
$valueParameter = $queryNameGenerator->generateParameterName($field);
$queryBuilder
->andWhere(sprintf('%s.%s = :%s', $alias, $field, $valueParameter))
->setParameter($valueParameter, $value);
}
/**
* Determines whether the given property refers to a boolean field.
*
* @param string $property
* @param string $resourceClass
*
* @return bool
*/
protected function isBooleanField(string $property, string $resourceClass) : bool
{
$propertyParts = $this->splitPropertyParts($property);
$metadata = $this->getNestedMetadata($resourceClass, $propertyParts['associations']);
return DBALType::BOOLEAN === $metadata->getTypeOfField($propertyParts['field']);
}
}