Returning Carbon instances when using Model Casting

Author: Amandio Magalhaes

README.md

@@ -1,12 +1,10 @@
 # Laravel Timezone
 
-[![Latest Version on Packagist](https://img.shields.io/packagist/v/jamesmills/laravel-timezone.svg?style=flat-square)](https://packagist.org/packages/jamesmills/laravel-timezone)
-[![Total Downloads](https://img.shields.io/packagist/dt/jamesmills/laravel-timezone.svg?style=flat-square)](https://packagist.org/packages/jamesmills/laravel-timezone)
-[![Licence](https://img.shields.io/packagist/l/jamesmills/laravel-timezone.svg?style=flat-square)](https://packagist.org/packages/jamesmills/laravel-timezone)
-[![Quality Score](https://img.shields.io/scrutinizer/g/jamesmills/laravel-timezone.svg?style=flat-square)](https://scrutinizer-ci.com/g/jamesmills/laravel-timezone)
-[![StyleCI](https://github.styleci.io/repos/142882574/shield?branch=master)](https://github.styleci.io/repos/142882574)
-[![Buy us a tree](https://img.shields.io/badge/treeware-%F0%9F%8C%B3-lightgreen?style=flat-square)](https://plant.treeware.earth/jamesmills/laravel-timezone)
-[![Treeware (Trees)](https://img.shields.io/treeware/trees/jamesmills/laravel-timezone?style=flat-square)](https://plant.treeware.earth/jamesmills/laravel-timezone)
+[![Packagist](https://img.shields.io/packagist/v/jamesmills/laravel-timezone.svg?style=for-the-badge)](https://packagist.org/packages/jamesmills/laravel-timezone)
+![Packagist](https://img.shields.io/packagist/dt/jamesmills/laravel-timezone.svg?style=for-the-badge)
+![Packagist](https://img.shields.io/packagist/l/jamesmills/laravel-timezone.svg?style=for-the-badge)
+[![Buy us a tree](https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen?style=for-the-badge)](https://plant.treeware.earth/jamesmills/laravel-timezone)
+[![Treeware (Trees)](https://img.shields.io/treeware/trees/jamesmills/laravel-timezone?style=for-the-badge)](https://plant.treeware.earth/jamesmills/laravel-timezone)
 
 An easy way to set a timezone for a user in your application and then show date/times to them in their local timezone.
 
@@ -90,6 +88,31 @@ And with custom formatting
 // 2018-07-04 3:32 New York, America
 ```
 
+### Using models casting class
+
+#### Basic usage
+
+```
+<?php
+
+namespace App;
+
+use Illuminate\Database\Eloquent\Model;
+use JamesMills\LaravelTimezone\Casts\Timezone;
+
+class Foo extends Model
+{
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'created_at' => Timezone::class,
+    ];
+}
+```
+
 ### Saving the users input to the database in UTC
 
 This will take a date/time, set it to the users timezone then return it as UTC in a Carbon instance.

src/Casts/Timezone.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace JamesMills\LaravelTimezone\Casts;
+
+use Carbon\Carbon;
+use Exception;
+use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
+use Illuminate\Database\Eloquent\Model;
+use JamesMills\LaravelTimezone\Facades\Timezone as TimezoneFacade;
+use JamesMills\LaravelTimezone\Traits\TimezoneTrait;
+
+class Timezone implements CastsAttributes
+{
+    use TimezoneTrait;
+    /**
+     * Transform the attribute from the underlying model values.
+     *
+     * @param  Model  $model
+     * @param  string  $key
+     * @param  mixed  $value
+     * @param  array  $attributes
+     * @return Carbon
+     * @throws Exception
+     */
+    public function get($model, string $key, $value, array $attributes)
+    {
+        return Carbon::parse($value)
+            ->setTimezone($this->getUserTimezone());
+    }
+
+    /**
+     * Transform the attribute to its underlying model values.
+     *
+     * @param  Model  $model
+     * @param  string  $key
+     * @param  mixed  $value
+     * @param  array  $attributes
+     * @return Carbon
+     */
+    public function set($model, string $key, $value, array $attributes)
+    {
+        return TimezoneFacade::convertFromLocal($value);
+    }
+}

src/Timezone.php

@@ -3,9 +3,12 @@
 namespace JamesMills\LaravelTimezone;
 
 use Carbon\Carbon;
+use JamesMills\LaravelTimezone\Traits\TimezoneTrait;
 
 class Timezone
 {
+    use TimezoneTrait;
+
     /**
      * @param  Carbon|null  $date
      * @param  null  $format
@@ -18,9 +21,7 @@ public function convertToLocal(?Carbon $date, $format = null, $format_timezone =
             return 'Empty';
         }
 
-        $timezone = (auth()->user()->timezone) ?? config('app.timezone');
-
-        $date->setTimezone($timezone);
+        $date->setTimezone($this->getUserTimezone());
 
         if (is_null($format)) {
             return $date->format(config('timezone.format'));
@@ -41,7 +42,8 @@ public function convertToLocal(?Carbon $date, $format = null, $format_timezone =
      */
     public function convertFromLocal($date) : Carbon
     {
-        return Carbon::parse($date, auth()->user()->timezone)->setTimezone('UTC');
+        return Carbon::parse($date, auth()->user()->timezone)
+            ->setTimezone('UTC');
     }
 
     /**

src/Traits/TimezoneTrait.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace JamesMills\LaravelTimezone\Traits;
+
+trait TimezoneTrait
+{
+    /**
+     * @return string
+     */
+    protected function getUserTimezone(): string
+    {
+        return (auth()->user()->timezone) ?? config('app.timezone');
+    }
+}