refs #1458 - fix indentation

git-svn-id: http://dev.piwik.org/svn/trunk@3025 59fd770c-687e-43c8-a1e3-f5a4ff64c105

1 files changed, 192 insertions, 182 deletions

diff --git a/core/Date.php b/core/Date.php
index 82b0595cdd..7ba3461f88 100644
--- a/core/Date.php
+++ b/core/Date.php
@@ -1,25 +1,25 @@
 <?php
 /**
  * Piwik - Open source web analytics
- * 
+ *
  * @link http://piwik.org
  * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
  * @version $Id$
- * 
+ *
  * @category Piwik
  * @package Piwik
  */
 
 /**
  * Date object widely used in Piwik.
- * 
+ *
  * @package Piwik
  */
 class Piwik_Date
 {
 	/**
 	 * Builds a Piwik_Date object
-	 * 
+	 *
 	 * @param int timestamp
 	 */
 	protected function __construct( $timestamp, $timezone = 'UTC')
@@ -31,16 +31,16 @@ class Piwik_Date
 		$this->timezone = $timezone;
 		$this->timestamp = $timestamp ;
 	}
-	
-	
+
+
 	/**
-	 * Returns a Piwik_Date objects. 
+	 * Returns a Piwik_Date objects.
 	 *
 	 * @param string $strDate 'today' 'yesterday' or any YYYY-MM-DD or timestamp
-	 * @param string $timezone if specified, the dateString will be relative to this $timezone. 
+	 * @param string $timezone if specified, the dateString will be relative to this $timezone.
 	 * 				For example, today in UTC+12 will be a timestamp in the future for UTC.
-     *              This is different from using ->setTimezone() 
-	 * @return Piwik_Date 
+	 *              This is different from using ->setTimezone()
+	 * @return Piwik_Date
 	 */
 	static public function factory($dateString, $timezone = null)
 	{
@@ -48,7 +48,7 @@ class Piwik_Date
 		{
 			$date = self::now();
 		}
-		elseif($dateString == 'today') 
+		elseif($dateString == 'today')
 		{
 			$date = self::today();
 		}
@@ -61,7 +61,7 @@ class Piwik_Date
 			$date = self::yesterdaySameTime();
 		}
 		elseif (!is_int($dateString)
-			&& ($dateString = strtotime($dateString)) === false) 
+			&& ($dateString = strtotime($dateString)) === false)
 		{
 			throw new Exception(Piwik_TranslateException('General_ExceptionInvalidDateFormat', array("YYYY-MM-DD, or 'today' or 'yesterday'", "strtotime", "http://php.net/strtotime")));
 		}
@@ -73,29 +73,29 @@ class Piwik_Date
 		{
 			return $date;
 		}
-		
+
 		// manually adjust for UTC timezones
 		$utcOffset = self::extractUtcOffset($timezone);
 		if($utcOffset !== false)
 		{
 			return $date->addHour($utcOffset);
 		}
-		
+
 		date_default_timezone_set($timezone);
 		$datetime = $date->getDatetime();
 		date_default_timezone_set('UTC');
-		
+
 		$date = Piwik_Date::factory(strtotime($datetime));
-		
+
 		return $date;
 	}
-	
+
 	/*
 	 * The stored timestamp is always UTC based.
 	 * The returned timestamp via getTimestamp() will have the conversion applied
 	 */
 	protected $timestamp = null;
-	
+
 	/*
 	 * Timezone the current date object is set to.
 	 * Timezone will only affect the returned timestamp via getTimestamp()
@@ -103,57 +103,57 @@ class Piwik_Date
  	protected $timezone = 'UTC';
 
  	const DATE_TIME_FORMAT = 'Y-m-d H:i:s';
- 	
+
  	/**
- 	 * Returns the datetime start in UTC
- 	 * 
+ 	 * Returns the datetime of the current timestamp
+ 	 *
  	 * @return string
  	 */
