https://github.com/minube/geo-timezone

Geo-Timezone PHP Library
https://github.com/minube/geo-timezone

Last synced: 3 months ago
JSON representation

Geo-Timezone PHP Library

• Host: GitHub
• URL: https://github.com/minube/geo-timezone
• Owner: minube
• License: mit
• Created: 2017-07-17T06:40:20.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-04-22T10:09:18.000Z (over 4 years ago)
• Last Synced: 2024-07-19T02:12:46.432Z (4 months ago)
• Language: PHP
• Homepage:
• Size: 92.8 KB
• Stars: 54
• Watchers: 18
• Forks: 34
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Geo-Timezone PHP Library

[![Build Status](https://travis-ci.org/minube/geo-timezone.png)](https://travis-ci.org/minube/geo-timezone) [![Code Coverage](https://scrutinizer-ci.com/g/minube/geo-timezone/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/minube/geo-timezone/?branch=master) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/minube/geo-timezone/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/minube/geo-timezone/?branch=master) [![Build Status](https://scrutinizer-ci.com/g/minube/geo-timezone/badges/build.png?b=master)](https://scrutinizer-ci.com/g/minube/geo-timezone/build-status/master)

Based on the [node-geo-tz package](https://github.com/evansiroky/node-geo-tz), this PHP library calculates the timezone associated to a particular location based on coordinates (latitude, longitude) and timestamp

reference. Therefore, this library provides the local date of a particular location in any moment too.

In addition, it is based on the timezones boundaries extracted by [timezone-boundary-builder](https://github.com/evansiroky/timezone-boundary-builder) tool, so it is necessary to always use the latest version of this package.

In order to improve the timezone search through the boundaries, node-geo-tz proposes to create a tree of directories based on dividing the Earth in quadrants and sub-quadrants iteratively. This tree is called "data.zip" in the reference library.

## Requirements

GEOS PHP extension is needed to run library. So, you should download and compile it running the script bin/compile-geos

.sh; then, the library called "geos.so" will be added to /usr/lib/php.

As you can see, this script contains the installation of some php extensions that will be necessary in the next

step of the installation process.

Once you have compiled the GEOS PHP extension, you should create the file geos.ini in order to enable the module and improve the performance consequently.

Finally, you should run the composer file, so the rest of necessary libraries will be installed.

## Usage

There are two main classes:

* UpdaterData: script that downloads the last version of the timezone boundaries data and creates the tree of directories (data.zip). It takes a few hours, so you can use "data.zip" from node-geo-tz to test for the first time. Otherwise, you can run the UpdaterData script in order to get the last version and create the directories tree. Destination folder must have write permisions

```php

    use GeoTimeZone\UpdaterData;

    $updater = new UpdaterData("/path/to/data/");

    $updater->updateData();

```

* Calculator: provides the timezone name or the local date associated to a particular latitude, longitude and timestamp.

```php

    use GeoTimeZone\Calculator;

    $latitude = 39.452800;

    $longitude = -0.347038;

    $timestamp = 1469387760;

    $calculator = new Calculator("/path/to/data/");

    // Local date

    $localDate = $calculator->getLocalDate($latitude, $longitude, $timestamp);

    /* DateTime Object

    (

        [date] => 2016-07-24 21:16:00.000000

        [timezone_type] => 3

        [timezone] => Europe/Madrid

    )

    */

    // TimeZone name

    $timeZoneName = $calculator->getTimeZoneName($latitude, $longitude);

    //Europe/Madrid

```