Added skip functionality

Now you can simply call ClientTimezone::skip() in the your controller
and the javascript will not attempt to get the client timezone.

Author: kevinorriss

src/LICENSE LICENSE.mdsrc/LICENSE renamed to LICENSE.md

@@ -63,6 +63,16 @@ $carbon = Carbon::now();
 $carbon->addMinutes(ClientTimezone::getOffset());
 ```
 
+There may be times when you do not want javascript to check the client timezone. An example
+of this is when the client creates a new session on your application by following a URL
+to verify their email address, this page displays a flash message, but will be shown briefly
+until Javascript reloads the page. Upon the page reload, the flash message will have expired.
+
+To prevent Javascript from checking the client timezone and reloading the page if it needs to,
+just add this line to your controller before returning a view.
+
+`ClientTimezone::skip();`
+
 ## Authors
 
 * **Kevin Orriss** - [Website](http://kevinorriss.com)
@@ -71,4 +81,4 @@ See also the list of [contributors](https://github.com/kevinorriss/clienttimezon
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE](src/LICENSE) file for details
+This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details

README.md

@@ -30,6 +30,13 @@ class ClientTimezone
 	 */
 	const CLIENT_TIMEZONE_POST = "clienttimezone";
 
+	/**
+	 * Flag to skip getting the client timezone
+	 *
+	 * @var boolean
+	 */
+	protected static $skip = FALSE;
+
 
 	/**
 	* Returns the session key where the timezone offset is stored.
@@ -55,6 +62,16 @@ public static function getPostUrl()
 		return env('CLIENT_TIMEZONE_POST', self::CLIENT_TIMEZONE_POST);
 	}
 
+	/**
+	 * Returns if the client timezone is stored in session or not
+	 *
+	 * @return boolean
+	 */
+	public static function hasOffset()
+	{
+		return Session::has(static::getSessionKey());
+	}
+
 	/**
 	 * 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
@@ -63,7 +80,7 @@ public static function getPostUrl()
 	 */
 	public static function getOffset()
 	{
-		if (Session::has(static::getSessionKey()))
+		if (static::hasOffset())
 		{
 			return intval(Session::get(static::getSessionKey()));
 		}
@@ -87,4 +104,22 @@ public static function forget()
 	{
 		Session::forget(static::getSessionKey());
 	}
+
+	/**
+	 * Sets the skip flag to true, meaning that the javascript will not check for the client timezone
+	 */
+	public static function skip()
+	{
+		static::$skip = TRUE;
+	}
+
+	/**
+	 * Returns if the client timezone should be checked or not
+	 *
+	 * @return boolean
+	 */
+	public static function check()
+	{
+		return !static::$skip && is_null(static::getOffset());
+	}
 }

src/ClientTimezone.php

@@ -1,7 +1,7 @@
 <script>
     $(document).ready(function()
     {
-        if("{{ ClientTimezone::getOffset() }}".length == 0)
+        if({{ (ClientTimezone::check() ? "true" : "false") }})
         {
             var clienttime = new Date();
             var clienttimezone = -clienttime.getTimezoneOffset();