phpDoc fixes
[squirrelmail.git] / functions / date.php
index 2f65cc6cc3a8aa311cdc33082c98481f0ad958ff..55502c2ef33d816f7238d9c33ec61a4bf7e5f703 100644 (file)
@@ -3,7 +3,7 @@
 /**
  * date.php
  *
- * Copyright (c) 1999-2004 The SquirrelMail Project Team
+ * Copyright (c) 1999-2005 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
  * Takes a date and parses it into a usable format.  The form that a
@@ -11,8 +11,9 @@
  *       <Tue,> 29 Jun 1999 09:52:11 -0500 (EDT)
  * (as specified in RFC 822) -- 'Tue' is optional
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
+ * @subpackage date
  */
 
 /** Load up some useful constants */
@@ -89,7 +90,7 @@ function getGMTSeconds($stamp, $tzc) {
     if ($neg) $iTzc = -1 * (int) $iTzc;
     /* stamp in gmt */
     $stamp -= $iTzc;
-    /** now find what the server is at **/
+    /* now find what the server is at */
     $current = date('Z', time());
     /* stamp in local timezone */
     $stamp += $current;
@@ -289,9 +290,9 @@ function date_intl( $date_format, $stamp ) {
     $aParts = explode('#',$ret);
     $ret = str_replace(array('$1','$4','$2','$3',), array(getDayAbrv($aParts[0]),
                                                           getMonthAbrv($aParts[1]),
-                                                         getMonthName($aParts[1]),
-                                                         getDayName($aParts[0])),
-                                                         $aParts[2]);
+                                                          getMonthName($aParts[1]),
+                                                          getDayName($aParts[0])),
+                                                          $aParts[2]);
     return( $ret );
 }
 
@@ -314,7 +315,7 @@ function getLongDateString( $stamp ) {
     if ( $hour_format == SMPREF_TIME_12HR ) {
         $date_format = _("D, F j, Y g:i a");
     } else {
-        $date_format = _("D, F j, Y G:i");
+        $date_format = _("D, F j, Y H:i");
     }
 
     return( date_intl( $date_format, $stamp ) );
@@ -348,8 +349,16 @@ function getDateString( $stamp ) {
     if ($invert_time) {
         $dateZ = - $dateZ;
     }
+
+    // calculate when it was midnight and when it will be,
+    // in order to display dates differently if they're 'today'
     $midnight = $now - ($now % 86400) - $dateZ;
-    $nextmid = $midnight + 86400 - $dateZ;
+    // this is to correct if after calculations midnight is more than
+    // one whole day away.
+    if ($now - $midnight > 86400) {
+        $midnight += 86400;
+    }
+    $nextmid = $midnight + 86400;
 
     if (($show_full_date == 1) || ($nextmid < $stamp)) {
         $date_format = _("M j, Y");
@@ -358,14 +367,14 @@ function getDateString( $stamp ) {
         if ( $hour_format == SMPREF_TIME_12HR ) {
             $date_format = _("g:i a");
         } else {
-            $date_format = _("G:i");
+            $date_format = _("H:i");
         }
     } else if ($midnight - 518400 < $stamp) {
         /* This week */
         if ( $hour_format == SMPREF_TIME_12HR ) {
             $date_format = _("D, g:i a");
         } else {
-            $date_format = _("D, G:i");
+            $date_format = _("D, H:i");
         }
     } else {
         /* before this week */
@@ -382,18 +391,18 @@ function getDateString( $stamp ) {
  * @return int the timestamp calculated from the header
  */
 function getTimeStamp($dateParts) {
-    /** $dateParts[0] == <day of week>   Mon, Tue, Wed
-    ** $dateParts[1] == <day of month>  23
-    ** $dateParts[2] == <month>         Jan, Feb, Mar
-    ** $dateParts[3] == <year>          1999
-    ** $dateParts[4] == <time>          18:54:23 (HH:MM:SS)
-    ** $dateParts[5] == <from GMT>      +0100
-    ** $dateParts[6] == <zone>          (EDT)
-    **
-    ** NOTE:  In RFC 822, it states that <day of week> is optional.
-    **        In that case, dateParts[0] would be the <day of month>
-    **        and everything would be bumped up one.
-    **/
+    /* $dateParts[0] == <day of week>   Mon, Tue, Wed
+     * $dateParts[1] == <day of month>  23
+     * $dateParts[2] == <month>         Jan, Feb, Mar
+     * $dateParts[3] == <year>          1999
+     * $dateParts[4] == <time>          18:54:23 (HH:MM:SS)
+     * $dateParts[5] == <from GMT>      +0100
+     * $dateParts[6] == <zone>          (EDT)
+     *
+     * NOTE:  In RFC 822, it states that <day of week> is optional.
+     *        In that case, dateParts[0] would be the <day of month>
+     *        and everything would be bumped up one.
+     */
 
     /*
      * Simply check to see if the first element in the dateParts
@@ -437,7 +446,7 @@ function getTimeStamp($dateParts) {
 }
 
 /* I use this function for profiling. Should never be called in
-   actual versions of squirrelmail released to public. */
+   actual versions of SquirrelMail released to public. */
 /*
    function getmicrotime() {
       $mtime = microtime();
@@ -446,4 +455,4 @@ function getTimeStamp($dateParts) {
       return ($mtime);
    }
 */
-?>
+?>
\ No newline at end of file