/
GeoPoint.php
226 lines (210 loc) · 5.99 KB
/
GeoPoint.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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
<?php
/**
* Copyright 2016 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
namespace Google\Cloud\Core;
use InvalidArgumentException;
/**
* Represents a geographical point.
*
* Unless specified otherwise, this must conform to the
* [WGS84](http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf) standard.
* Values must be within normalized ranges.
*
* Example:
* ```
* use Google\Cloud\Core\GeoPoint;
*
* $point = new GeoPoint(37.423147, -122.085015);
* ```
*/
class GeoPoint implements \JsonSerializable
{
/**
* @var float
*/
private $latitude;
/**
* @var float
*/
private $longitude;
/**
* Create a GeoPoint.
*
* Ints will be converted to floats. Values not passing the `is_numeric()`
* check will result in an exception.
*
* @param float|int|null $latitude The GeoPoint Latitude. **Note** that
* `null` is not a generally valid value, and will throw an
* `InvalidArgumentException` unless `$allowNull` is set to `true`.
* @param float|int|null $longitude The GeoPoint Longitude. **Note** that
* `null` is not a generally valid value, and will throw an
* `InvalidArgumentException` unless `$allowNull` is set to `true`.
* @param bool $allowNull [optional] If true, null values will be allowed
* in the constructor only. This switch exists to handle a rare case
* wherein a geopoint may be empty and is not intended for use from
* outside the client. **Defaults to** `false`.
* @throws \InvalidArgumentException
*/
public function __construct($latitude, $longitude, $allowNull = false)
{
$this->latitude = $this->validateValue($latitude, 'latitude', $allowNull);
$this->longitude = $this->validateValue($longitude, 'longitude', $allowNull);
}
/**
* Get the latitude
*
* Example:
* ```
* $latitude = $point->latitude();
* ```
*
* @return float|null
*/
public function latitude()
{
$this->checkContext('latitude', func_get_args());
return $this->latitude;
}
/**
* Set the latitude
*
* Non-numeric values will result in an exception
*
* Example:
* ```
* $point->setLatitude(42.279594);
* ```
*
* @param int|float $latitude The new latitude
* @return GeoPoint
* @throws \InvalidArgumentException
*/
public function setLatitude($latitude)
{
$this->latitude = $this->validateValue($latitude, 'latitude');
return $this;
}
/**
* Get the longitude
*
* Example:
* ```
* $longitude = $point->longitude();
* ```
*
* @return float|null
*/
public function longitude()
{
$this->checkContext('longitude', func_get_args());
return $this->longitude;
}
/**
* Set the longitude
*
* Non-numeric values will result in an exception.
*
* Example:
* ```
* $point->setLongitude(-83.732124);
* ```
*
* @param float|int $longitude The new longitude value
* @return GeoPoint
* @throws \InvalidArgumentException
*/
public function setLongitude($longitude)
{
$this->longitude = $this->validateValue($longitude, 'longitude');
return $this;
}
/**
* Return a GeoPoint
*
* Example:
* ```
* $point = $point->point();
* ```
*
* @return array [LatLng](https://cloud.google.com/datastore/reference/rest/Shared.Types/LatLng)
*/
public function point()
{
return [
'latitude' => $this->latitude,
'longitude' => $this->longitude
];
}
/**
* Let people know if they accidentally use the getter in setter context.
*
* @param string $method the method name
* @param array $args The method arguments
* @throws \InvalidArgumentException
* @return void
*/
private function checkContext($method, array $args)
{
if (count($args) > 0) {
throw new InvalidArgumentException(sprintf(
'Calling method %s with arguments is unsupported.',
$method
));
}
}
/**
* Check a given value's validity as a coordinate.
*
* Numeric values will be cast to type `float`. All other values will raise
* an exception with the exception of `null`, if `$allowNull` is set to true.
*
* @param mixed $value The coordinate value.
* @param string $type The coordinate type for error reporting.
* @param bool $allowNull [optional] Whether null values should be allowed.
* **Defaults to** `false`.
* @return float|null
*/
private function validateValue($value, $type, $allowNull = false)
{
if (!is_numeric($value) && (!$allowNull || ($allowNull && $value !== null))) {
throw new InvalidArgumentException(sprintf(
'Given %s must be a numeric value.',
$type
));
}
return $allowNull && $value === null
? $value
: (float) $value;
}
/**
* Implement JsonSerializable by representing GeoPoint as a JSON-object:
*
* ```
* {
* latitude: 31.778333
* longitude: 35.229722
* }
* ```
*
* @return object
* @access private
*/
#[\ReturnTypeWillChange]
public function jsonSerialize()
{
return (object) $this->point();
}
}