Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spatie/google-time-zone
Get time zones for coordinates
https://github.com/spatie/google-time-zone
coordinates geocoding php timezone
Last synced: 4 days ago
JSON representation
Get time zones for coordinates
- Host: GitHub
- URL: https://github.com/spatie/google-time-zone
- Owner: spatie
- License: mit
- Created: 2019-04-23T12:18:53.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-02-27T15:41:32.000Z (9 months ago)
- Last Synced: 2024-11-08T13:17:52.565Z (5 days ago)
- Topics: coordinates, geocoding, php, timezone
- Language: PHP
- Homepage: https://spatie.be/open-source
- Size: 52.7 KB
- Stars: 102
- Watchers: 7
- Forks: 16
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Get the time zone used at the given coordinates
[](https://github.com/spatie/google-time-zone/releases)
[](LICENSE.md)
[](https://packagist.org/packages/spatie/google-time-zone)
This package can convert GPS coordinates to time zones using [Google's Time Zone service](https://developers.google.com/maps/documentation/timezone/intro). Here's a quick example:
```php
GoogleTimeZone::getTimeZoneForCoordinates('51.2194475', '4.4024643');
// Will return this array
[
"dstOffset" => 0
"rawOffset" => 3600
"timeZoneId" => "Europe/Brussels"
"timeZoneName" => "Central European Standard Time"
]
```
## Support us
[
](https://spatie.be/github-ad-click/google-time-zone)
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
## Installation
You can install this package through composer.
```bash
composer require spatie/google-time-zone
```
## Laravel installation
Though the package works fine in non-Laravel projects we've included some niceties for our fellow Artisans.
In Laravel will autoregister the package itself, but you should still publish the config file yourself.
```bash
php artisan vendor:publish --provider="Spatie\GoogleTimeZone\GoogleTimeZoneServiceProvider" --tag="config"
```
This is the content of the config file:
```php
return [
/*
* The api key used when sending timezone requests to Google.
*/
'key' => env('GOOGLE_MAPS_TIMEZONE_API_KEY', ''),
/*
* The language param used to set response translations for textual data.
*
* More info: https://developers.google.com/maps/faq#languagesupport
*/
'language' => '',
];
```
## Usage
Here's how you can get the time zone for a given set of coordinates.
```php
$googleTimeZone = new GoogleTimeZone();
$googleTimeZone->setApiKey(config('google-time-zone.key'));
$googleTimeZone->getTimeZoneForCoordinates('51.2194475', '4.4024643');
/*
// Will return this array
[
"dstOffset" => 0
"rawOffset" => 3600
"timeZoneId" => "Europe/Brussels"
"timeZoneName" => "Central European Standard Time"
]
*/
```
You can get the result back in a specific language.
```php
$googleTimeZone
->setLanguage('nl')
->getTimeZoneForCoordinates('51.2194475', '4.4024643');
/*
// Will return this array
[
"dstOffset" => 0
"rawOffset" => 3600
"timeZoneId" => "Europe/Brussels"
"timeZoneName" => "Midden-Europese standaardtijd"
]
*/
```
It is possible to specify a timestamp for the location so that daylight savings can be taken into account. We will set this timestamp to the current time by default.
```php
$googleTimeZone
->setTimestamp(new DateTime('13 august 2018'))
->getTimeZoneForCoordinates('51.2194475', '4.4024643');
/*
// Will return this array
[
"dstOffset" => 3600
"rawOffset" => 3600
"timeZoneId" => "Europe/Brussels"
"timeZoneName" => "Central European Summer Time"
]
*/
```
If you are using the package with Laravel, you can simply call `getTimeZoneForCoordinates`.
```php
GoogleTimeZone::getTimeZoneForCoordinates('51.2194475', '4.4024643');
/*
// Will return this array
[
"dstOffset" => 0
"rawOffset" => 3600
"timeZoneId" => "Europe/Brussels"
"timeZoneName" => "Central European Standard Time"
]
*/
```
When no time zone was found `null` will be returned.
## Postcardware
You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.
Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium.
We publish all received postcards [on our company website](https://spatie.be/en/opensource/postcards).
## Credits
- [Ruben Van Assche](https://github.com/rubenvanassche)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.