- 	function getDateStartUTC()
+ 	function getDatetime()
  	{
- 		$dateStartUTC = date('Y-m-d', $this->timestamp);
- 		$date = Piwik_Date::factory($dateStartUTC)->setTimezone($this->timezone);
- 		return $date->toString(self::DATE_TIME_FORMAT);
+ 		return $this->toString(self::DATE_TIME_FORMAT);
  	}
 
  	/**
- 	 * Returns the datetime of the current timestamp
- 	 * 
+ 	 * Returns the datetime start in UTC
+ 	 *
  	 * @return string
  	 */
- 	function getDatetime()
+ 	function getDateStartUTC()
  	{
- 		return $this->toString(self::DATE_TIME_FORMAT);
+ 		$dateStartUTC = gmdate('Y-m-d', $this->timestamp);
+ 		$date = Piwik_Date::factory($dateStartUTC)->setTimezone($this->timezone);
+ 		return $date->toString(self::DATE_TIME_FORMAT);
  	}
- 	
+
  	/**
  	 * Returns the datetime end in UTC
- 	 * 
+ 	 *
  	 * @return string
  	 */
  	function getDateEndUTC()
  	{
- 		$dateEndUTC = date('Y-m-d 23:59:59', $this->timestamp);
+ 		$dateEndUTC = gmdate('Y-m-d 23:59:59', $this->timestamp);
  		$date = Piwik_Date::factory($dateEndUTC)->setTimezone($this->timezone);
  		return $date->toString(self::DATE_TIME_FORMAT);
  	}
- 	
+
 	/**
 	 * Returns a new date object, copy of $this, with the timezone set
 	 * This timezone is used to offset the UTC timestamp returned by @see getTimestamp()
 	 * Doesn't modify $this
-	 * 
-	 * @param string $timezone 'UTC', 'Europe/London', ...  
+	 *
+	 * @param string $timezone 'UTC', 'Europe/London', ...
 	 */
 	public function setTimezone($timezone)
 	{
 		return new Piwik_Date($this->timestamp, $timezone);
 	}
-	
+
 	/**
 	 * Helper function that returns the offset in the timezone string 'UTC+14'
 	 * Returns false if the timezone is not UTC+X or UTC-X
-	 * 
+	 *
 	 * @param $timezone
 	 * @return int or false
 	 */
@@ -164,7 +164,7 @@ class Piwik_Date
 			return 0;
 		}
 		$start = substr($timezone, 0, 4);
-		if($start != 'UTC-' 
+		if($start != 'UTC-'
 			&& $start != 'UTC+')
 		{
 			return false;
@@ -175,9 +175,19 @@ class Piwik_Date
 		}
 		return $offset;
 	}
