README

A simple interface to find the timezone and time offset data for a position on the surface of the earth.

Installation
Usage
Extending Things
Versioning

Installation

The recommended way to install Teazee is through Composer:

$ composer require wyndow/teazee

Usage

The Teazee interface, which all providers implement, exposes a single method:

find($lat, $lng, $timestamp = null)

ZoneInfo

The find() method returns a ZoneInfo object, which extends PHP's DateTimeZone and exposes the following additional methods:

getDateTime() will return a DateTimeImmutable representing the specified timestamp.
getTimestamp() will return a UNIX timestamp (int) for the specified timestamp. Generally this value is used to determine whether or not Daylight Savings Time should be applied. Not all providers require a timestamp. If the timestamp is required, but not provided, the current time will be used.
getUtcOffset() will return the offset (int) from UTC (in seconds) for the given location.
isDst() will return a boolean representing whether or not the timezone is in Daylight Savings Time during the specified timestamp.
getCountry() will return the 2-digit country code for the timezone.

Note: You can use ZoneInfo as a drop-in replacement for DateTimeZone in your code.

Providers

Providers perform the black magic for you: talking to the APIs, fetching results, dealing with errors, etc.

Google Maps

Get a Key

The Google Maps TimeZone API will allow you to make a number of calls without authenticating.

$teazee = new Teazee\Provider\GoogleMaps(null, $client, $messageFactory);

When you're ready to use your own API key, pass it as a first argument:

$teazee = new Teazee\Provider\GoogleMaps($apiKey, $client, $messageFactory);

TimeZoneDB

Get a Key

A valid apiKey is required to use the TimeZoneDB provider.

$teazee = new Teazee\Provider\TimezoneDb($apiKey, $client, $messageFactory);

If you have a premium account with TimezoneDb, pass true as the second argument to use the VIP endpoint.

$iAmVIP = true;
$teazee = new Teazee\Provider\TimezoneDb($apiKey, $iAmVIP, $client, $messageFactory);

The Chain Provider

The Chain provider is a special provider that takes a list of providers and iterates over this list to get a timezone. Note that it stops its iteration when a provider returns a result.

$googleMaps = new Teazee\Provider\GoogleMaps($apiKey, $client, $messageFactory);
$timezoneDb = new Teazee\Provider\TimezoneDb($apiKey, $isPremium, $client, $messageFactory);
$teazee = new Teazee\Provider\Chain([$googleMaps, $timezoneDb]);
$zone = $teazee->find($lat, $lng);

HTTP Clients

In order to talk to time zone APIs, you need an HTTP client. Teazee relies on the PSR-7 Standard and attempts to relieve you from worrying too much about its implementation.

You'll be required to include a package that provides an php-http/client-implementation, but the package you choose is up to you. If you want to let Teazee determine which HTTP classes to use, continue reading about Discovery.

Advanced: Discovery

To keep the number of dependencies on this package manageable, HTTP Discovery is not included by default.

If you'd like to use discovery, you'll need to require the php-http/discovery package:

composer require php-http/discovery

Discovery is based on Puli, which works best if you include its composer plugin, too:

composer require puli/composer-plugin

With discovery enabled, you can omit the $client and $messageFactory objects when creating your providers:

$provider = new Teazee\Provider\TimezoneDb($apiKey); // Client and MessageFactory will be created for you!

Extending Things

You can write your own provider by implementing the Provider interface.

Versioning

Teazee follows Semantic Versioning.

Contributing

See CONTRIBUTING file.

Unit Tests

In order to run the test suite, install the development dependencies:

$ composer install --dev

Then, run the following command:

$ bin/kahlan

Credits

Michael Crumm mike@crumm.net
All contributors

Special thanks goes to William Durand and the Geocoder project, upon which we based the application structure and documentation for Teazee.

Contributor Code of Conduct

As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.

We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.

Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.

This Code of Conduct is adapted from the Contributor Covenant, version 1.0.0, available at http://contributor-covenant.org/version/1/0/0/

License

Teazee is released under the MIT License. See the bundled LICENSE file for details.

wyndow / teazee

Maintainers

Details