-
-
Notifications
You must be signed in to change notification settings - Fork 502
/
FilterCollection.php
163 lines (138 loc) · 3.85 KB
/
FilterCollection.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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
<?php
declare(strict_types=1);
namespace Doctrine\ODM\MongoDB\Query;
use Doctrine\ODM\MongoDB\Configuration;
use Doctrine\ODM\MongoDB\DocumentManager;
use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
use Doctrine\ODM\MongoDB\Query\Filter\BsonFilter;
use InvalidArgumentException;
use function array_map;
use function array_values;
use function assert;
use function is_string;
/**
* Collection class for all the query filters.
*/
final class FilterCollection
{
/**
* The used Configuration.
*
* @var Configuration
*/
private $config;
/**
* The DocumentManager that "owns" this FilterCollection instance.
*
* @var DocumentManager
*/
private $dm;
/**
* Instances of enabled filters.
*
* @var BsonFilter[]
*/
private $enabledFilters = [];
/**
* The CriteriaMerger instance.
*
* @var CriteriaMerger
*/
private $cm;
public function __construct(DocumentManager $dm, ?CriteriaMerger $cm = null)
{
$this->dm = $dm;
$this->cm = $cm ?: new CriteriaMerger();
$this->config = $dm->getConfiguration();
}
/**
* Get all the enabled filters.
*
* @return BsonFilter[]
*/
public function getEnabledFilters(): array
{
return $this->enabledFilters;
}
/**
* Enables a filter from the collection.
*
* @throws InvalidArgumentException If the filter does not exist.
*/
public function enable(string $name): BsonFilter
{
if (! $this->has($name)) {
throw new InvalidArgumentException("Filter '" . $name . "' does not exist.");
}
if (! $this->isEnabled($name)) {
$filterClass = $this->config->getFilterClassName($name);
assert(is_string($filterClass));
$filterParameters = $this->config->getFilterParameters($name);
$filter = new $filterClass($this->dm);
foreach ($filterParameters as $param => $value) {
$filter->setParameter($param, $value);
}
$this->enabledFilters[$name] = $filter;
}
return $this->enabledFilters[$name];
}
/**
* Disables a filter.
*
* @throws InvalidArgumentException If the filter does not exist.
*/
public function disable(string $name): BsonFilter
{
// Get the filter to return it
$filter = $this->getFilter($name);
unset($this->enabledFilters[$name]);
return $filter;
}
/**
* Get an enabled filter from the collection.
*
* @throws InvalidArgumentException If the filter is not enabled.
*/
public function getFilter(string $name): BsonFilter
{
if (! $this->isEnabled($name)) {
throw new InvalidArgumentException("Filter '" . $name . "' is not enabled.");
}
return $this->enabledFilters[$name];
}
/**
* Checks whether filter with given name is defined.
*
* @param string $name Name of the filter.
*
* @return bool true if the filter exists, false if not.
*/
public function has(string $name): bool
{
return $this->config->getFilterClassName($name) !== null;
}
/**
* Checks whether filter with given name is enabled.
*/
public function isEnabled(string $name): bool
{
return isset($this->enabledFilters[$name]);
}
/**
* Gets enabled filter criteria.
*/
public function getFilterCriteria(ClassMetadata $class): array
{
if (empty($this->enabledFilters)) {
return [];
}
return $this->cm->merge(
...array_map(
static function ($filter) use ($class) {
return $filter->addFilterCriteria($class);
},
array_values($this->enabledFilters)
)
);
}
}