Fixed labels for week view.

[timetracker.git] / WEB-INF / lib / ttTimeHelper.class.php

diff --git a/WEB-INF/lib/ttTimeHelper.class.php b/WEB-INF/lib/ttTimeHelper.class.php
index 48ebdc91816dfd2656ec9f1b721c02406dac59b3..4895956297d0dae8881ad261c3f23d2f0f1c2e3d 100644 (file)
--- a/WEB-INF/lib/ttTimeHelper.class.php
+++ b/WEB-INF/lib/ttTimeHelper.class.php
@@ -160,13 +160,11 @@ class ttTimeHelper {
     return (int)@$time_a[1] + ((int)@$time_a[0]) * 60;
   }
 
     return (int)@$time_a[1] + ((int)@$time_a[0]) * 60;
   }
 

-  // toAbsDuration - converts a number of minutes to format 00:00
+  // toAbsDuration - converts a number of minutes to format 0:00

   // even if $minutes is negative.
   static function toAbsDuration($minutes){
     $hours = (string)((int)abs($minutes / 60));
     $mins = (string)(abs($minutes % 60));
   // even if $minutes is negative.
   static function toAbsDuration($minutes){
     $hours = (string)((int)abs($minutes / 60));
     $mins = (string)(abs($minutes % 60));

-    if (strlen($hours) == 1)
-      $hours = '0'.$hours;

     if (strlen($mins) == 1)
       $mins = '0' . $mins;
     return $hours.':'.$mins;
     if (strlen($mins) == 1)
       $mins = '0' . $mins;
     return $hours.':'.$mins;


@@ -768,6 +766,58 @@ class ttTimeHelper {
     return $groupedRecords;
   }
 
     return $groupedRecords;
   }
 

+  // getDataForWeekView - builds an array to render a table of durations for week view.
+  static function getDataForWeekView($user_id, $start_date, $end_date) {
+    // Start by obtaining all records in interval.
+    $records = ttTimeHelper::getRecordsForInterval($user_id, $start_date, $end_date);
+
+    $dataArray = array();
+
+    // Iterate through records and build $dataArray cell by cell.
+    foreach ($records as $record) {
+      // Create record id without suffix.
+      $record_id_no_suffix = ttTimeHelper::makeRecordIdentifier($record);
+      // Handle potential multiple records with the same attributes by using a numerical suffix.
+      $suffix = 0;
+      $record_id = $record_id_no_suffix.'_'.$suffix;
+      $day_header = substr($record['date'], 8); // Day number in month.
+      while (ttTimeHelper::cellExists($record_id, $day_header, $dataArray)) {
+        $suffix++;
+        $record_id = $record_id_no_suffix.'_'.$suffix;
+      }
+      // Find row.
+      $pos = ttTimeHelper::findRow($record_id, $dataArray);
+      if ($pos < 0) {
+        $dataArray[] = array('id' => $record_id,'label' => ttTimeHelper::makeRecordLabel($record)); // Insert row.
+        $pos = ttTimeHelper::findRow($record_id, $dataArray);
+      }
+      // Insert cell data from $record.
+      $dataArray[$pos][$day_header] = array('id' => $record['id'],'duration' => $record['duration']);
+    }
+    return $dataArray;
+  }
+
+  // cellExists is a helper function for getDataForWeekView() to see if a cell with a given label
+  // and a day header already exists.
+  static function cellExists($record_id, $day_header, $dataArray) {
+    foreach($dataArray as $row) {
+      if ($row['id'] == $record_id && !empty($row[$day_header]['duration']))
+        return true;
+    }
+    return false;
+  }
+
+  // findRow returns an existing row position in $dataArray, -1 otherwise.
+  static function findRow($record_id, $dataArray) {
+    $pos = 0; // Row position in array.
+    foreach($dataArray as $row) {
+      if ($row['id'] == $record_id)
+        return $pos;
+      $pos++; // Increment for search.
+    }
+    return -1; // Row not found.
+  }
+

   // makeRecordIdentifier - builds a string identifying a record for a grouped display (such as a week view).
   // For example:
   // "cl:546,bl:0,pr:23456,ts:27464,cf_1:example text"
   // makeRecordIdentifier - builds a string identifying a record for a grouped display (such as a week view).
   // For example:
   // "cl:546,bl:0,pr:23456,ts:27464,cf_1:example text"


@@ -796,6 +846,34 @@ class ttTimeHelper {
     return $record_identifier;
   }
 
     return $record_identifier;
   }
 

