Client Timezone repo creation

Gets the timezone offset in minutes from the client with Javascript

Author: kevinorriss

composer.json

@@ -0,0 +1,13 @@
+{
+    "name": "kevinorriss/clienttimezone",
+    "description": "Use javascript to get the users timezone",
+    "type": "library",
+    "authors": [
+        {
+            "name": "Kevin Orriss",
+            "email": "[email protected]"
+        }
+    ],
+    "minimum-stability": "stable",
+    "require": {}
+}

src/ClientTimezone.php

@@ -0,0 +1,90 @@
+<?php
+
+/*
+ * (c) Kevin Orriss <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace KevinOrriss\ClientTimezone;
+
+use Session;
+
+/**
+ * A simple API extension for getting a users timezone via JavaScript
+ */
+class ClientTimezone
+{
+	/**
+	 * The session key where the timezone offset is stored
+	 *
+	 * @var string
+	 */
+	const CLIENT_TIMEZONE_SESSION = "clienttimezone";
+
+	/**
+	 * The URL entered for the Ajax post in javascript.blade.php
+	 *
+	 * @var string
+	 */
+	const CLIENT_TIMEZONE_POST = "clienttimezone";
+
+
+	/**
+	* Returns the session key where the timezone offset is stored.
+	* This key can be overriden by adding CLIENT_TIMEZONE_SESSION
+	* to the .env file
+	*
+	* @return string
+	*/
+	protected static function getSessionKey()
+	{
+		return env('CLIENT_TIMEZONE_SESSION', self::CLIENT_TIMEZONE_SESSION);
+	}
+
+	/**
+	* Returns the URL entered for the Ajax post in javascript.blade.php
+	* This URL can be overriden by adding CLIENT_TIMEZONE_POST
+	* to the .env file
+	*
+	* @return string
+	*/
+	public static function getPostUrl()
+	{
+		return env('CLIENT_TIMEZONE_POST', self::CLIENT_TIMEZONE_POST);
+	}
+
+	/**
+	 * Returns the client timezone as the number of minutes offset from the current UTC time.
+	 * If the client timezone is not set in the session, NULL is returned
+	 *
+	 * @return integer|NULL
+	 */
+	public static function getOffset()
+	{
+		if (Session::has(static::getSessionKey()))
+		{
+			return intval(Session::get(static::getSessionKey()));
+		}
+		return NULL;
+	}
+
+	/**
+	 * Sets the number of minutes offset from the current UTC time in the session
+	 *
+	 * @param integer $offset
+	 */
+	public static function setOffset($offset)
+	{
+		Session::put(static::getSessionKey(), intval($offset));
+	}
+
+	/**
+	 * Removes the timezone offset from the session
+	 */
+	public static function forget()
+	{
+		Session::forget(static::getSessionKey());
+	}
+}

src/ClientTimezoneController.php

@@ -0,0 +1,32 @@
+<?php
+
+/*
+ * (c) Kevin Orriss <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace KevinOrriss\ClientTimezone;
+
+use Session;
+use Illuminate\Http\Request;
+use Illuminate\Http\Response;
+use App\Http\Controllers\Controller;
+
+/**
+ * Handles all application logic for the client timezone
+ */
+class ClientTimezoneController extends Controller
+{
+	/**
+	 * Processes the Ajax post request and stores the
+	 * timezone offset (minutes) in the session
+	 *
+	 * @param Request @request
+	 */
+	public function postClientTimezone(Request $request)
+	{
+		ClientTimezone::setOffset($request->input('timezoneoffset'));
+	}
+}

src/ClientTimezoneServiceProvider.php

@@ -0,0 +1,46 @@
+<?php
+
+/*
+ * (c) Kevin Orriss <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace KevinOrriss\ClientTimezone;
+
+use Exception;
+use Illuminate\Support\ServiceProvider;
+
+/**
+ * Registers classes and loads views into application
+ */
+class ClientTimezoneServiceProvider extends ServiceProvider
+{
+    /**
+     * Bootstrap the application services.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        if (strcmp(config('app.timezone'), 'UTC') != 0)
+        {
+            throw new Exception("ClientTimezone requires timezone to be set to UTC in /config/app.php");
+        }
+
+        $this->loadViewsFrom(__DIR__ . '/views', 'clienttimezone');
+    }
+
+    /**
+     * Register the application services.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        include __DIR__ . '/routes.php';
+        $this->app->make('KevinOrriss\ClientTimezone\ClientTimezoneController');
+        $this->app->make('KevinOrriss\ClientTimezone\ClientTimezone');
+    }
+}

src/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) Kevin Orriss
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished
+to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

src/routes.php

@@ -0,0 +1,4 @@
+<?php
+
+Route::post(ClientTimezone::getPostUrl(),
+	'KevinOrriss\ClientTimezone\ClientTimezoneController@postClientTimezone')->middleware('web');

src/views/javascript.blade.php

@@ -0,0 +1,23 @@
+<script>
+    $(document).ready(function()
+    {
+        if("{{ ClientTimezone::getOffset() }}".length == 0)
+        {
+            var clienttime = new Date();
+            var clienttimezone = -clienttime.getTimezoneOffset();
+            $.ajax(
+            {
+                type: "POST",
+                url: "{{ url(env('CLIENT_TIMEZONE_POST', ClientTimezone::CLIENT_TIMEZONE_POST)) }}",
+                data:
+                {
+                    timezoneoffset: clienttimezone
+                },
+                success: function()
+                {
+                    location.reload();
+                }
+            });
+        }
+    });
+</script>