Improved a comment.
[timetracker.git] / WEB-INF / lib / ttTimeHelper.class.php
index da76882..9d3f8bb 100644 (file)
@@ -103,7 +103,7 @@ class ttTimeHelper {
   }
 
   // normalizeDuration - converts a valid time duration string to format 00:00.
-  static function normalizeDuration($value) {
+  static function normalizeDuration($value, $leadingZero = true) {
     $time_value = $value;
 
     // If we have a decimal format - convert to time format 00:00.
@@ -116,7 +116,7 @@ class ttTimeHelper {
       $mins = round($val * 60);
       $hours = (string)((int)($mins / 60));
       $mins = (string)($mins % 60);
-      if (strlen($hours) == 1)
+      if ($leadingZero && strlen($hours) == 1)
         $hours = '0'.$hours;
       if (strlen($mins) == 1)
         $mins = '0' . $mins;
@@ -129,7 +129,7 @@ class ttTimeHelper {
     // 0-99
     if ((strlen($time_value) >= 1) && (strlen($time_value) <= 2) && !isset($time_a[1])) {
       $hours = $time_a[0];
-      if (strlen($hours) == 1)
+      if ($leadingZero && strlen($hours) == 1)
         $hours = '0'.$hours;
        return $hours.':00';
     }
@@ -138,7 +138,7 @@ class ttTimeHelper {
     if ((strlen($time_value) >= 3) && (strlen($time_value) <= 4) && !isset($time_a[1])) {
       if (strlen($time_value)==3) $time_value = '0'.$time_value;
       $hours = substr($time_value,0,2);
-      if (strlen($hours) == 1)
+      if ($leadingZero && strlen($hours) == 1)
         $hours = '0'.$hours;
       return $hours.':'.substr($time_value,2,2);
     }
@@ -146,7 +146,7 @@ class ttTimeHelper {
     // 0:00-23:59 (24:00)
     if ((strlen($time_value) >= 4) && (strlen($time_value) <= 5) && isset($time_a[1])) {
       $hours = $time_a[0];
-      if (strlen($hours) == 1)
+      if ($leadingZero && strlen($hours) == 1)
         $hours = '0'.$hours;
       return $hours.':'.$time_a[1];
     }
@@ -674,269 +674,4 @@ class ttTimeHelper {
 
     return $result;
   }
-
-  // getRecordsForInterval - returns time records for a user for a given interval of dates.
-  static function getRecordsForInterval($user_id, $start_date, $end_date) {
-    global $user;
-    $sql_time_format = "'%k:%i'"; //  24 hour format.
-    if ('%I:%M %p' == $user->time_format)
-      $sql_time_format = "'%h:%i %p'"; // 12 hour format for MySQL TIME_FORMAT function.
-
-    $result = array();
-    $mdb2 = getConnection();
-
-    $client_field = null;
-    if ($user->isPluginEnabled('cl'))
-      $client_field = ', c.id as client_id, c.name as client';
-
-    $custom_field_1 = null;
-    if ($user->isPluginEnabled('cf')) {
-      $custom_fields = new CustomFields($user->team_id);
-      $cf_1_type = $custom_fields->fields[0]['type'];
-      if ($cf_1_type == CustomFields::TYPE_TEXT) {
-        $custom_field_1 = ', cfl.value as cf_1_value';
-      } elseif ($cf_1_type == CustomFields::TYPE_DROPDOWN) {
-        $custom_field_1 = ', cfo.id as cf_1_id, cfo.value as cf_1_value';
-      }
-    }
-
-    $left_joins = " left join tt_projects p on (l.project_id = p.id)".
-      " left join tt_tasks t on (l.task_id = t.id)";
-    if ($user->isPluginEnabled('cl'))
-      $left_joins .= " left join tt_clients c on (l.client_id = c.id)";
-    if ($user->isPluginEnabled('cf')) {
-      if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT)
-        $left_joins .= 'left join tt_custom_field_log cfl on (l.id = cfl.log_id and cfl.status = 1) left join tt_custom_field_options cfo on (cfl.value = cfo.id) ';
-      elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN)
-        $left_joins .= 'left join tt_custom_field_log cfl on (l.id = cfl.log_id and cfl.status = 1) left join tt_custom_field_options cfo on (cfl.option_id = cfo.id) ';
-    }
-
-    $sql = "select l.id as id, l.date as date, 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.id as project_id, p.name as project,
-      t.id as task_id, t.name as task, l.comment, l.billable, l.invoice_id $client_field $custom_field_1
-      from tt_log l
-      $left_joins
-      where l.date >= '$start_date' and l.date <= '$end_date' and l.user_id = $user_id and l.status = 1
-      order by p.name, t.name, l.date, l.start, l.id";
-    $res = $mdb2->query($sql);
-    if (!is_a($res, 'PEAR_Error')) {
-      while ($val = $res->fetchRow()) {
-        if($val['duration']=='0:00')
-          $val['finish'] = '';
-        $result[] = $val;
-      }
-    } else return false;
-
-    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.
-  // 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.
-  //
-  // "cl:546,bl:1,pr:23456,ts:27464,cf_1:example text"
-  // The above means client 546, billable, project 23456, task 27464, custom field text "example text".
-  //
-  // "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) {
-    // 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"
-  // "cl:546,bl:1,pr:23456,ts:27464,cf_1:7623"
-  // See comment for getGroupedRecordsForInterval.
-  static function makeRecordIdentifier($record) {
-    global $user;
-    // Start with client.
-    if ($user->isPluginEnabled('cl'))
-      $record_identifier = $record['client_id'] ? 'cl'.$record['client_id'] : '';
-    // Add billable flag.
-    if (!empty($record_identifier)) $record_identifier .= ',';
-    $record_identifier .= 'bl:'.$record['billable'];
-    // Add project.
-    $record_identifier .= $record['project_id'] ? ',pr:'.$record['project_id'] : '';
-    // Add task.
-    $record_identifier .= $record['task_id'] ? ',ts:'.$record['task_id'] : '';
-    // Add custom field 1. This requires modifying the query to get the data we need.
-    if ($user->isPluginEnabled('cf')) {
-      if ($record['cf_1_id'])
-        $record_identifier .= ',cf_1:'.$record['cf_1_id'];
-      else if ($record['cf_1_value'])
-        $record_identifier .= ',cf_1:'.$record['cf_1_value'];
-    }
-
-    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();
-    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);
-    $dayHeaders['day_header_0'] = (string) $objDate->getDate();      // It returns an int on first call.
-    if (strlen($dayHeaders['day_header_0']) == 1)                    // Which is an implementation detail of DateAndTime class.
-      $dayHeaders['day_header_0'] = '0'.$dayHeaders['day_header_0']; // Add a 0 for single digit day.
-    $objDate->incDay();
-    $dayHeaders['day_header_1'] = $objDate->getDate(); // After incDay it returns a string with leading 0, when necessary.
-    $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;
-  }
 }
-