+  // makeRecordLabel - builds a human readable label for a row in week view,
+  // which is a combination ot record properties.
+  // Client - Project - Task - Custom field 1.
+  // Note that billable property is not part of the label. Instead, we intend to
+  // identify such records with a different color in week view.
+  static function makeRecordLabel($record) {
+    global $user;
+    // Start with client.
+    if ($user->isPluginEnabled('cl'))
+      $label = $record['client'];
+
+    // Add project.
+    if (!empty($label) && !empty($record['project'])) $label .= ' - ';
+    $label .= $record['project'];
+
+    // Add task.
+    if (!empty($label) && !empty($record['task'])) $label .= ' - ';
+    $label .= $record['task'];
+
+    // Add custom field 1.
+    if ($user->isPluginEnabled('cf')) {
+      if (!empty($label) && !empty($record['cf_1_value'])) $label .= ' - ';
+      $label .= $record['cf_1_value'];
+    }
+
+    return $label;
+  }
+

   // getGroupedRecordsTotals - returns day totals for grouped records.
   static function getGroupedRecordsTotals($groupedRecords) {
     $groupedRecordsTotals = array();
   // getGroupedRecordsTotals - returns day totals for grouped records.
   static function getGroupedRecordsTotals($groupedRecords) {
     $groupedRecordsTotals = array();


@@ -814,4 +892,49 @@ class ttTimeHelper {
 
     return $groupedRecordsTotals;
   }
 
     return $groupedRecordsTotals;
   }

+
+  // getDayHeadersForWeek - obtains day column headers for week view, which are simply day numbers in month.
+  static function getDayHeadersForWeek($start_date) {
+    $dayHeaders = array();
+    $objDate = new DateAndTime(DB_DATEFORMAT, $start_date);
+    $dayHeaders['day_header_0'] = (string)$objDate->getDate(); // It returns an int on first call. Why?
+    $objDate->incDay();
+    $dayHeaders['day_header_1'] = $objDate->getDate();
+    $objDate->incDay();
+    $dayHeaders['day_header_2'] = $objDate->getDate();
+    $objDate->incDay();
+    $dayHeaders['day_header_3'] = $objDate->getDate();
+    $objDate->incDay();
+    $dayHeaders['day_header_4'] = $objDate->getDate();
+    $objDate->incDay();
+    $dayHeaders['day_header_5'] = $objDate->getDate();
+    $objDate->incDay();
+    $dayHeaders['day_header_6'] = $objDate->getDate();
+    unset($objDate);
+    return $dayHeaders;
+  }
+
+  // getDayTotals calculates total durations for each day from the existing data in $dataArray.
+  static function getDayTotals($dataArray, $dayHeaders) {
+    $dayTotals = array();
+
+    // Insert label.
+    global $i18n;
+    $dayTotals['label'] = $i18n->getKey('label.total');
+
+    foreach ($dataArray as $row) {
+      foreach($dayHeaders as $dayHeader) {
+        if (array_key_exists($dayHeader, $row)) {
+          $minutes = ttTimeHelper::toMinutes($row[$dayHeader]['duration']);
+          $dayTotals[$dayHeader] += $minutes;
+        }
+      }
+    }
+    // Convert minutes to hh:mm for display.
+    foreach($dayHeaders as $dayHeader) {
+      $dayTotals[$dayHeader] = ttTimeHelper::toAbsDuration($dayTotals[$dayHeader]);
+    }
+    return $dayTotals;
+  }

 }
 }

+