-
Notifications
You must be signed in to change notification settings - Fork 0
/
ParameterBag.php
196 lines (165 loc) · 4.13 KB
/
ParameterBag.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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
<?php
namespace AB\Iploka\Entity;
use AB\Iploka\Exceptions\InvalidParameterException;
class ParameterBag
{
const PROTOCOL_HTTP = 'http';
const PROTOCOL_HTTPS = 'https';
const FORMAT_JSON = 'json';
const FORMAT_XML = 'xml';
const FIELDS = [
"main",
"ip",
"hostname",
"type",
"continent_code",
"continent_name",
"country_code",
"country_name",
"region_code",
"region_name",
"city",
"zip",
"latitude",
"longitude",
"location",
"location.geoname_id",
"location.capital",
"location.languages",
"location.languages.code",
"location.languages.name",
"native.location.languages",
"country_flag",
"country_flag_emoji",
"country_flag_emoji_unicode",
"calling_code",
"is_eu"
];
private static $formats = [
self::FORMAT_JSON,
self::FORMAT_XML
];
private static $protocols = [self::PROTOCOL_HTTP, self::PROTOCOL_HTTPS];
/**
* @var string
*/
protected $key;
/**
* @var string
*/
protected $protocol;
/**
* @var array
*/
protected $fields;
/**
* @var string
*/
protected $format;
/**
* @param string|null $key
*/
public function __construct($key = null)
{
$this->key = $key;
$this->protocol = self::PROTOCOL_HTTPS;
$this->fields = [];
$this->format = self::FORMAT_JSON;
}
/**
* @return string|null
*/
public function getKey(): ?string
{
return $this->key;
}
/**
* @return string
*/
public function getProtocol(): string
{
return $this->protocol;
}
/**
* @param string $protocol
* @return ParameterBag
*/
public function setProtocol(string $protocol): ParameterBag
{
if (!in_array($protocol, self::$protocols)) {
throw new InvalidParameterException(sprintf("Invalid protocol '%s'. Please, use one of existing protocols [%s]", $protocol, implode(',', self::$protocols)));
}
$this->protocol = $protocol;
return $this;
}
/**
* @return string
*/
public function getFormat(): string
{
return $this->format;
}
/**
* @param string $format
* @return ParameterBag
*/
public function setFormat(string $format): ParameterBag
{
if (!in_array($format, self::$formats)) {
throw new InvalidParameterException(sprintf("Invalid output format '%s'. Please, use one of existing formats [%s]", $format, implode(',', self::$formats)));
}
$this->format = $format;
return $this;
}
/**
* @param string $field
* @return ParameterBag
*/
public function addField(string $field): ParameterBag
{
if (!in_array($field, self::FIELDS)) {
throw new InvalidParameterException(sprintf("Invalid field '%s'. Please, use one of existing fields [%s]", $field, implode(',', self::FIELDS)));
}
if (!in_array($field, $this->fields)) {
$this->fields[] = $field;
}
return $this;
}
/**
* @param string $field
* @return ParameterBag
*/
public function removeField(string $field): ParameterBag
{
if (($key = array_search($field, $this->fields)) !== false) {
unset($this->fields[$key]);
}
return $this;
}
/**
* @param array $fields
* @return ParameterBag
*/
public function setFields(array $fields): ParameterBag
{
foreach ($fields as $field) {
$this->addField($field);
}
return $this;
}
/**
* @return ParameterBag
*/
public function clearFields(): ParameterBag
{
$this->fields = [];
return $this;
}
/**
* @return array
*/
public function getFields(): array
{
return $this->fields;
}
}