An easy way to set a timezone for a user in your application and then show date/times to them in their local timezone.
This package listens for the \Illuminate\Auth\Events\Login event and will then automatically set a timezone on your user model (stored in the database). It decides whether to update user timezone or not according to user detect_timezone attribute, or, if not set, according to default value in config. For non-authorized routes, where auth user info is not accessible, package will use default timezone from its config.
This package uses the torann/geoip package which looks up the users location based on their IP address. The package also returns information like the users currency and users timezone. You can configure this package separately if you require.
You can show dates to your user in their timezone by using
{{ Timezone::convertToLocal($post->created_at) }}Or use our nice blade directive
@displayDate($post->created_at)composer require seoservice2020/laravel-timezoneBy default, timezone attributes placed into users table. If you wish to use package with this default, see instructions below.
php artisan vendor:publish --provider="SEOService2020\Timezone\TimezoneServiceProvider" --tag=migrationsRun the database migrations. This will add timezone and detect_timezone columns to your users table. Note that migration will be placed to default Laravel migrations folder, so if you use custom folder, you should move migration file to appropriate location.
php artisan migrateAdd SEOService2020\Timezone\Traits\HasTimezone trait to your user model:
use HasTimezone;If you wish to work with detect_timezone attribute directly, you can add boolean cast for your User model:
protected $casts = [
'detect_timezone' => 'boolean',
];If you wish to set per-user timezone overwriting at user creation time, you can add detect_timezone attribute to your User model fillable property:
protected $fillable = [
'detect_timezone',
];If you wish to use different location for timezone and detect_timezone attributes, e.g. Profile model, you should override HasTimezone trait and use overriden one in your User model.
Default will use the format jS F Y g:i:a and will not show the timezone
{{ Timezone::convertToLocal($post->created_at) }}
// 4th July 2018 3:32:amIf you wish you can set a custom format and also include a nice version of the timezone
{{ Timezone::convertToLocal($post->created_at, 'Y-m-d g:i', true) }}
// 2018-07-04 3:32 New York, AmericaIf you wish to further work with converted Carbon instance, you can use toLocal method:
{{ Timezone::toLocal($post->created_at)->diffForHumans() }}
// diff calculated relative to datetime with user-end timezoneMaking your life easier one small step at a time
@displayDate($post->created_at)
// 4th July 2018 3:32:amAnd with custom formatting
@displayDate($post->created_at, 'Y-m-d g:i', true)
// 2018-07-04 3:32 New York, AmericaThis will take a date/time, set it to the users timezone then return it as UTC in a Carbon instance.
$post = Post::create([
'publish_at' => Timezone::convertFromLocal($request->get('publish_at')),
'description' => $request->input('description'),
]);Publishing the config file is optional.
php artisan vendor:publish --provider="SEOService2020\Timezone\TimezoneServiceProvider" --tag=configWhen the timezone has been set, we display a flash message, By default, is configured to use Laravel default flash messaging, here are some of the optional integrations.
laracasts/flash - 'flash' => 'laracasts'
mercuryseries/flashy - 'flash' => 'mercuryseries'
spatie/laravel-flash - 'flash' => 'spatie'
mckenziearts/laravel-notify - 'flash' => 'mckenziearts'
To override this configuration, you just need to change the flash property inside the configuration file config/timezone.php for the desired package. You can disable flash messages by setting 'flash' => 'off'.
User timezone will be overwritten at each login with the current user timezone if detect_timezone is set to true for this user. If this attribute is not set, by default, the timezone will be overwritten. This behavior can be restricted to only update the timezone if it is blank by setting the 'overwrite' => false, config option.
By default, the date format will be jS F Y g:i:a. To override this configuration, you just need to change the format property inside the configuration file config/timezone.php for the desired format.
This lookup array configuration makes it possible to find the remote address of the user in any attribute inside the Laravel request helper, by any key. Having in mind when the key is found inside the attribute, that key will be used. By default, we use the server attribute with the key REMOTE_ADDR. To override this configuration, you just need to change the lookup property inside the configuration file config/timezone.php for the desired lookup.
If you wish to customise the underlying torann/geoip package you can publish the config file by using the command below.
php artisan vendor:publish --provider="Torann\GeoIP\GeoIPServiceProvider" --tag=configPlease see CHANGELOG for more information what has changed recently.
Please see CONTRIBUTING for details.
This package is 100% free and open-source, under the MIT license. Use it however you want.
This package is Treeware. If you use it in production, then we ask that you buy the world a tree to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.
If you receive a message like This cache store does not support tagging this is because the torann/geoip package requires a caching driver which supports tagging and you probably have your application set to use the file cache driver. You can publish the config file for the torann/geoip package and set 'cache_tags' => null, to solve this. Read more about this issue here.