README

Timezones Helper for Laravel application. It may be used to create Select List input options. This package is based on baspa/laravel-timezones. I modified the package to use with WhiteCute 's laravel-timezones which support datetime casting into user timezone.

Installation

You can install the package via composer:

composer require soap/laravel-timezones-list

You can publish the config file with:

php artisan vendor:publish --tag="laravel-timezones-list-config"

This is the contents of the published config file:

return [
    'offset_prefix' => 'UTC',
    'offset_whitespace' => false,
];

You can set default options for the package in the configuration file. However, you can override them using code.

Usage

Timezones grouped by continent

use Soap\TimezonesList\Facades\TimezonesList;
// 
$groupedTimezones = TimezonesList::toArray(grouped: true);

All timezones

use Soap\TimezonesList\Facades\TimezonesList;
// 
$timezones = TimezonesList::toArray();

Exclude continents

use Soap\TimezonesList\Facades\TimezonesList;
// 
$timezones = TimezonesList::excludeContinents(['Africa', 'America'])
    ->toArray();

Show offset

$timezones = TimezonesList::showOffset()->toArray();
// or
$timezones = TimezonesList::showOffset(showOffset: false)->toArray();

Include general timezones

To include general timezones like GMT or UTC use the includeGeneral method.

$timezones = TimezonesList::includeGeneral()->toArray();

Testing

composer test

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

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

soap / laravel-timezones-list

Maintainers

Details