-
Notifications
You must be signed in to change notification settings - Fork 351
/
FilterValueAccessorInterface.php
57 lines (48 loc) · 1.41 KB
/
FilterValueAccessorInterface.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
<?php
namespace Oro\Bundle\ApiBundle\Filter;
/**
* Provides an interface of a collection of the FilterValue objects.
*/
interface FilterValueAccessorInterface extends QueryStringAccessorInterface
{
/**
* Checks whether a filter value with the given key exists.
* In additional finds the filter value in the default filter's group if it is set.
*/
public function has(string $key): bool;
/**
* Gets a filter value by its key.
* In additional finds the filter value in the default filter's group if it is set.
*/
public function get(string $key): ?FilterValue;
/**
* Gets all filter values from the given group.
*
* @param string $group
*
* @return FilterValue[] [filter key => FilterValue, ...]
*/
public function getGroup(string $group): array;
/**
* Gets the name of default filter's group.
*/
public function getDefaultGroupName(): ?string;
/**
* Sets the name of default filter's group.
*/
public function setDefaultGroupName(?string $group): void;
/**
* Gets all filter values.
*
* @return FilterValue[] [filter key => FilterValue, ...]
*/
public function getAll(): array;
/**
* Sets a filter value.
*/
public function set(string $key, ?FilterValue $value): void;
/**
* Removes a filter value.
*/
public function remove(string $key): void;
}