X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;ds=sidebyside;f=WEB-INF%2Flib%2FttTimeHelper.class.php;h=354bd2b24d0ab1a7c574f1d9117b80c3931914ab;hb=6b4d39a350249fb3f71d49706d242e6d341c2200;hp=48ebdc91816dfd2656ec9f1b721c02406dac59b3;hpb=26f9b4e344163cc2a843f48c3163653b94b32911;p=timetracker.git

diff --git a/WEB-INF/lib/ttTimeHelper.class.php b/WEB-INF/lib/ttTimeHelper.class.php
index 48ebdc91..354bd2b2 100644
--- 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;
   }
 
-  // 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));
-    if (strlen($hours) == 1)
-      $hours = '0'.$hours;
     if (strlen($mins) == 1)
       $mins = '0' . $mins;
     return $hours.':'.$mins;
@@ -733,8 +731,8 @@ class ttTimeHelper {
     return $result;
   }
 
-  // getGroupedRecordsForInterval - returns time records for a user for a given interval of dates grouped in an array of dates.
-  // Example: for a week view we want one row representing the same attributes to have 7 values for each day of week.
+  // getDataForWeekView - builds an array to render a table of durations for week view.
+  // In a week view we want one row representing the same attributes to have 7 values for each day of week.
   // We identify simlar records by a combination of client, billable, project, task, and custom field values.
   // This will allow us to extend the feature when more custom fields are added.
   //
