<?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(); } }
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
Batch | Folder | 0755 |
|
|
Compute | Folder | 0755 |
|
|
Exception | Folder | 0755 |
|
|
Iam | Folder | 0755 |
|
|
Iterator | Folder | 0755 |
|
|
Lock | Folder | 0755 |
|
|
Logger | Folder | 0755 |
|
|
LongRunning | Folder | 0755 |
|
|
Report | Folder | 0755 |
|
|
Testing | Folder | 0755 |
|
|
Upload | Folder | 0755 |
|
|
AnonymousCredentials.php | File | 2.4 KB | 0644 |
|
ArrayTrait.php | File | 3.45 KB | 0644 |
|
Blob.php | File | 2.02 KB | 0644 |
|
CallTrait.php | File | 1.08 KB | 0644 |
|
ClientTrait.php | File | 7.96 KB | 0644 |
|
ConcurrencyControlTrait.php | File | 1.35 KB | 0644 |
|
DebugInfoTrait.php | File | 1.28 KB | 0644 |
|
Duration.php | File | 2.1 KB | 0644 |
|
EmulatorTrait.php | File | 2.65 KB | 0644 |
|
ExponentialBackoff.php | File | 3.61 KB | 0644 |
|
GeoPoint.php | File | 5.98 KB | 0644 |
|
GrpcRequestWrapper.php | File | 8.27 KB | 0644 |
|
GrpcTrait.php | File | 8.22 KB | 0644 |
|
InsecureCredentialsWrapper.php | File | 923 B | 0644 |
|
Int64.php | File | 1.7 KB | 0644 |
|
JsonTrait.php | File | 2.15 KB | 0644 |
|
PhpArray.php | File | 7.21 KB | 0644 |
|
RequestBuilder.php | File | 4.73 KB | 0644 |
|
RequestWrapper.php | File | 16.21 KB | 0644 |
|
RequestWrapperTrait.php | File | 7.08 KB | 0644 |
|
RestTrait.php | File | 3.62 KB | 0644 |
|
Retry.php | File | 3.28 KB | 0644 |
|
RetryDeciderTrait.php | File | 2.79 KB | 0644 |
|
ServiceBuilder.php | File | 16.58 KB | 0644 |
|
SysvTrait.php | File | 1.81 KB | 0644 |
|
TimeTrait.php | File | 4.38 KB | 0644 |
|
Timestamp.php | File | 3.95 KB | 0644 |
|
TimestampTrait.php | File | 1.56 KB | 0644 |
|
UriTrait.php | File | 1.78 KB | 0644 |
|
ValidateTrait.php | File | 2.26 KB | 0644 |
|
ValueMapperTrait.php | File | 1.74 KB | 0644 |
|
WhitelistTrait.php | File | 1.13 KB | 0644 |
|