Initial commit

Author: Jord-JD

.gitignore

@@ -0,0 +1,3 @@
+/vendor/
+composer.lock
+.idea

README.md

@@ -1,2 +1,3 @@
-# dates-timezone-conversion-trait
-Automatically convert an Eloquent model's dates to and from the current user's timezone
+# Dates Timezone Conversion Trait
+This package provides a trait that automatically converts an Eloquent 
+model's dates to and from the current user's timezone.

composer.json

@@ -0,0 +1,16 @@
+{
+    "name": "divineomega/dates-timezone-conversion-trait",
+    "description": "Automatically convert an Eloquent model's dates to and from the current user's timezone",
+    "type": "library",
+    "require": {
+        "illuminate/database": "^5.6",
+        "illuminate/support": "^5.6"
+    },
+    "license": "LGPL-3.0-only",
+    "authors": [
+        {
+            "name": "Jordan Hall",
+            "email": "[email protected]"
+        }
+    ]
+}

src/Traits/DatesTimezoneConversion.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace App\Traits;
+
+use Carbon\Carbon;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Facades\Auth;
+
+trait DatesTimezoneConversion
+{
+
+    /**
+     * Overrides getAttributeValue, and convert any dates
+     * to the user's timezone.
+     *
+     * @param  string  $key
+     * @return mixed
+     */
+    public function getAttributeValue($key)
+    {
+        /** @var Carbon $value */
+        $value = parent::getAttributeValue($key);
+
+        if ($this->isDateObject($key, $value)) {
+
+            /** @var Model $user */
+            $user = Auth::user();
+
+            if ($user) {
+                $value->setTimezone($user->getAttributeValue('timezone'));
+            }
+
+        }
+
+        return $value;
+    }
+
+    /**
+     * Set a given attribute on the model.
+     *
+     * @param  string  $key
+     * @param  mixed  $value
+     * @return mixed
+     */
+    public function setAttribute($key, $value)
+    {
+        if ($this->isDateObject($key, $value)) {
+            $value->setTimezone(config('app.timezone'));
+        }
+
+        return parent::setAttribute($key, $value);
+    }
+
+    /**
+     * Checks if a date is part of the model's dates array,
+     * is an object, and is a Carbon instance.
+     *
+     * @param $key
+     * @param $value
+     * @return bool
+     */
+    private function isDateObject($key, $value)
+    {
+        return in_array($key, $this->getDates()) &&
+            is_object($value) &&
+            get_class($value) === Carbon::class;
+    }
+
+}