-	
+
+	/**
+	 * Returns the Unix timestamp of the date in UTC
+	 *
+	 * @return int
+	 */
+	public function getTimestampUTC()
+	{
+		return $this->timestamp;
+	}
+
 	/**
-	 * Returns the unix timestamp of the date in UTC, 
+	 * Returns the unix timestamp of the date in UTC,
 	 * converted from the date timezone
 	 *
 	 * @return int
@@ -191,7 +201,7 @@ class Piwik_Date
 		// @fixme
 		// The following code seems clunky - I thought the DateTime php class would allow to return timestamps
 		// after applying the timezone offset. Instead, the underlying timestamp is not changed.
-		// I decided to get the date without the timezone information, and create the timestamp from the truncated string. 
+		// I decided to get the date without the timezone information, and create the timestamp from the truncated string.
 		// Unit tests pass (@see Date.test.php) but I'm pretty sure this is not the right way to do it
 		date_default_timezone_set($this->timezone);
 		$dtzone = timezone_open('UTC');
@@ -205,7 +215,7 @@ class Piwik_Date
 
 		return (int)$timestamp;
 	}
-	
+
 	/**
 	 * Returns true if the current date is older than the given $date
 	 *
@@ -216,7 +226,7 @@ class Piwik_Date
 	{
 		return $this->getTimestamp() > $date->getTimestamp();
 	}
-	
+
 	/**
 	 * Returns true if the current date is earlier than the given $date
 	 *
@@ -227,7 +237,7 @@ class Piwik_Date
 	{
 		return $this->getTimestamp() < $date->getTimestamp();
 	}
-	
+
 	/**
 	 * Returns the Y-m-d representation of the string.
 	 * You can specify the output, see the list on php.net/date
@@ -250,16 +260,16 @@ class Piwik_Date
 		return $this->toString();
 	}
 
-    /**
-     * Compares the week of the current date against the given $date
-     * Returns 0 if equal, -1 if current week is earlier or 1 if current week is later
-     * Example: 09.Jan.2007 13:07:25 -> compareWeek(2); -> 0
-     *
-     * @param Piwik_Date $date
-     * @return integer  0 = equal, 1 = later, -1 = earlier
-     */
-    public function compareWeek(Piwik_Date $date)
-    {
+	/**
+	 * Compares the week of the current date against the given $date
+	 * Returns 0 if equal, -1 if current week is earlier or 1 if current week is later
+	 * Example: 09.Jan.2007 13:07:25 -> compareWeek(2); -> 0
+	 *
+	 * @param Piwik_Date $date
+	 * @return integer  0 = equal, 1 = later, -1 = earlier
+	 */
+	public function compareWeek(Piwik_Date $date)
+	{
 		$currentWeek = date('W', $this->getTimestamp());
 		$toCompareWeek = date('W', $date->getTimestamp());
 		if( $currentWeek == $toCompareWeek)
@@ -271,16 +281,16 @@ class Piwik_Date
 			return -1;
 		}
 		return 1;
-    }
-    
-    /**
-     * Compares the month of the current date against the given $date month
-     * Returns 0 if equal, -1 if current month is earlier or 1 if current month is later
-     * For example: 10.03.2000 -> 15.03.1950 -> 0
-     *
-     * @param  Piwik_Date  $month   Month to compare
-     * @return integer  0 = equal, 1 = later, -1 = earlier
-     */
+	}
+
+	/**
+	 * Compares the month of the current date against the given $date month
+	 * Returns 0 if equal, -1 if current month is earlier or 1 if current month is later
+	 * For example: 10.03.2000 -> 15.03.1950 -> 0
+	 *
+	 * @param  Piwik_Date  $month   Month to compare
+	 * @return integer  0 = equal, 1 = later, -1 = earlier
+	 */
 	function compareMonth( Piwik_Date $date )
 	{
 		$currentMonth = date('n', $this->getTimestamp());
@@ -295,61 +305,61 @@ class Piwik_Date
 		}
 		return 1;
 	}
-	
+
 	/**
 	 * Returns true if current date is today
-	 * 
+	 *
 	 * @return bool
 	 */
 	public function isToday()
 	{
 		return $this->toString('Y-m-d') === Piwik_Date::factory('today', $this->timezone)->toString('Y-m-d');
 	}
-	
+
 	/**
 	 * Returns a date object set to now (same as today, except that the time is also set)
-	 * 
+	 *
 	 * @return Piwik_Date
 	 */
 	static public function now()
 	{
-		return new Piwik_date(time());
+		return new Piwik_Date(time());
 	}
-	
+
 	/**
 	 * Returns a date object set to today midnight
-	 * 
+	 *
 	 * @return Piwik_Date
 	 */
 	static public function today()
 	{
 		return new Piwik_Date(strtotime(date("Y-m-d 00:00:00")));
 	}
-	
+
 	/**
 	 * Returns a date object set to yesterday midnight
-	 * 
+	 *
 	 * @return Piwik_Date
 	 */
 	static public function yesterday()
 	{
 		return new Piwik_Date(strtotime("yesterday"));
 	}
-	
+
 	/**
 	 * Returns a date object set to yesterday same time of day
-	 * 
+	 *
 	 * @return Piwik_Date
 	 */
 	static public function yesterdaySameTime()
 	{
 		return new Piwik_Date(strtotime("yesterday ".date('H:i:s')));
 	}
-	
+
 	/**
 	 * Sets the time part of the date
 	 * Doesn't modify $this
-	 * 
+	 *
 	 * @param string $time HH:MM:SS
 	 * @return Piwik_Date The new date with the time part set
 	 */
