Wrote validateDuration function.
[timetracker.git] / WEB-INF / lib / ttTimeHelper.class.php
index c92cf47..6b1efe0 100644 (file)
@@ -82,7 +82,7 @@ class ttTimeHelper {
 
   // isValidDuration validates a value as a time duration string (in hours and minutes).
   static function isValidDuration($value) {
-    if (strlen($value)==0 || !isset($value)) return false;
+    if (strlen($value) == 0 || !isset($value)) return false;
 
     if ($value == '24:00' || $value == '2400') return true;
 
@@ -102,6 +102,65 @@ class ttTimeHelper {
     return false;
   }
 
+  // validateDuration - a future replacement of the isValidDuration above.
+  // Validates a passed in $value as a time duration string in hours and / or minutes.
+  // Returns either a normalized duration (hh:mm) or false if $value is invalid.
+  //
+  // This is a convenience function that allows users to pass in data in a variety of formats.
+  //
+  // 3 or 3h  - means 3 hours - normalized 3:00. Note: h and m letters are not localized.
+  // 0.25 or 0.25h or .25 or .25h - means a quarter of hour - normalized 0:15.
+  // 0,25 0r 0,25h or ,25 or ,25h - means the same as above for users with comma ad decimal mark.
+  // 1:30 - means 1 hour 30 mminutes - normalized 1:30.
+  // 25m - means 25 minutes - normalized 0:25.
+  static function validateDuration($value) {
+    // Handle empty value.
+    if (!isset($value) || strlen($value) == 0)
+      return false;
+
+    // Handle whole hours.
+    if (preg_match('/^([0-1]{0,1}[0-9]|2[0-4])h?$/', $value )) { // 0, 1 ... 24
+      $normalized = trim($value, 'h');
+      $normalized .= ':00';
+      return $normalized;
+    }
+    // Handle already normalized value.
+    if (preg_match('/^([0-1]{0,1}[0-9]|2[0-3]):?[0-5][0-9]$/', $value )) { // 0:00 - 23:59, 000 - 2359
+      return $value;
+    }
+    // Handle a special case of 24:00.
+    if ($value == '24:00') {
+      return $value;
+    }
+    // Handle localized fractional hours.
+    global $user;
+    $localizedPattern = '/^([0-1]{0,1}[0-9]|2[0-3])?['.$user->decimal_mark.'][0-9]{1,4}h?$/';
+    if (preg_match($localizedPattern, $value )) { // decimal values like 0.5, 1.25h, ... .. 23.9999h (or with comma)
+        if ($user->decimal_mark == ',')
+          $value = str_replace (',', '.', $value);
+
+        $val = floatval($value);
+        $mins = round($val * 60);
+        $hours = (string)((int)($mins / 60));
+        $mins = (string)($mins % 60);
+        if (strlen($mins) == 1)
+          $mins = '0' . $mins;
+        return $hours.':'.$mins;
+    }
+    // Handle minutes.
+    if (preg_match('/^\d{1,4}m$/', $value )) { // ddddm
+      $mins = (int) trim($value, 'm');
+      if ($mins > 1440) // More minutes than an entire day could hold.
+        return false;
+      $hours = (string)((int)($mins / 60));
+      $mins = (string)($mins % 60);
+      if (strlen($mins) == 1)
+        $mins = '0' . $mins;
+      return $hours.':'.$mins;
+    }
+    return false;
+  }
+
   // normalizeDuration - converts a valid time duration string to format 00:00.
   static function normalizeDuration($value, $leadingZero = true) {
     $time_value = $value;
@@ -162,11 +221,14 @@ class ttTimeHelper {
 
   // toAbsDuration - converts a number of minutes to format 0:00
   // even if $minutes is negative.
-  static function toAbsDuration($minutes){
+  static function toAbsDuration($minutes, $abbreviate = false){
     $hours = (string)((int)abs($minutes / 60));
-    $mins = (string)(abs($minutes % 60));
+    $mins = (string) round(abs(fmod($minutes, 60)));
     if (strlen($mins) == 1)
       $mins = '0' . $mins;
+    if ($abbreviate && $mins == '00')
+      return $hours;
+
     return $hours.':'.$mins;
   }
 
@@ -418,6 +480,7 @@ class ttTimeHelper {
   // update - updates a record in log table. Does not update its custom fields.
   static function update($fields)
   {
+    global $user;
     $mdb2 = getConnection();
 
     $id = $fields['id'];
@@ -430,19 +493,26 @@ class ttTimeHelper {
     $finish = $fields['finish'];
     $duration = $fields['duration'];
     $note = $fields['note'];
-    $billable = $fields['billable'];
+
+    $billable_part = '';
+    if ($user->isPluginEnabled('iv')) {
+      $billable_part = $fields['billable'] ? ', billable = 1' : ', billable = 0';
+    }
+    $paid_part = '';
+    if ($user->canManageTeam() && $user->isPluginEnabled('ps')) {
+      $paid_part = $fields['paid'] ? ', paid = 1' : ', paid = 0';
+    }
 
     $start = ttTimeHelper::to24HourFormat($start);
     $finish = ttTimeHelper::to24HourFormat($finish);
     if ('00:00' == $finish) $finish = '24:00';
     $duration = ttTimeHelper::normalizeDuration($duration);
 
-    if (!$billable) $billable = 0;
     if ($start) $duration = '';
 
     if ($duration) {
       $sql = "UPDATE tt_log set start = NULL, duration = '$duration', client_id = ".$mdb2->quote($client).", project_id = ".$mdb2->quote($project).", task_id = ".$mdb2->quote($task).", ".
-        "comment = ".$mdb2->quote($note).", billable = $billable, date = '$date' WHERE id = $id";
+        "comment = ".$mdb2->quote($note)."$billable_part $paid_part, date = '$date' WHERE id = $id";
       $affected = $mdb2->exec($sql);
       if (is_a($affected, 'PEAR_Error'))
         return false;
@@ -455,7 +525,7 @@ class ttTimeHelper {
         return false;
 
       $sql = "UPDATE tt_log SET start = '$start', duration = '$duration', client_id = ".$mdb2->quote($client).", project_id = ".$mdb2->quote($project).", task_id = ".$mdb2->quote($task).", ".
-        "comment = ".$mdb2->quote($note).", billable = $billable, date = '$date' WHERE id = $id";
+        "comment = ".$mdb2->quote($note)."$billable_part $paid_part, date = '$date' WHERE id = $id";
       $affected = $mdb2->exec($sql);
       if (is_a($affected, 'PEAR_Error'))
         return false;
@@ -601,7 +671,7 @@ class ttTimeHelper {
     $sql = "select l.id as id, l.timestamp as timestamp, TIME_FORMAT(l.start, $sql_time_format) as start,
       TIME_FORMAT(sec_to_time(time_to_sec(l.start) + time_to_sec(l.duration)), $sql_time_format) as finish,
       TIME_FORMAT(l.duration, '%k:%i') as duration,
-      p.name as project_name, t.name as task_name, l.comment, l.client_id, l.project_id, l.task_id, l.invoice_id, l.billable, l.date
+      p.name as project_name, t.name as task_name, l.comment, l.client_id, l.project_id, l.task_id, l.invoice_id, l.billable, l.paid, l.date
       from tt_log l
       left join tt_projects p on (p.id = l.project_id)
       left join tt_tasks t on (t.id = l.task_id)