Added proper IDs to week view controls.

[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 4895956297d0dae8881ad261c3f23d2f0f1c2e3d..60ebe446d67c7fd992fade3a476be790835d47d7 100644 (file)
--- a/WEB-INF/lib/ttTimeHelper.class.php
+++ b/WEB-INF/lib/ttTimeHelper.class.php
@@ -731,8 +731,8 @@ class ttTimeHelper {
     return $result;
   }
 
     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.
   //
   // 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.
   //


@@ -741,33 +741,33 @@ 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.
   //
   // "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) {
-    // 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();
-    foreach ($records as $record) {
-      $record_identifier_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']])) {
-        $suffix++;
-        $record_identifier = $record_identifier_no_suffix.'_'.$suffix;
-      }
-      $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'];
-    }
-
-    return $groupedRecords;
-  }
-
-  // getDataForWeekView - builds an array to render a table of durations for week view.
-  static function getDataForWeekView($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', 'duration' => '00:00'), // control_id is row_id plus day header for column.
+  //     'day_1' => array('control_id' => '0_day_1', 'duration' => '01:00'),
+  //     'day_2' => array('control_id' => '0_day_2', 'duration' => '02:00'),
+  //     'day_3' => array('control_id' => '0_day_3', 'duration' => null),
+  //     'day_4' => array('control_id' => '0_day_4', 'duration' => '04:00'),
+  //     'day_5' => array('control_id' => '0_day_5', 'duration' => '04:00'),
+  //     'day_6' => array('control_id' => '0_day_6', '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', 'duration' => null),
+  //     'day_1' => array('control_id' => '1_day_1', 'duration' => '01:30'),
+  //     'day_2' => array('control_id' => '1_day_2', 'duration' => null),
+  //     'day_3' => array('control_id' => '1_day_3', 'duration' => '02:30'),
+  //     'day_4' => array('control_id' => '1_day_4', 'duration' => '04:00'),
+  //     'day_5' => array('control_id' => '1_day_5', 'duration' => null),
+  //     'day_6' => array('control_id' => '1_day_6', 'duration' => null)
+  //   )
+  // );
+  static function getDataForWeekView($user_id, $start_date, $end_date, $dayHeaders) {

     // Start by obtaining all records in interval.
     $records = ttTimeHelper::getRecordsForInterval($user_id, $start_date, $end_date);
 
     // Start by obtaining all records in interval.
     $records = ttTimeHelper::getRecordsForInterval($user_id, $start_date, $end_date);
 


@@ -788,30 +788,35 @@ class ttTimeHelper {
       // Find row.
       $pos = ttTimeHelper::findRow($record_id, $dataArray);
       if ($pos < 0) {
       // Find row.
       $pos = ttTimeHelper::findRow($record_id, $dataArray);
       if ($pos < 0) {

-        $dataArray[] = array('id' => $record_id,'label' => ttTimeHelper::makeRecordLabel($record)); // Insert row.
+        $dataArray[] = array('row_id' => $record_id,'label' => ttTimeHelper::makeRecordLabel($record)); // Insert row.

         $pos = ttTimeHelper::findRow($record_id, $dataArray);
         $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);
+        }

       }
       }

-      // Insert cell data from $record.
-      $dataArray[$pos][$day_header] = array('id' => $record['id'],'duration' => $record['duration']);
+      // 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;
   }
 
   // cellExists is a helper function for getDataForWeekView() to see if a cell with a given label
   // and a day header already exists.
     }
     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) {
+  static function cellExists($row_id, $day_header, $dataArray) {

     foreach($dataArray as $row) {
     foreach($dataArray as $row) {

-      if ($row['id'] == $record_id && !empty($row[$day_header]['duration']))
+      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.
         return true;
     }
     return false;
   }
 
   // findRow returns an existing row position in $dataArray, -1 otherwise.

-  static function findRow($record_id, $dataArray) {
+  static function findRow($row_id, $dataArray) {

     $pos = 0; // Row position in array.
     foreach($dataArray as $row) {
     $pos = 0; // Row position in array.
     foreach($dataArray as $row) {

-      if ($row['id'] == $record_id)
+      if ($row['row_id'] == $row_id)

         return $pos;
       $pos++; // Increment for search.
     }
         return $pos;
       $pos++; // Increment for search.
     }


@@ -874,42 +879,25 @@ class ttTimeHelper {
     return $label;
   }
 
     return $label;
   }
 

-  // 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;
-        }
-      }
-    }
-    // Convert minutes to hh:mm for display.
-    foreach ($groupedRecordsTotals as $key => $single_total) {
-      $groupedRecordsTotals[$key] = ttTimeHelper::toAbsDuration($single_total);
-    }
-
-    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);
   // 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?
+    $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();
     $objDate->incDay();

-    $dayHeaders['day_header_1'] = $objDate->getDate();
+    $dayHeaders[] = $objDate->getDate(); // After incDay it returns a string with leading 0, when necessary.

     $objDate->incDay();
     $objDate->incDay();

-    $dayHeaders['day_header_2'] = $objDate->getDate();
+    $dayHeaders[] = $objDate->getDate();

     $objDate->incDay();
     $objDate->incDay();

-    $dayHeaders['day_header_3'] = $objDate->getDate();
+    $dayHeaders[] = $objDate->getDate();

     $objDate->incDay();
     $objDate->incDay();

-    $dayHeaders['day_header_4'] = $objDate->getDate();
+    $dayHeaders[] = $objDate->getDate();

     $objDate->incDay();
     $objDate->incDay();

-    $dayHeaders['day_header_5'] = $objDate->getDate();
+    $dayHeaders[] = $objDate->getDate();

     $objDate->incDay();
     $objDate->incDay();

-    $dayHeaders['day_header_6'] = $objDate->getDate();
+    $dayHeaders[] = $objDate->getDate();

     unset($objDate);
     return $dayHeaders;
   }
     unset($objDate);
     return $dayHeaders;
   }