README

List extracted from Microsoft Time Zone Index Values.

Some regions influenced by this Stack Overflow answer.

⚠️ This package has been rewritten in version 3 to support more flexibility of working with the timezones as well as incorporating modern php features

If you are looking for the now deprecated version 2 documentation, click here

Installation

As of v3.0 this package requires PHP 8.0+

You can install the package via composer:

composer require nehero/friendlytimezone

Usage

// Illuminate\Support\Collection of Nehero\Timezone
$timezones = Nehero\FriendlyTimezone\FriendlyTimezone::timezones();

// properties available to you
foreach ($timezones as $timezone) {
    echo $timezone->friendlyName; // Saskatchewan (string)
    echo $timezone->timezone; // America/Regina (string)
    echo $timezone->offset; // -6 (int|float)
    echo $timezone->getFormattedOffset(); // -6:00 (string)
}

// common formatting for dropdowns
$timezones->map(fn ($tz) => [
    'label' => "(UTC{$tz->getFormattedOffset()}) {$tz->friendlyName}"), // (UTC+6:00) Saskatchewan
    'value' => $tz->timezone, // America/Regina
]);

// need it in descending order?
// can manipulate it however you want with
// common collection or native array/iterable functions
$timezones->sortByDesc(fn ($tz) => $tz->offset)->map(...);

Supported Timezones

See any missing? Pull requests and issues are welcome!

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

If you have a better suggestion for any of the mapped regions, please submit a pull request and include accurate sources for the changes.

License

The MIT License (MIT). Please see License File for more information.