1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
declare(strict_types=1); |
4
|
|
|
|
5
|
|
|
namespace Werkspot\KvkApi\Http\Search; |
6
|
|
|
|
7
|
|
|
final class SearchQuery implements QueryInterface |
8
|
|
|
{ |
9
|
|
|
/** |
10
|
|
|
* @info KvK number, identifying number for a registration in the Netherlands Business Register. Consists of 8 digits |
11
|
|
|
* @var string |
12
|
|
|
*/ |
13
|
|
|
private $kvkNumber; |
14
|
|
|
|
15
|
|
|
/** |
16
|
|
|
* @info Branch number (Vestigingsnummer), identifying number of a branch. Consists of 12 digits |
17
|
|
|
* @var string |
18
|
|
|
*/ |
19
|
|
|
private $branchNumber; |
20
|
|
|
|
21
|
|
|
/** |
22
|
|
|
* @info RSIN is an identification number for legal entities and partnerships. Consist of only digits |
23
|
|
|
* @var int |
24
|
|
|
*/ |
25
|
|
|
private $rsin; |
26
|
|
|
|
27
|
|
|
/** |
28
|
|
|
* @info Street of an address |
29
|
|
|
* @var string |
30
|
|
|
*/ |
31
|
|
|
private $street; |
32
|
|
|
|
33
|
|
|
/** |
34
|
|
|
* @info House number of an address |
35
|
|
|
* @var string |
36
|
|
|
*/ |
37
|
|
|
private $houseNumber; |
38
|
|
|
|
39
|
|
|
/** |
40
|
|
|
* @info Postal code or ZIP code, example 1000AA |
41
|
|
|
* @var string |
42
|
|
|
*/ |
43
|
|
|
private $postalCode; |
44
|
|
|
|
45
|
|
|
/** |
46
|
|
|
* @info City or Town name |
47
|
|
|
* @var string |
48
|
|
|
*/ |
49
|
|
|
private $city; |
50
|
|
|
|
51
|
|
|
/** |
52
|
|
|
* @info Indication to include searching through inactive dossiers/deregistered companies. |
53
|
|
|
* @note History of inactive companies is after 1 January 2012 |
54
|
|
|
* @var bool |
55
|
|
|
*/ |
56
|
|
|
private $includeInactiveRegistrations; |
57
|
|
|
|
58
|
|
|
/** |
59
|
|
|
* @info restrictToMainBranch Search is restricted to main branches. |
60
|
|
|
* @var bool |
61
|
|
|
*/ |
62
|
|
|
private $restrictToMainBranch; |
63
|
|
|
|
64
|
|
|
/** |
65
|
|
|
* @info Defines the search collection for the query |
66
|
|
|
* @var string |
67
|
|
|
*/ |
68
|
|
|
private $site; |
69
|
|
|
|
70
|
|
|
/** |
71
|
|
|
* @info User can optionally add a context to identify his result later on |
72
|
|
|
* @var string |
73
|
|
|
*/ |
74
|
|
|
private $context; |
75
|
|
|
|
76
|
|
|
/** |
77
|
|
|
* @info Free format text search for in the compiled search description. |
78
|
|
|
* @var string |
79
|
|
|
*/ |
80
|
|
|
private $q; |
81
|
|
|
|
82
|
|
|
public function getStreet(): string |
83
|
|
|
{ |
84
|
|
|
return $this->street; |
85
|
|
|
} |
86
|
|
|
|
87
|
|
|
public function setStreet(string $street): void |
88
|
|
|
{ |
89
|
|
|
$this->street = $street; |
90
|
|
|
} |
91
|
|
|
|
92
|
|
|
public function getHouseNumber(): string |
93
|
|
|
{ |
94
|
|
|
return $this->houseNumber; |
95
|
|
|
} |
96
|
|
|
|
97
|
|
|
public function setHouseNumber(string $houseNumber): void |
98
|
|
|
{ |
99
|
|
|
$this->houseNumber = $houseNumber; |
100
|
|
|
} |
101
|
|
|
|
102
|
|
|
public function getKvkNumber(): string |
103
|
|
|
{ |
104
|
|
|
return $this->kvkNumber; |
105
|
|
|
} |
106
|
|
|
|
107
|
|
|
public function setKvkNumber(string $kvkNumber): void |
108
|
|
|
{ |
109
|
|
|
$this->kvkNumber = $kvkNumber; |
110
|
|
|
} |
111
|
|
|
|
112
|
|
|
public function getBranchNumber(): string |
113
|
|
|
{ |
114
|
|
|
return $this->branchNumber; |
115
|
|
|
} |
116
|
|
|
|
117
|
|
|
public function setBranchNumber(string $branchNumber): void |
118
|
|
|
{ |
119
|
|
|
$this->branchNumber = $branchNumber; |
120
|
|
|
} |
121
|
|
|
|
122
|
|
|
public function getRsin(): int |
123
|
|
|
{ |
124
|
|
|
return $this->rsin; |
125
|
|
|
} |
126
|
|
|
|
127
|
|
|
public function setRsin(int $rsin): void |
128
|
|
|
{ |
129
|
|
|
$this->rsin = $rsin; |
130
|
|
|
} |
131
|
|
|
|
132
|
|
|
public function getPostalCode(): string |
133
|
|
|
{ |
134
|
|
|
return $this->postalCode; |
135
|
|
|
} |
136
|
|
|
|
137
|
|
|
public function setPostalCode(string $postalCode): void |
138
|
|
|
{ |
139
|
|
|
$this->postalCode = $postalCode; |
140
|
|
|
} |
141
|
|
|
|
142
|
|
|
public function getCity(): string |
143
|
|
|
{ |
144
|
|
|
return $this->city; |
145
|
|
|
} |
146
|
|
|
|
147
|
|
|
public function setCity(string $city): void |
148
|
|
|
{ |
149
|
|
|
$this->city = $city; |
150
|
|
|
} |
151
|
|
|
|
152
|
|
|
public function isIncludeInactiveRegistrations(): bool |
153
|
|
|
{ |
154
|
|
|
return $this->includeInactiveRegistrations; |
155
|
|
|
} |
156
|
|
|
|
157
|
|
|
public function setIncludeInactiveRegistrations(bool $includeInactiveRegistrations): void |
158
|
|
|
{ |
159
|
|
|
$this->includeInactiveRegistrations = $includeInactiveRegistrations; |
160
|
|
|
} |
161
|
|
|
|
162
|
|
|
public function isRestrictToMainBranch(): bool |
163
|
|
|
{ |
164
|
|
|
return $this->restrictToMainBranch; |
165
|
|
|
} |
166
|
|
|
|
167
|
|
|
public function setRestrictToMainBranch(bool $restrictToMainBranch): void |
168
|
|
|
{ |
169
|
|
|
$this->restrictToMainBranch = $restrictToMainBranch; |
170
|
|
|
} |
171
|
|
|
|
172
|
|
|
public function getSite(): string |
173
|
|
|
{ |
174
|
|
|
return $this->site; |
175
|
|
|
} |
176
|
|
|
|
177
|
|
|
public function setSite(string $site): void |
178
|
|
|
{ |
179
|
|
|
$this->site = $site; |
180
|
|
|
} |
181
|
|
|
|
182
|
|
|
public function getContext(): string |
183
|
|
|
{ |
184
|
|
|
return $this->context; |
185
|
|
|
} |
186
|
|
|
|
187
|
|
|
public function setContext(string $context): void |
188
|
|
|
{ |
189
|
|
|
$this->context = $context; |
190
|
|
|
} |
191
|
|
|
|
192
|
|
|
public function getQ(): string |
193
|
|
|
{ |
194
|
|
|
return $this->q; |
195
|
|
|
} |
196
|
|
|
|
197
|
|
|
public function setQ(string $q): void |
198
|
|
|
{ |
199
|
|
|
$this->q = $q; |
200
|
|
|
} |
201
|
|
|
|
202
|
|
|
public function get(): array |
203
|
|
|
{ |
204
|
|
|
return get_object_vars($this); |
205
|
|
|
} |
206
|
|
|
} |
207
|
|
|
|