Refactoring ttReportHelper for timesheets.
[timetracker.git] / WEB-INF / lib / ttReportHelper.class.php
index d3c7b7c..1b5fc6f 100644 (file)
@@ -150,9 +150,10 @@ class ttReportHelper {
 
     // Prepare a query for time items in tt_log table.
     $fields = array(); // An array of fields for database query.
-    array_push($fields, 'l.id as id');
+    array_push($fields, 'l.id');
+    array_push($fields, 'l.user_id');
     array_push($fields, '1 as type'); // Type 1 is for tt_log entries.
-    array_push($fields, 'l.date as date');
+    array_push($fields, 'l.date');
     if($canViewReports || $isClient)
       array_push($fields, 'u.name as user');
     // Add client name if it is selected.
@@ -190,8 +191,11 @@ class ttReportHelper {
     if ($options['show_work_units']) {
       if ($user->getConfigOption('unit_totals_only'))
         array_push($fields, "null as units");
-      else
-        array_push($fields, "if(l.billable = 0 or time_to_sec(l.duration)/60 < $user->first_unit_threshold, 0, ceil(time_to_sec(l.duration)/60/$user->minutes_in_unit)) as units");
+      else {
+        $firstUnitThreshold = $user->getConfigInt('1st_unit_threshold', 0);
+        $minutesInUnit = $user->getConfigInt('minutes_in_unit', 15);
+        array_push($fields, "if(l.billable = 0 or time_to_sec(l.duration)/60 < $firstUnitThreshold, 0, ceil(time_to_sec(l.duration)/60/$minutesInUnit)) as units");
+      }
     }
     // Add note.
     if ($options['show_note'])
@@ -207,13 +211,13 @@ class ttReportHelper {
     }
     // Add paid status.
     if ($canViewReports && $options['show_paid'])
-      array_push($fields, 'l.paid as paid');
+      array_push($fields, 'l.paid');
     // Add IP address.
     if ($canViewReports && $options['show_ip']) {
-      array_push($fields, 'l.created as created');
-      array_push($fields, 'l.created_ip as created_ip');
-      array_push($fields, 'l.modified as modified');
-      array_push($fields, 'l.modified_ip as modified_ip');
+      array_push($fields, 'l.created');
+      array_push($fields, 'l.created_ip');
+      array_push($fields, 'l.modified');
+      array_push($fields, 'l.modified_ip');
     }
     // Add invoice name if it is selected.
     if (($canViewReports || $isClient) && $options['show_invoice'])
@@ -254,6 +258,7 @@ class ttReportHelper {
 
       $fields = array(); // An array of fields for database query.
       array_push($fields, 'ei.id');
+      array_push($fields, 'ei.user_id');
       array_push($fields, '2 as type'); // Type 2 is for tt_expense_items entries.
       array_push($fields, 'ei.date');
       if($canViewReports || $isClient)
@@ -285,13 +290,13 @@ class ttReportHelper {
       array_push($fields, 'ei.cost as expense');
       // Add paid status.
       if ($canViewReports && $options['show_paid'])
-        array_push($fields, 'ei.paid as paid');
+        array_push($fields, 'ei.paid');
       // Add IP address.
       if ($canViewReports && $options['show_ip']) {
-        array_push($fields, 'ei.created as created');
-        array_push($fields, 'ei.created_ip as created_ip');
-        array_push($fields, 'ei.modified as modified');
-        array_push($fields, 'ei.modified_ip as modified_ip');
+        array_push($fields, 'ei.created');
+        array_push($fields, 'ei.created_ip');
+        array_push($fields, 'ei.modified');
+        array_push($fields, 'ei.modified_ip');
       }
       // Add invoice name if it is selected.
       if (($canViewReports || $isClient) && $options['show_invoice'])
@@ -404,53 +409,17 @@ class ttReportHelper {
   // With expenses, it becomes a select with group by from a combined set of records obtained with "union all".
   static function getSubtotals($options) {
     global $user;
-
     $mdb2 = getConnection();
 
     $concat_part = ttReportHelper::makeConcatPart($options);
+    $work_unit_part = ttReportHelper::makeWorkUnitPart($options);
     $join_part = ttReportHelper::makeJoinPart($options);
+    $cost_part = ttReportHelper::makeCostPart($options);
     $where = ttReportHelper::getWhere($options);
     $group_by_part = ttReportHelper::makeGroupByPart($options);
-    if ($options['show_cost']) {
-      if (MODE_TIME == $user->tracking_mode) {
-        if (!ttReportHelper::groupingBy('user', $options))
-          $left_join = 'left join tt_users u on (l.user_id = u.id)';
-        $sql = "select $concat_part, sum(time_to_sec(l.duration)) as time";
-        if ($options['show_work_units']) {
-          if ($user->unit_totals_only)
-            $sql .= ", if (sum(l.billable * time_to_sec(l.duration)/60) < $user->first_unit_threshold, 0, ceil(sum(l.billable * time_to_sec(l.duration)/60/$user->minutes_in_unit))) as units";
-          else
-            $sql .= ", sum(if(l.billable = 0 or time_to_sec(l.duration)/60 < $user->first_unit_threshold, 0, ceil(time_to_sec(l.duration)/60/$user->minutes_in_unit))) as units";
-        }
-        $sql .= ", sum(cast(l.billable * coalesce(u.rate, 0) * time_to_sec(l.duration)/3600 as decimal(10, 2))) as cost,
-          null as expenses from tt_log l
-          $join_part $left_join $where $group_by_part";
-      } else {
-        // If we are including cost and tracking projects, our query (the same as above) needs to join the tt_user_project_binds table.
-        $sql = "select $concat_part, sum(time_to_sec(l.duration)) as time";
-        if ($options['show_work_units']) {
-          if ($user->unit_totals_only)
-            $sql .= ", if (sum(l.billable * time_to_sec(l.duration)/60) < $user->first_unit_threshold, 0, ceil(sum(l.billable * time_to_sec(l.duration)/60/$user->minutes_in_unit))) as units";
-          else
-            $sql .= ", sum(if(l.billable = 0 or time_to_sec(l.duration)/60 < $user->first_unit_threshold, 0, ceil(time_to_sec(l.duration)/60/$user->minutes_in_unit))) as units";
-        }
-        $sql .= ", sum(cast(l.billable * coalesce(upb.rate, 0) * time_to_sec(l.duration)/3600 as decimal(10,2))) as cost,
-          null as expenses from tt_log l 
-          $join_part
-          left join tt_user_project_binds upb on (l.user_id = upb.user_id and l.project_id = upb.project_id) $where $group_by_part";
-      }
-    }  else {
-      // $sql = "select $group_field as group_field, sum(time_to_sec(l.duration)) as time";
-      $sql = "select $concat_part, sum(time_to_sec(l.duration)) as time";
-      if ($options['show_work_units']) {
-        if ($user->unit_totals_only)
-          $sql .= ", if (sum(l.billable * time_to_sec(l.duration)/60) < $user->first_unit_threshold, 0, ceil(sum(l.billable * time_to_sec(l.duration)/60/$user->minutes_in_unit))) as units";
-        else
-          $sql .= ", sum(if(l.billable = 0 or time_to_sec(l.duration)/60 < $user->first_unit_threshold, 0, ceil(time_to_sec(l.duration)/60/$user->minutes_in_unit))) as units";
-      }
-      $sql .= ", null as expenses from tt_log l 
-        $join_part $where $group_by_part";
-    }
+
+    $parts = "$concat_part, sum(time_to_sec(l.duration)) as time, null as expenses".$work_unit_part.$cost_part;
+    $sql = "select $parts from tt_log l $join_part $where $group_by_part";
     // By now we have sql for time items.
 
     // However, when we have expenses, we need to do a union with a separate query for expense items from tt_expense_items table.
@@ -479,9 +448,10 @@ class ttReportHelper {
       $time = $val['time'] ? sec_to_time_fmt_hm($val['time']) : null;
       $rowLabel = ttReportHelper::makeGroupByLabel($val['group_field'], $options);
       if ($options['show_cost']) {
-        if ('.' != $user->decimal_mark) {
-          $val['cost'] = str_replace('.', $user->decimal_mark, $val['cost']);
-          $val['expenses'] = str_replace('.', $user->decimal_mark, $val['expenses']);
+        $decimalMark = $user->getDecimalMark();
+        if ('.' != $decimalMark) {
+          $val['cost'] = str_replace('.', $decimalMark, $val['cost']);
+          $val['expenses'] = str_replace('.', $decimalMark, $val['expenses']);
         }
         $subtotals[$val['group_field']] = array('name'=>$rowLabel,'user'=>$val['user'],'project'=>$val['project'],'task'=>$val['task'],'client'=>$val['client'],'cf_1'=>$val['cf_1'],'time'=>$time,'units'=> $val['units'],'cost'=>$val['cost'],'expenses'=>$val['expenses']);
       } else
@@ -495,18 +465,22 @@ class ttReportHelper {
   static function getTotals($options)
   {
     global $user;
-
     $mdb2 = getConnection();
 
+    $trackingMode = $user->getTrackingMode();
+    $decimalMark = $user->getDecimalMark();
     $where = ttReportHelper::getWhere($options);
 
     // Prepare parts.
     $time_part = "sum(time_to_sec(l.duration)) as time";
     if ($options['show_work_units']) {
-      $units_part = $user->unit_totals_only ? ", null as units" : ", sum(if(l.billable = 0 or time_to_sec(l.duration)/60 < $user->first_unit_threshold, 0, ceil(time_to_sec(l.duration)/60/$user->minutes_in_unit))) as units";
+      $unitTotalsOnly = $user->getConfigOption('unit_totals_only');
+      $firstUnitThreshold = $user->getConfigInt('1st_unit_threshold', 0);
+      $minutesInUnit = $user->getConfigInt('minutes_in_unit', 15);
+      $units_part = $unitTotalsOnly ? ", null as units" : ", sum(if(l.billable = 0 or time_to_sec(l.duration)/60 < $firstUnitThreshold, 0, ceil(time_to_sec(l.duration)/60/$minutesInUnit))) as units";
     }
     if ($options['show_cost']) {
-      if (MODE_TIME == $user->tracking_mode)
+      if (MODE_TIME == $trackingMode)
         $cost_part = ", sum(cast(l.billable * coalesce(u.rate, 0) * time_to_sec(l.duration)/3600 as decimal(10,2))) as cost, null as expenses";
       else
         $cost_part = ", sum(cast(l.billable * coalesce(upb.rate, 0) * time_to_sec(l.duration)/3600 as decimal(10,2))) as cost, null as expenses";
@@ -514,7 +488,7 @@ class ttReportHelper {
       $cost_part = ", null as cost, null as expenses";
     }
     if ($options['show_cost']) {
-      if (MODE_TIME == $user->tracking_mode) {
+      if (MODE_TIME == $trackingMode) {
         $left_joins = "left join tt_users u on (l.user_id = u.id)";
       } else {
         $left_joins = "left join tt_user_project_binds upb on (l.user_id = upb.user_id and l.project_id = upb.project_id)";
@@ -546,21 +520,22 @@ class ttReportHelper {
     if ($options['show_cost']) {
       $total_cost = $val['cost'];
       if (!$total_cost) $total_cost = '0.00';
-      if ('.' != $user->decimal_mark)
-        $total_cost = str_replace('.', $user->decimal_mark, $total_cost);
+      if ('.' != $decimalMark)
+        $total_cost = str_replace('.', $decimalMark, $total_cost);
       $total_expenses = $val['expenses'];
       if (!$total_expenses) $total_expenses = '0.00';
-      if ('.' != $user->decimal_mark)
-        $total_expenses = str_replace('.', $user->decimal_mark, $total_expenses);
+      if ('.' != $decimalMark)
+        $total_expenses = str_replace('.', $decimalMark, $total_expenses);
     }
 
+    $dateFormat = $user->getDateFormat();
     if ($options['period'])
-      $period = new Period($options['period'], new DateAndTime($user->date_format));
+      $period = new Period($options['period'], new DateAndTime($dateFormat));
     else {
       $period = new Period();
       $period->setPeriod(
-        new DateAndTime($user->date_format, $options['period_start']),
-        new DateAndTime($user->date_format, $options['period_end']));
+        new DateAndTime($dateFormat, $options['period_start']),
+        new DateAndTime($dateFormat, $options['period_end']));
     }
 
     $totals['start_date'] = $period->getStartDate();
@@ -1467,7 +1442,8 @@ class ttReportHelper {
   static function makeJoinPart($options) {
     global $user;
 
-    if (ttReportHelper::groupingBy('user', $options)) {
+    $trackingMode = $user->getTrackingMode();
+    if (ttReportHelper::groupingBy('user', $options) || MODE_TIME == $trackingMode) {
       $join .= ' left join tt_users u on (l.user_id = u.id)';
     }
     if (ttReportHelper::groupingBy('client', $options)) {
@@ -1486,9 +1462,42 @@ class ttReportHelper {
       elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN)
         $join .= ' 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)';
     }
+    if ($options['show_cost'] && $trackingMode != MODE_TIME) {
+      $join .= ' left join tt_user_project_binds upb on (l.user_id = upb.user_id and l.project_id = upb.project_id)';
+    }
     return $join;
   }
 
+  // makeWorkUnitPart builds an sql part for work units for time items.
+  static function makeWorkUnitPart($options) {
+    global $user;
+
+    $workUnits = $options['show_work_units'];
+    if ($workUnits) {
+      $unitTotalsOnly = $user->getConfigOption('unit_totals_only');
+      $firstUnitThreshold = $user->getConfigInt('1st_unit_threshold', 0);
+      $minutesInUnit = $user->getConfigInt('minutes_in_unit', 15);
+      if ($unitTotalsOnly)
+        $work_unit_part = ", if (sum(l.billable * time_to_sec(l.duration)/60) < $firstUnitThreshold, 0, ceil(sum(l.billable * time_to_sec(l.duration)/60/$minutesInUnit))) as units";
+      else
+        $work_unit_part = ", sum(if(l.billable = 0 or time_to_sec(l.duration)/60 < $firstUnitThreshold, 0, ceil(time_to_sec(l.duration)/60/$minutesInUnit))) as units";
+    }
+    return $work_unit_part;
+  }
+
+  // makeCostPart builds a cost part for time items.
+  static function makeCostPart($options) {
+    global $user;
+
+    if ($options['show_cost']) {
+      if (MODE_TIME == $user->getTrackingMode())
+        $cost_part = ", sum(cast(l.billable * coalesce(u.rate, 0) * time_to_sec(l.duration)/3600 as decimal(10, 2))) as cost";
+      else
+        $cost_part .= ", sum(cast(l.billable * coalesce(upb.rate, 0) * time_to_sec(l.duration)/3600 as decimal(10,2))) as cost";
+    }
+    return $cost_part;
+  }
+
   // makeJoinExpensesPart builds a left join part for getSubtotals query for expense items.
   static function makeJoinExpensesPart($options) {
     if (ttReportHelper::groupingBy('user', $options)) {
@@ -1591,7 +1600,7 @@ class ttReportHelper {
       return $key; // No need to format.
 
     global $user;
-    if ($user->date_format == DB_DATEFORMAT)
+    if ($user->getDateFormat() == DB_DATEFORMAT)
       return $key; // No need to format.
 
     $label = $key;