@@ -357,19 +367,19 @@ class Piwik_Date
 	{
 		return new Piwik_Date( strtotime( date("Y-m-d", $this->timestamp) . " $time"), $this->timezone);
 	}
-	
-    /**
-     * Sets a new day
-     * Returned is the new date object
-     * Doesn't modify $this
-     * 
-     * @param int Day eg. 31
-     * @return Piwik_Date  new date
-     */
+
+	/**
+	 * Sets a new day
+	 * Returned is the new date object
+	 * Doesn't modify $this
+	 *
+	 * @param int Day eg. 31
+	 * @return Piwik_Date  new date
+	 */
 	public function setDay( $day )
 	{
 		$ts = $this->timestamp;
-		$result = mktime( 
+		$result = mktime(
 						date('H', $ts),
 						date('i', $ts),
 						date('s', $ts),
@@ -379,19 +389,19 @@ class Piwik_Date
 					);
 		return new Piwik_Date( $result, $this->timezone );
 	}
-	
-    /**
-     * Sets a new year
-     * Returned is the new date object
-     * Doesn't modify $this
-     * 
-     * @param int 2010
-     * @return Piwik_Date  new date
-     */
+
+	/**
+	 * Sets a new year
+	 * Returned is the new date object
+	 * Doesn't modify $this
+	 *
+	 * @param int 2010
+	 * @return Piwik_Date  new date
+	 */
 	public function setYear( $year )
 	{
 		$ts = $this->timestamp;
-		$result = mktime( 
+		$result = mktime(
 						date('H', $ts),
 						date('i', $ts),
 						date('s', $ts),
@@ -401,39 +411,39 @@ class Piwik_Date
 					);
 		return new Piwik_Date( $result, $this->timezone );
 	}
-	
-    /**
-     * Subtracts days from the existing date object and returns a new Piwik_Date object
-     * Returned is the new date object
-     * Doesn't modify $this
-     * 
-     * @return Piwik_Date  new date
-     */
-    public function subDay( $n )
-    {
-    	if($n === 0) 
-    	{
-    		return clone $this;
-    	}
-    	$ts = strtotime("-$n day", $this->timestamp);
+
+	/**
+	 * Subtracts days from the existing date object and returns a new Piwik_Date object
+	 * Returned is the new date object
+	 * Doesn't modify $this
+	 *
+	 * @return Piwik_Date  new date
+	 */
+	public function subDay( $n )
+	{
+		if($n === 0)
+		{
+			return clone $this;
+		}
+		$ts = strtotime("-$n day", $this->timestamp);
 		return new Piwik_Date( $ts, $this->timezone );
-    }
-    
-    /**
-     * Subtracts a month from the existing date object.
-     * Returned is the new date object
-     * Doesn't modify $this
-     * 
-     * @return Piwik_Date  new date
-     */
-    public function subMonth( $n )
-    {
-    	if($n === 0) 
-    	{
-    		return clone $this;
-    	}
+	}
+
+	/**
+	 * Subtracts a month from the existing date object.
+	 * Returned is the new date object
+	 * Doesn't modify $this
+	 *
+	 * @return Piwik_Date  new date
+	 */
+	public function subMonth( $n )
+	{
+		if($n === 0)
+		{
+			return clone $this;
+		}
 		$ts = $this->timestamp;
-		$result = mktime( 
+		$result = mktime(
 						date('H', $ts),
 						date('i', $ts),
 						date('s', $ts),
@@ -442,12 +452,12 @@ class Piwik_Date
 						date('Y', $ts)
 					);
 		return new Piwik_Date( $result, $this->timezone );
-    }
-	
+	}
+
 	/**
-	 * Returns a localized date string, given a template. 
+	 * Returns a localized date string, given a template.
 	 * Allowed tags are: %day%, %shortDay%, %longDay%, etc.
-	 * 
+	 *
 	 * @param $template string eg. %shortMonth% %longYear%
 	 * @return string eg. "Aug 2009"
 	 */
@@ -470,28 +480,28 @@ class Piwik_Date
 		return $out;
 	}
 
-    /**
-     * Adds days to the existing date object.
-     * Returned is the new date object
-     * Doesn't modify $this
-     * 
-     * @param int Number of days to add
-     * @return  Piwik_Date new date
-     */
+	/**
+	 * Adds days to the existing date object.
+	 * Returned is the new date object
+	 * Doesn't modify $this
+	 *
+	 * @param int Number of days to add
+	 * @return  Piwik_Date new date
+	 */
 	public function addDay( $n )
 	{
 		$ts = strtotime("+$n day", $this->timestamp);
 		return new Piwik_Date( $ts, $this->timezone );
 	}
-	
-    /**
-     * Adds hours to the existing date object.
-     * Returned is the new date object
-     * Doesn't modify $this
-     * 
-     * @param int Number of hours to add
-     * @return  Piwik_Date new date
-     */
+
+	/**
+	 * Adds hours to the existing date object.
+	 * Returned is the new date object
+	 * Doesn't modify $this
+	 *
+	 * @param int Number of hours to add
+	 * @return  Piwik_Date new date
+	 */
 	public function addHour( $n )
 	{
 		$isNegative = ($n < 0);
@@ -500,15 +510,15 @@ class Piwik_Date
 		{
 			if($n >= 1 || $n <= -1)
 			{
-    			$extraMinutes = floor(abs($n));
-    			if($isNegative)
-    			{
-    				$extraMinutes = -$extraMinutes;
-    			}
-    			$minutes = abs($n - $extraMinutes) * 60;
-    			if($isNegative) {
-    				$minutes *= -1;
-    			}
+				$extraMinutes = floor(abs($n));
+				if($isNegative)
+				{
+					$extraMinutes = -$extraMinutes;
+				}
+				$minutes = abs($n - $extraMinutes) * 60;
+				if($isNegative) {
+					$minutes *= -1;
+				}
 			}
 			else
 			{
@@ -516,7 +526,7 @@ class Piwik_Date
 			}
 			$n = floor(abs($n));
 			if($isNegative) {
-    			$n *= -1;
+				$n *= -1;
 			}
 		}
 		$ts = $this->timestamp + round($minutes * 60) + $n * 3600;
@@ -525,32 +535,32 @@ class Piwik_Date
 
 	/**
 	 * Substract hour to the existing date object.
-     * Returned is the new date object
-     * Doesn't modify $this
-     * 
-     * @param int Number of hours to substract
-     * @return  Piwik_Date new date
-     */
+	 * Returned is the new date object
+	 * Doesn't modify $this
+	 *
+	 * @param int Number of hours to substract
+	 * @return  Piwik_Date new date
+	 */
 	public function subHour( $n )
 	{
 		return $this->addHour(-$n);
 	}
-	
+
 	/**
-     * Adds period to the existing date object.
-     * Returned is the new date object
-     * Doesn't modify $this
-     * 
-     * @param int Number of period to add
-     * @return  Piwik_Date new date
-     */
+	 * Adds period to the existing date object.
+	 * Returned is the new date object
+	 * Doesn't modify $this
+	 *
+	 * @param int Number of period to add
+	 * @return  Piwik_Date new date
+	 */
 	public function addPeriod( $n, $period )
 	{
-		if($n < 0) 
+		if($n < 0)
 		{
 			$ts = strtotime("$n $period", $this->timestamp);
 		}
-		else 
+		else
 		{
 			$ts = strtotime("+$n $period", $this->timestamp);
 		}
@@ -558,13 +568,13 @@ class Piwik_Date
 	}
 
 	/**
-     * Subtracts period from the existing date object.
-     * Returned is the new date object
-     * Doesn't modify $this
-     *
-     * @param int Number of period to sub
-     * @return  Piwik_Date new date
-     */
+	 * Subtracts period from the existing date object.
+	 * Returned is the new date object
+	 * Doesn't modify $this
+	 *
+	 * @param int Number of period to sub
+	 * @return  Piwik_Date new date
+	 */
 	public function subPeriod( $n, $period )
 	{
 		return $this->addPeriod(-$n, $period );