Ticket #425: jduration.patch

testapp/modules/jelix_tests/tests/utils.jduration.html_cli.php

@@ +1 @@
+<?php
+/**
+* @package     testapp
+* @subpackage  jelix_tests module
+* @author      Florian Hatat
+* @copyright   2008 Florian Hatat
+* @link        http://www.jelix.org
+* @licence     GNU Lesser General Public Licence see LICENCE file or http://www.gnu.org/licenses/lgpl.html
+*/
+
+class testjDuration extends UnitTestCase {
+    function testReportedBug(){
+        // Get now date/time
+        $dtNow = new jDateTime();
+        $dtNow->setFromString("2008-02-08 00:27:22", jDateTime::DB_DTFORMAT);
+
+        // Get expiration date
+        $expirationDate = "2008-02-12 00:00:00";
+
+        // Create date time object from DB date
+        $dtExpirationDate = new jDateTime();
+        $dtExpirationDate->setFromString($expirationDate, jDateTime::DB_DTFORMAT);
+
+        // Compute difference between these dates
+        try
+        {
+            $countdown = $dtNow->durationTo($dtExpirationDate);
+            $dtNow->add($countdown);
+            $this->assertEqual($dtNow, $dtExpirationDate);
+        }
+        catch (Exception $e)
+        {
+            $this->fail("Rejected duration construction");
+        }
+    }
+
+    function testPositive(){
+        $dur = new jDuration(20);
+        $dt = new jDateTime(2007, 12, 25, 15, 28, 17);
+        $dtExpected = new jDateTime(2007, 12, 25, 15, 28, 37);
+        $dt->add($dur);
+        $this->assertEqual($dt, $dtExpected);
+    }
+
+    function testRelative1(){
+        $dur = new jDuration(array("month" => 1));
+        $dt = new jDateTime(2007, 8, 14, 15, 28, 17);
+        $dtExpected = new jDateTime(2007, 9, 14, 15, 28, 17);
+        $dt->add($dur);
+        $this->assertEqual($dt, $dtExpected);
+    }
+
+    function testRelative2(){
+        $dur = new jDuration(array("month" => 1));
+        $dt = new jDateTime(2007, 1, 14, 15, 28, 17);
+        $dtExpected = new jDateTime(2006, 12, 14, 15, 28, 17);
+        $dt->sub($dur);
+        $this->assertEqual($dt, $dtExpected);
+    }
+
+    // Add one month to August, 31st, you would get something like "September, 
+    // 31st", which gets "rounded" to October, 1st. For the moment, jDuration 
+    // has no option to prevent from crossing the "month" barrier.
+    function testRelativeTricky(){
+        $dur = new jDuration(array("month" => 1));
+        $dt = new jDateTime(2007, 8, 31, 15, 28, 17);
+        $dtExpected = new jDateTime(2007, 10, 1, 15, 28, 17);
+        $dt->add($dur);
+        $this->assertEqual($dt, $dtExpected);
+    }
+
+    function testNegative(){
+        $dur = new jDuration(-20);
+        $dt = new jDateTime(2007, 12, 25, 15, 28, 17);
+        $dtExpected = new jDateTime(2007, 12, 25, 15, 27, 57);
+        $dt->add($dur);
+        $this->assertEqual($dt, $dtExpected);
+    }
+
+    function testMultiplication(){
+        $dur = new jDuration(array("year" => 1));
+        $dur->mult(10); // Changed our mind, 10 years is better...
+        $dt = new jDateTime(2007, 1, 1, 23, 58, 3);
+        $dtExpected = new jDateTime(1997, 1, 1, 23, 58, 3);
+        $dt->sub($dur);
+        $this->assertEqual($dt, $dtExpected);
+    }
+
+    function testLeap1(){
+        $dur = new jDuration(array("year" => 8));
+        $dt = new jDateTime(2000, 2, 29, 12, 12, 12);
+        $dtExpected = new jDateTime(2008, 2, 29, 12, 12, 12);
+        $dt->add($dur);
+        $this->assertEqual($dt, $dtExpected);
+    }
+
+    function testLeap2(){
+        $dur = new jDuration(array("year" => 7));
+        $dt = new jDateTime(2000, 2, 29, 12, 12, 12);
+        $dtExpected = new jDateTime(1993, 3, 1, 12, 12, 12);
+        $dt->sub($dur);
+        $this->assertEqual($dt, $dtExpected);
+    }
+}
+?>

lib/jelix/utils/jDuration.class.php

