Changeset 760 for branches/1.1dev/lib

Timestamp:

Feb 10, 2022 3:48:07 AM (2 years ago)

Author:

anonymous

Message:

Add humanTime() function

File:

• branches/1.1dev/lib/Utilities.inc.php (modified) (1 diff)

branches/1.1dev/lib/Utilities.inc.php

@@ -411 +411 @@
 }
 
+/*
+* Returns a human readable amount of time for the given amount of seconds.
+*
+* 45 seconds
+* 12 minutes
+* 3.5 hours
+* 2 days
+* 1 week
+* 4 months
+*
+* Months are calculated using the real number of days in a year: 365.2422 / 12.
+*
+* @access   public
+* @param    int $seconds Seconds of time.
+* @param    string $max_unit Key value from the $units array.
+* @param    string $format Sprintf formatting string.
+* @return   string Value of units elapsed.
+* @author   Quinn Comendant <quinn@strangecode.com>
+* @version  1.0
+* @since    23 Jun 2006 12:15:19
+*/
+function humanTime($seconds, $max_unit=null, $format='%01.1f')
+{
+    // Units: array of seconds in the unit, singular and plural unit names.
+    $units = array(
+        'second' => array(1, _("second"), _("seconds")),
+        'minute' => array(60, _("minute"), _("minutes")),
+        'hour' => array(3600, _("hour"), _("hours")),
+        'day' => array(86400, _("day"), _("days")),
+        'week' => array(604800, _("week"), _("weeks")),
+        'month' => array(2629743.84, _("month"), _("months")),
+        'year' => array(31556926.08, _("year"), _("years")),
+        'decade' => array(315569260.8, _("decade"), _("decades")),
+        'century' => array(3155692608, _("century"), _("centuries")),
+    );
+
+    // Max unit to calculate.
+    $max_unit = isset($units[$max_unit]) ? $max_unit : 'year';
+
+    $final_time = $seconds;
+    $final_unit = 'second';
+    foreach ($units as $k => $v) {
+        if ($seconds >= $v[0]) {
+            $final_time = $seconds / $v[0];
+            $final_unit = $k;
+        }
+        if ($max_unit == $final_unit) {
+            break;
+        }
+    }
+    $final_time = sprintf($format, $final_time);
+    return sprintf('%s %s', $final_time, (1 == $final_time ? $units[$final_unit][1] : $units[$final_unit][2]));
+}
+
 /**
  * If $var is net set or null, set it to $default. Otherwise leave it alone.