README

Use Timezone in your laravel app

This package takes a different approach to handle different timezone for your user.

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

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. We publish all received postcards on our virtual postcard wall.

Installation

You can install the package via composer:

composer require sawirricardo/laravel-timezone

You can publish the config file with:

php artisan vendor:publish --tag="laravel-timezone-config"

This is the contents of the published config file:

return [
    // possible options: session, cache
    'driver' => 'cache',

    'url' => 'laravel-timezone',
    'controller' => \Sawirricardo\LaravelTimezone\Http\Controllers\LaravelTimezoneController::class,

    'allowed_timezones' => [
        ...timezone_identifiers_list(),
    ],

    'middleware' => [
        'web',
    ],
];

Optionally, you can publish the views using

php artisan vendor:publish --tag="laravel-timezone-views"

Usage

echo currentTimezone(); // UTC

{{-- Just put this in your layout file --}}
<x-laravel-timezone />

These should be enough for most cases, however, if you have a different case, you can try hit the route endpoint and supply the timezone param to the request, for example:

<script>
    document.addEventListener("DOMContentLoaded", function () {
        const timezone = Intl.DateTimeFormat().resolvedOptions().timeZone;
        axios
            .post("{{ route('laravel-timezone') }}", {
                timezone: timezone,
            })
            .catch((error) => null);
    });
</script>

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.

sawirricardo / laravel-timezone

Maintainers

Details