@@ +1 @@
+<?php
+/**
+* @package     jelix
+* @subpackage  utils
+* @author      Florian Hatat
+* @copyright   2008 Florian Hatat
+*
+* @link        http://www.jelix.org
+* @licence     http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public Licence, see LICENCE file
+*/
+
+/**
+ * Utility to manipulate durations between two instants
+ * @package     jelix
+ * @subpackage  utils
+ */
+class jDuration {
+    public $months;
+    public $days;
+    public $seconds;
+
+    /**
+     * Construct a new duration.
+     * You can specify the duration as a number of seconds, or as an associative 
+     * array which may contain the keys "year", "month", "day", "hour", "minute" 
+     * and "second". The former method defines an absolute duration (it will 
+     * always add the same number of seconds to any given date/time), while the 
+     * latter defines a relative duration (a duration of one month will for 
+     * example represent different amounts of time depending on the start date).
+     *
+     * This class represents years as 12 months, minutes as 60 seconds and hours 
+     * as 3600 seconds. There is no general conversion between months and days, 
+     * nor between days and hours (because of DST).
+     *
+     * @param int/array representation of the duration as an absolute number of seconds, or an array.
+     */
+    function __construct($init = 0){
+        $this->days = $this->months = $this->seconds = 0;
+
+        if(is_array($init)){
+            if(isset($init['year'])){
+                $this->months += intval($init['year']) * 12;
+            }
+
+            if(isset($init['month'])){
+                $this->months += intval($init['month']);
+            }
+
+            if(isset($init['day'])){
+                $this->days += intval($init['days']);
+            }
+
+            if(isset($init['hour'])){
+                $this->seconds += intval($init['hour']) * 3600;
+            }
+
+            if(isset($init['minute'])){
+                $this->seconds += intval($init['minute']) * 60;
+            }
+
+            if(isset($init['second'])){
+                $this->seconds += intval($init['second']);
+            }
+        }
+        elseif(is_int($init)){
+            $this->seconds = $init;
+        }
+    }
+
+    /**
+     * Add a duration to the current duration
+     * @param jDuration the duration value
+     */
+    function add($data){
+        $this->days += $data->days;
+        $this->months += $data->months;
+        $this->seconds += $data->seconds;
+    }
+
+    /**
+     * Multiply the current duration by an integer
+     * @param int the scaling integer
+     */
+    function mult($scale){
+        if(is_int($scale)){
+            $this->days *= $scale;
+            $this->months *= $scale;
+            $this->seconds *= $scale;
+        }
+    }
+}
+
+?>

lib/jelix/utils/jDateTime.class.php

@@ -8 +8 @@
-* @contributor Florian Hatat
-* @copyright   2005-2006 Laurent Jouanneau
-* @copyright   2007 Loic Mathaud
-
+-2008
-* @copyright   2001-2005 CopixTeam, GeraldCroes, Laurent Jouanneau
-*
-* This class was get originally from the Copix project (CopixDate.lib.php, Copix 2.3dev20050901, http://www.copix.org)
@@ -347 +347 @@
-
-    /**
-     * Add a duration to the date.
-ateTime object (which then is not a date/time)
-or give each value of the duration
-ateTime
+uration object or give each value of
+the duration.
+uration
-     * @param int $month month with 2 digits
-     * @param int $day day with 2 digits
-     * @param int $hour hour with 2 digits
@@ -357 +357 @@
-     * @param int $second second with 2 digits
-     */
-    public function add($year, $month=0, $day=0, $hour=0, $minute=0, $second=0) {
-ateTime
+uration
-            $dt = $year;
-        } else {
-
+
+
+
-        }
- ( $this->hour +  $dt->hour, $this->minute + $dt->minute, $this->second + $dt->second 
-, $this->day + $dt->day, $this->year + $dt
+($this->hour, $this->minute, $this->second + $dt->seconds
+s, $this->day + $dt->days, $this
-
-        $t = getdate ($t);
-        $this->year = $t['year'];
@@ -376 +378 @@
-
-    /**
-     * substract a <b>duration</b> to the date
-ateTime object (which then is not a date/time)
-or give each value of the duration
-ateTime
+uration object or give each value of
+the duration.
+uration
-     * @param int $month month with 2 digits
-     * @param int $day day with 2 digits
-     * @param int $hour hour with 2 digits
@@ -386 +388 @@
-     * @param int $second second with 2 digits
-     */
-    public function sub($year, $month=0, $day=0, $hour=0, $minute=0, $second=0) {
-ateTime
+uration
-            $dt = $year;
-        } else {
-            $dt = new jDateTime($year, $month, $day, $hour, $minute, $second);
-        }
-
-
-
-
-
-
-
-
-
-
+
+
-    }
-
-    /**
-     * to know the duration between two dates.
-     * @param jDateTime $dt  the date on which a sub will be made with the date on the current object
-
+
+
-     */
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    }
-
-    /**