|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
declare(strict_types=1); |
|
4
|
|
|
|
|
5
|
|
|
namespace Arp\LaminasDoctrine\Query; |
|
6
|
|
|
|
|
7
|
|
|
use Arp\LaminasDoctrine\Query\Exception\QueryFilterException; |
|
8
|
|
|
use Arp\LaminasDoctrine\Query\Exception\QueryFilterManagerException; |
|
9
|
|
|
use Arp\LaminasDoctrine\Query\Filter\FilterInterface; |
|
10
|
|
|
use Arp\LaminasDoctrine\Query\Filter\FilterManager; |
|
11
|
|
|
use Arp\LaminasDoctrine\Query\Metadata\Metadata; |
|
12
|
|
|
use Arp\LaminasDoctrine\Query\Metadata\MetadataInterface; |
|
13
|
|
|
use Doctrine\ORM\EntityManager; |
|
14
|
|
|
use Doctrine\ORM\QueryBuilder as DoctrineQueryBuilder; |
|
15
|
|
|
|
|
16
|
|
|
/** |
|
17
|
|
|
* @author Alex Patterson <[email protected]> |
|
18
|
|
|
* @package Arp\LaminasDoctrine\Query |
|
19
|
|
|
*/ |
|
20
|
|
|
class QueryFilterManager |
|
21
|
|
|
{ |
|
22
|
|
|
/** |
|
23
|
|
|
* @var FilterManager |
|
24
|
|
|
*/ |
|
25
|
|
|
private FilterManager $filterManager; |
|
26
|
|
|
|
|
27
|
|
|
/** |
|
28
|
|
|
* @param FilterManager $filterManager |
|
29
|
|
|
*/ |
|
30
|
|
|
public function __construct(FilterManager $filterManager) |
|
31
|
|
|
{ |
|
32
|
|
|
$this->filterManager = $filterManager; |
|
33
|
|
|
} |
|
34
|
|
|
|
|
35
|
|
|
/** |
|
36
|
|
|
* Apply the query filters to the provided query builder instance |
|
37
|
|
|
* |
|
38
|
|
|
* @param DoctrineQueryBuilder|QueryBuilderInterface $queryBuilder |
|
39
|
|
|
* @param string $entityName |
|
40
|
|
|
* @param array $criteria |
|
41
|
|
|
* |
|
42
|
|
|
* @throws QueryFilterManagerException |
|
43
|
|
|
*/ |
|
44
|
|
|
public function filter($queryBuilder, string $entityName, array $criteria): void |
|
45
|
|
|
{ |
|
46
|
|
|
if (empty($criteria['filters']) || !is_array($criteria['filters'])) { |
|
47
|
|
|
return; |
|
48
|
|
|
} |
|
49
|
|
|
|
|
50
|
|
|
$queryBuilder = $this->getQueryBuilder($queryBuilder); |
|
51
|
|
|
$metadata = $this->createMetadataProxy($queryBuilder->getEntityManager(), $entityName); |
|
52
|
|
|
|
|
53
|
|
|
foreach ($criteria['filters'] as $data) { |
|
54
|
|
|
try { |
|
55
|
|
|
$this->applyFilter($queryBuilder, $metadata, $data); |
|
56
|
|
|
} catch (QueryFilterException $e) { |
|
57
|
|
|
throw new QueryFilterManagerException( |
|
58
|
|
|
sprintf( |
|
59
|
|
|
'An error occurred while attempting to apply the query filters for entity \'%s\': %s', |
|
60
|
|
|
$entityName, |
|
61
|
|
|
$e->getMessage() |
|
62
|
|
|
), |
|
63
|
|
|
$e->getCode(), |
|
64
|
|
|
$e |
|
65
|
|
|
); |
|
66
|
|
|
} |
|
67
|
|
|
} |
|
68
|
|
|
} |
|
69
|
|
|
|
|
70
|
|
|
/** |
|
71
|
|
|
* @param QueryBuilderInterface|DoctrineQueryBuilder $queryBuilder |
|
72
|
|
|
* |
|
73
|
|
|
* @return QueryBuilderInterface |
|
74
|
|
|
* |
|
75
|
|
|
* @throws QueryFilterManagerException |
|
76
|
|
|
*/ |
|
77
|
|
|
private function getQueryBuilder($queryBuilder): QueryBuilderInterface |
|
78
|
|
|
{ |
|
79
|
|
|
if ($queryBuilder instanceof DoctrineQueryBuilder) { |
|
80
|
|
|
$queryBuilder = $this->createQueryBuilderProxy($queryBuilder); |
|
81
|
|
|
} |
|
82
|
|
|
|
|
83
|
|
|
if (!$queryBuilder instanceof QueryBuilderInterface) { |
|
84
|
|
|
throw new QueryFilterManagerException( |
|
85
|
|
|
sprintf( |
|
86
|
|
|
'The \'queryBuilder\' argument must be an object of type \'%s\' or \'%s\'; ' |
|
87
|
|
|
. '\'%s\' provided in \'%s\'', |
|
88
|
|
|
QueryBuilderInterface::class, |
|
89
|
|
|
DoctrineQueryBuilder::class, |
|
90
|
|
|
is_object($queryBuilder) ? get_class($queryBuilder) : gettype($queryBuilder), |
|
91
|
|
|
static::class |
|
92
|
|
|
) |
|
93
|
|
|
); |
|
94
|
|
|
} |
|
95
|
|
|
|
|
96
|
|
|
return $queryBuilder; |
|
97
|
|
|
} |
|
98
|
|
|
|
|
99
|
|
|
/** |
|
100
|
|
|
* @param QueryBuilderInterface $queryBuilder |
|
101
|
|
|
* @param MetadataInterface $metadata |
|
102
|
|
|
* @param array $data |
|
103
|
|
|
* |
|
104
|
|
|
* @throws QueryFilterException |
|
105
|
|
|
*/ |
|
106
|
|
|
private function applyFilter(QueryBuilderInterface $queryBuilder, MetadataInterface $metadata, array $data): void |
|
107
|
|
|
{ |
|
108
|
|
|
$filterName = $data['name'] ?? null; |
|
109
|
|
|
|
|
110
|
|
|
if (empty($filterName)) { |
|
111
|
|
|
throw new QueryFilterException( |
|
112
|
|
|
sprintf('The required \'name\' query filter configuration option is missing in \'%s\'', __METHOD__) |
|
113
|
|
|
); |
|
114
|
|
|
} |
|
115
|
|
|
|
|
116
|
|
|
$filter = $this->createFilter($filterName, $data['options'] ?? []); |
|
117
|
|
|
$filter->filter($queryBuilder, $metadata, $data); |
|
118
|
|
|
} |
|
119
|
|
|
|
|
120
|
|
|
/** |
|
121
|
|
|
* @param string $name |
|
122
|
|
|
* @param array $options |
|
123
|
|
|
* |
|
124
|
|
|
* @return FilterInterface |
|
125
|
|
|
* |
|
126
|
|
|
* @throws QueryFilterException |
|
127
|
|
|
*/ |
|
128
|
|
|
private function createFilter(string $name, array $options = []): FilterInterface |
|
129
|
|
|
{ |
|
130
|
|
|
try { |
|
131
|
|
|
/** @var FilterInterface $filter */ |
|
132
|
|
|
return $this->filterManager->build( |
|
133
|
|
|
$name, |
|
134
|
|
|
array_replace_recursive($options, ['query_filter_manager' => $this]) |
|
135
|
|
|
); |
|
136
|
|
|
} catch (\Throwable $e) { |
|
137
|
|
|
throw new QueryFilterException( |
|
138
|
|
|
sprintf('Failed to build query filter \'%s\': %s', $name, $e->getMessage()), |
|
139
|
|
|
$e->getCode(), |
|
140
|
|
|
$e |
|
141
|
|
|
); |
|
142
|
|
|
} |
|
143
|
|
|
} |
|
144
|
|
|
|
|
145
|
|
|
/** |
|
146
|
|
|
* @param EntityManager $entityManager |
|
147
|
|
|
* @param string $entityName |
|
148
|
|
|
* |
|
149
|
|
|
* @return MetadataInterface |
|
150
|
|
|
* |
|
151
|
|
|
* @throws QueryFilterManagerException |
|
152
|
|
|
*/ |
|
153
|
|
|
private function createMetadataProxy(EntityManager $entityManager, string $entityName): MetadataInterface |
|
154
|
|
|
{ |
|
155
|
|
|
try { |
|
156
|
|
|
return new Metadata($entityManager->getClassMetadata($entityName)); |
|
157
|
|
|
} catch (\Throwable $e) { |
|
158
|
|
|
throw new QueryFilterManagerException( |
|
159
|
|
|
sprintf('Failed to fetch entity metadata for class \'%s\': %s', $entityName, $e->getMessage()), |
|
160
|
|
|
$e->getCode(), |
|
161
|
|
|
$e |
|
162
|
|
|
); |
|
163
|
|
|
} |
|
164
|
|
|
} |
|
165
|
|
|
|
|
166
|
|
|
/** |
|
167
|
|
|
* @param DoctrineQueryBuilder $queryBuilder |
|
168
|
|
|
* |
|
169
|
|
|
* @return QueryBuilderInterface |
|
170
|
|
|
*/ |
|
171
|
|
|
private function createQueryBuilderProxy(DoctrineQueryBuilder $queryBuilder): QueryBuilderInterface |
|
172
|
|
|
{ |
|
173
|
|
|
return new QueryBuilder($queryBuilder); |
|
174
|
|
|
} |
|
175
|
|
|
} |
|
176
|
|
|
|
alex-patterson-webdev /
laminas-doctrine-query-filter