@@ -743,29 +741,86 @@ class ttTimeHelper {
   //
   // "cl:546,bl:0,pr:23456,ts:27464,cf_1:7623"
   // The above means client 546, not billable, project 23456, task 27464, custom field option id 7623.
-  static function getGroupedRecordsForInterval($user_id, $start_date, $end_date) {
+  //
+  // Description of $dataArray format that the function returns.
+  // $dataArray = array(
+  //   array( // Row 0.
+  //     'row_id' => 'cl:546,bl:1,pr:23456,ts:27464,cf_1:7623_0', // Row identifier. See ttTimeHelper::makeRecordIdentifier().
+  //     'label' => 'Anuko - Time Tracker - Coding',              // Human readable label for the row describing what this time entry is for.
+  //     'day_0' => array('control_id' => '0_day_0', 'tt_log_id' => 12345, 'duration' => '00:00'), // control_id is row_id plus day header for column.
+  //     'day_1' => array('control_id' => '0_day_1', 'tt_log_id' => 12346, 'duration' => '01:00'),
+  //     'day_2' => array('control_id' => '0_day_2', 'tt_log_id' => 12347, 'duration' => '02:00'),
+  //     'day_3' => array('control_id' => '0_day_3', 'tt_log_id' => null, 'duration' => null),
+  //     'day_4' => array('control_id' => '0_day_4', 'tt_log_id' => 12348, 'duration' => '04:00'),
+  //     'day_5' => array('control_id' => '0_day_5', 'tt_log_id' => 12349, 'duration' => '04:00'),
+  //     'day_6' => array('control_id' => '0_day_6', 'tt_log_id' => null, 'duration' => null)
+  //   ),
+  //   array( // Row 1.
+  //     'row_id' => 'bl:0_0',
+  //     'label' => '', // In this case the label is empty as we don't have anything to put into it, as we only have billable flag.
+  //     'day_0' => array('control_id' => '1_day_0', 'tt_log_id' => null, 'duration' => null),
+  //     'day_1' => array('control_id' => '1_day_1', 'tt_log_id' => 12350, 'duration' => '01:30'),
+  //     'day_2' => array('control_id' => '1_day_2', 'tt_log_id' => null, 'duration' => null),
+  //     'day_3' => array('control_id' => '1_day_3', 'tt_log_id' => 12351,'duration' => '02:30'),
+  //     'day_4' => array('control_id' => '1_day_4', 'tt_log_id' => 12352, 'duration' => '04:00'),
+  //     'day_5' => array('control_id' => '1_day_5', 'tt_log_id' => null, 'duration' => null),
+  //     'day_6' => array('control_id' => '1_day_6', 'tt_log_id' => null, 'duration' => null)
+  //   )
+  // );
+  static function getDataForWeekView($user_id, $start_date, $end_date, $dayHeaders) {
     // Start by obtaining all records in interval.
-    // Then, iterate through them to build an array.
     $records = ttTimeHelper::getRecordsForInterval($user_id, $start_date, $end_date);
-    $groupedRecords = array();
+
+    $dataArray = array();
+
+    // Iterate through records and build $dataArray cell by cell.
     foreach ($records as $record) {
-      $record_identifier_no_suffix = ttTimeHelper::makeRecordIdentifier($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_identifier = $record_identifier_no_suffix.'_'.$suffix;
-      while (!empty($groupedRecords[$record_identifier][$record['date']])) {
+      $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_identifier = $record_identifier_no_suffix.'_'.$suffix;
+        $record_id = $record_id_no_suffix.'_'.$suffix;
+      }
+      // Find row.
+      $pos = ttTimeHelper::findRow($record_id, $dataArray);
+      if ($pos < 0) {
+        $dataArray[] = array('row_id' => $record_id,'label' => ttTimeHelper::makeRecordLabel($record)); // Insert row.
+        $pos = ttTimeHelper::findRow($record_id, $dataArray);
+        // Insert empty cells with proper control ids.
+        for ($i = 0; $i < 7; $i++) {
+          $control_id = $pos.'_'. $dayHeaders[$i];
+          $dataArray[$pos][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'duration' => null);
+        }
       }
-      $groupedRecords[$record_identifier][$record['date']] = array('id'=>$record['id'], 'duration'=>$record['duration']);
-      $groupedRecords[$record_identifier]['client'] = $record['client'];
-      $groupedRecords[$record_identifier]['cf_1_value'] = $record['cf_1_value'];
-      $groupedRecords[$record_identifier]['project'] = $record['project'];
-      $groupedRecords[$record_identifier]['task'] = $record['task'];
-      $groupedRecords[$record_identifier]['billable'] = $record['billable'];
+      // Insert actual cell data from $record (one cell only).
+      $dataArray[$pos][$day_header] = array('control_id' => $pos.'_'. $day_header, 'tt_log_id' => $record['id'],'duration' => $record['duration']);
     }
+    return $dataArray;
+  }
 
-    return $groupedRecords;
+  // 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($row_id, $day_header, $dataArray) {
+    foreach($dataArray as $row) {
+      if ($row['row_id'] == $row_id && !empty($row[$day_header]['duration']))
+        return true;
+    }
+    return false;
+  }
+
+  // findRow returns an existing row position in $dataArray, -1 otherwise.
+  static function findRow($row_id, $dataArray) {
+    $pos = 0; // Row position in array.
+    foreach($dataArray as $row) {
+      if ($row['row_id'] == $row_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).
@@ -796,22 +851,100 @@ class ttTimeHelper {
     return $record_identifier;
   }
 
-  // getGroupedRecordsTotals - returns day totals for grouped records.
-  static function getGroupedRecordsTotals($groupedRecords) {
-    $groupedRecordsTotals = array();
-    foreach ($groupedRecords as $groupedRecord) {
-      foreach($groupedRecord as $key => $dayEntry) {
-        if ($dayEntry['duration']) {
-          $minutes = ttTimeHelper::toMinutes($dayEntry['duration']);
-          $groupedRecordsTotals[$key] += $minutes;
+  // 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;
+  }
+
+  // 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[] = (string) $objDate->getDate(); // It returns an int on first call.
+    if (strlen($dayHeaders[0]) == 1)              // Which is an implementation detail of DateAndTime class.
+      $dayHeaders[0] = '0'.$dayHeaders[0];        // Add a 0 for single digit day.
+    $objDate->incDay();
+    $dayHeaders[] = $objDate->getDate(); // After incDay it returns a string with leading 0, when necessary.
+    $objDate->incDay();
+    $dayHeaders[] = $objDate->getDate();
+    $objDate->incDay();
+    $dayHeaders[] = $objDate->getDate();
+    $objDate->incDay();
+    $dayHeaders[] = $objDate->getDate();
+    $objDate->incDay();
+    $dayHeaders[] = $objDate->getDate();
+    $objDate->incDay();
+    $dayHeaders[] = $objDate->getDate();
+    unset($objDate);
+    return $dayHeaders;
+  }
+
+    // getLockedDaysForWeek - builds an arrays of locked days in week.
+  static function getLockedDaysForWeek($start_date) {
+    global $user;
+    $lockedDays = array();
+    $objDate = new DateAndTime(DB_DATEFORMAT, $start_date);
+    $lockedDays[] = $user->isDateLocked($objDate);
+    $objDate->incDay();
+    $lockedDays[] = $user->isDateLocked($objDate);
+    $objDate->incDay();
+    $lockedDays[] = $user->isDateLocked($objDate);
+    $objDate->incDay();
+    $lockedDays[] = $user->isDateLocked($objDate);
+    $objDate->incDay();
+    $lockedDays[] = $user->isDateLocked($objDate);
+    $objDate->incDay();
+    $lockedDays[] = $user->isDateLocked($objDate);
+    $objDate->incDay();
+    $lockedDays[] = $user->isDateLocked($objDate);
+    unset($objDate);
+    return $lockedDays;
+  }
+
+  // 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 ($groupedRecordsTotals as $key => $single_total) {
-      $groupedRecordsTotals[$key] = ttTimeHelper::toAbsDuration($single_total);
+    foreach($dayHeaders as $dayHeader) {
+      $dayTotals[$dayHeader] = ttTimeHelper::toAbsDuration($dayTotals[$dayHeader]);
     }
-
-    return $groupedRecordsTotals;
+    return $dayTotals;
   }
 }
+