X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=WEB-INF%2Flib%2FttReportHelper.class.php;h=3a6a09608fff703388429fa063ffcc6e8c1f4fe1;hb=a48e5ff4ad629b551f6a94143a5e9d0f235b1953;hp=3940a51b73bf497d597ef56f08f9e9a77028e653;hpb=7562c5b6d68929eb4787749f8c10dc032ee9a1c7;p=timetracker.git diff --git a/WEB-INF/lib/ttReportHelper.class.php b/WEB-INF/lib/ttReportHelper.class.php index 3940a51b..3a6a0960 100644 --- a/WEB-INF/lib/ttReportHelper.class.php +++ b/WEB-INF/lib/ttReportHelper.class.php @@ -127,9 +127,7 @@ class ttReportHelper { $canViewReports = $user->can('view_reports') || $user->can('view_all_reports'); $isClient = $user->isClient(); - $no_grouping = ($options['group_by1'] == null || $options['group_by1'] == 'no_grouping') && - ($options['group_by2'] == null || $options['group_by2'] == 'no_grouping') && - ($options['group_by3'] == null || $options['group_by3'] == 'no_grouping'); + $grouping = ttReportHelper::grouping($options); $grouping_by_date = ($options['group_by1'] == 'date'|| $options['group_by2'] == 'date' || $options['group_by3'] == 'date'); $grouping_by_client = ($options['group_by1'] == 'client'|| $options['group_by2'] == 'client' || $options['group_by3'] == 'client'); $grouping_by_project = ($options['group_by1'] == 'project'|| $options['group_by2'] == 'project' || $options['group_by3'] == 'project'); @@ -311,14 +309,14 @@ class ttReportHelper { // Determine sort part. $sort_part = ' order by '; - if ($no_grouping) - $sort_part .= 'date'; - else { + if ($grouping) { $sort_part2 .= ($options['group_by1'] != null && $options['group_by1'] != 'no_grouping') ? ', '.$options['group_by1'] : ''; $sort_part2 .= ($options['group_by2'] != null && $options['group_by2'] != 'no_grouping') ? ', '.$options['group_by2'] : ''; $sort_part2 .= ($options['group_by3'] != null && $options['group_by3'] != 'no_grouping') ? ', '.$options['group_by3'] : ''; if (!$grouping_by_date) $sort_part2 .= ', date'; $sort_part .= ltrim($sort_part2, ', '); // Remove leading comma and space. + } else { + $sort_part .= 'date'; } if (($canViewReports || $isClient) && $options['users'] && !$grouping_by_user) $sort_part .= ', user, type'; @@ -349,7 +347,7 @@ class ttReportHelper { $val['expense'] = str_replace('.', $user->decimal_mark, $val['expense']); } - if (!$no_grouping) $val['grouped_by'] = ttReportHelper::makeGroupByKey($options, $val); + if ($grouping) $val['grouped_by'] = ttReportHelper::makeGroupByKey($options, $val); $val['date'] = ttDateToUserFormat($val['date']); $report_items[] = $val; @@ -397,9 +395,6 @@ class ttReportHelper { static function getSubtotals($options) { global $user; - $group_fields = ttReportHelper::makeGroupByFieldsPart($options); - if (!$group_fields) return null; - $mdb2 = getConnection(); $concat_part = ttReportHelper::makeConcatPart($options); @@ -454,15 +449,16 @@ class ttReportHelper { $concat_part = ttReportHelper::makeConcatExpensesPart($options); $join_part = ttReportHelper::makeJoinExpensesPart($options); $where = ttReportHelper::getExpenseWhere($options); - $group_by_part = ttReportHelper::makeGroupByExpensesPart($options); + $group_by_expenses_part = ttReportHelper::makeGroupByExpensesPart($options); $sql_for_expenses = "select $concat_part, null as time"; if ($options['show_work_units']) $sql_for_expenses .= ", null as units"; - $sql_for_expenses .= ", sum(ei.cost) as cost, sum(ei.cost) as expenses from tt_expense_items ei $join_part $where $group_by_part"; + $sql_for_expenses .= ", sum(ei.cost) as cost, sum(ei.cost) as expenses from tt_expense_items ei $join_part $where $group_by_expenses_part"; // Create a combined query. - $combined = "select group_field, sum(time) as time"; + $fields = ttReportHelper::makeCombinedSelectPart($options); + $combined = "select $fields, sum(time) as time"; if ($options['show_work_units']) $combined .= ", sum(units) as units"; - $combined .= ", sum(cost) as cost, sum(expenses) as expenses from (($sql) union all ($sql_for_expenses)) t group by group_field"; + $combined .= ", sum(cost) as cost, sum(expenses) as expenses from (($sql) union all ($sql_for_expenses)) t group by $fields"; $sql = $combined; } @@ -470,20 +466,16 @@ class ttReportHelper { $res = $mdb2->query($sql); if (is_a($res, 'PEAR_Error')) die($res->getMessage()); while ($val = $res->fetchRow()) { -// TODO: consider writing a function that properly formats a date part in a multi-part key. -// -// if ('date' == $group_by_option) { -// $val['group_field'] = ttDateToUserFormat($val['group_field']); -// } $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']); } - $subtotals[$val['group_field']] = array('name'=>$val['group_field'],'time'=>$time, 'units'=> $val['units'], 'cost'=>$val['cost'],'expenses'=>$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 - $subtotals[$val['group_field']] = array('name'=>$val['group_field'],'time'=>$time, 'units'=> $val['units']); + $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']); } return $subtotals; @@ -617,8 +609,8 @@ class ttReportHelper { $isClient = $user->isClient(); $items = ttReportHelper::getItems($options); - $group_by = $options['group_by1']; - if ($group_by && 'no_grouping' != $group_by) + $grouping = ttReportHelper::grouping($options); + if ($grouping) $subtotals = ttReportHelper::getSubtotals($options); $totals = ttReportHelper::getTotals($options); @@ -651,14 +643,7 @@ class ttReportHelper { if ($options['show_totals_only']) { // Totals only report. Output subtotals. - - // Determine group_by header. - if ('cf_1' == $group_by) - $group_by_header = htmlspecialchars($custom_fields->fields[0]['label']); - else { - $key = 'label.'.$group_by; - $group_by_header = $i18n->get($key); - } + $group_by_header = ttReportHelper::makeGroupByHeader($options); $body .= ''; $body .= ''; @@ -751,7 +736,7 @@ class ttReportHelper { $body .= ''; // Initialize variables to print subtotals. - if ($items && 'no_grouping' != $group_by) { + if ($items && $grouping) { $print_subtotals = true; $first_pass = true; $prev_grouped_by = ''; @@ -773,11 +758,11 @@ class ttReportHelper { $body .= ''; $body .= ''; $subtotal_name = htmlspecialchars($subtotals[$prev_grouped_by]['name']); - if ($canViewReports || $isClient) $body .= ''; - if ($options['show_client']) $body .= ''; - if ($options['show_project']) $body .= ''; - if ($options['show_task']) $body .= ''; - if ($options['show_custom_field_1']) $body .= ''; + if ($canViewReports || $isClient) $body .= ''; + if ($options['show_client']) $body .= ''; + if ($options['show_project']) $body .= ''; + if ($options['show_task']) $body .= ''; + if ($options['show_custom_field_1']) $body .= ''; if ($options['show_start']) $body .= ''; if ($options['show_end']) $body .= ''; if ($options['show_duration']) $body .= ''; @@ -849,11 +834,11 @@ class ttReportHelper { $body .= ''; $body .= ''; $subtotal_name = htmlspecialchars($subtotals[$cur_grouped_by]['name']); - if ($canViewReports || $isClient) $body .= ''; - if ($options['show_client']) $body .= ''; - if ($options['show_project']) $body .= ''; - if ($options['show_task']) $body .= ''; - if ($options['show_custom_field_1']) $body .= ''; + if ($canViewReports || $isClient) $body .= ''; + if ($options['show_client']) $body .= ''; + if ($options['show_project']) $body .= ''; + if ($options['show_task']) $body .= ''; + if ($options['show_custom_field_1']) $body .= ''; if ($options['show_start']) $body .= ''; if ($options['show_end']) $body .= ''; if ($options['show_duration']) $body .= ''; @@ -1074,10 +1059,7 @@ class ttReportHelper { // makeGroupByPart builds a combined group by part for sql query for time items using group_by1, // group_by2, and group_by3 values passed in $options. static function makeGroupByPart($options) { - $no_grouping = ($options['group_by1'] == null || $options['group_by1'] == 'no_grouping') && - ($options['group_by2'] == null || $options['group_by2'] == 'no_grouping') && - ($options['group_by3'] == null || $options['group_by3'] == 'no_grouping'); - if ($no_grouping) return null; + if (!ttReportHelper::grouping($options)) return null; $group_by1 = $options['group_by1']; $group_by2 = $options['group_by2']; @@ -1205,7 +1187,8 @@ class ttReportHelper { } // Remove garbage from the beginning. $group_by_parts = ltrim($group_by_parts, ', '); - $group_by_part = "group by $group_by_parts"; + if ($group_by_parts) + $group_by_part = "group by $group_by_parts"; return $group_by_part; } @@ -1221,18 +1204,23 @@ class ttReportHelper { break; case 'user': $what_to_concat .= ", ' - ', u.name"; + $fields_part .= ', u.name as user'; break; case 'client': $what_to_concat .= ", ' - ', coalesce(c.name, 'Null')"; + $fields_part .= ', c.name as client'; break; case 'project': $what_to_concat .= ", ' - ', coalesce(p.name, 'Null')"; + $fields_part .= ', p.name as project'; break; case 'task': $what_to_concat .= ", ' - ', coalesce(t.name, 'Null')"; + $fields_part .= ', t.name as task'; break; case 'cf_1': $what_to_concat .= ", ' - ', coalesce(cfo.value, 'Null')"; + $fields_part .= ', cfo.value as cf_1'; break; } switch ($group_by2) { @@ -1241,18 +1229,23 @@ class ttReportHelper { break; case 'user': $what_to_concat .= ", ' - ', u.name"; + $fields_part .= ', u.name as user'; break; case 'client': $what_to_concat .= ", ' - ', coalesce(c.name, 'Null')"; + $fields_part .= ', c.name as client'; break; case 'project': $what_to_concat .= ", ' - ', coalesce(p.name, 'Null')"; + $fields_part .= ', p.name as project'; break; case 'task': $what_to_concat .= ", ' - ', coalesce(t.name, 'Null')"; + $fields_part .= ', t.name as task'; break; case 'cf_1': $what_to_concat .= ", ' - ', coalesce(cfo.value, 'Null')"; + $fields_part .= ', cfo.value as cf_1'; break; } switch ($group_by3) { @@ -1261,25 +1254,30 @@ class ttReportHelper { break; case 'user': $what_to_concat .= ", ' - ', u.name"; + $fields_part .= ', u.name as user'; break; case 'client': $what_to_concat .= ", ' - ', coalesce(c.name, 'Null')"; + $fields_part .= ', c.name as client'; break; case 'project': $what_to_concat .= ", ' - ', coalesce(p.name, 'Null')"; + $fields_part .= ', p.name as project'; break; case 'task': $what_to_concat .= ", ' - ', coalesce(t.name, 'Null')"; + $fields_part .= ', t.name as task'; break; case 'cf_1': $what_to_concat .= ", ' - ', coalesce(cfo.value, 'Null')"; + $fields_part .= ', cfo.value as cf_1'; break; } // Remove garbage from both ends. $what_to_concat = trim($what_to_concat, "', -"); $concat_part = "concat($what_to_concat) as group_field"; $concat_part = trim($concat_part, ' -'); - return $concat_part; + return "$concat_part $fields_part"; } // makeConcatPart builds a concatenation part for getSubtotals query (for expense items). @@ -1294,12 +1292,25 @@ class ttReportHelper { break; case 'user': $what_to_concat .= ", ' - ', u.name"; + $fields_part .= ', u.name as user'; break; case 'client': $what_to_concat .= ", ' - ', coalesce(c.name, 'Null')"; + $fields_part .= ', c.name as client'; break; case 'project': $what_to_concat .= ", ' - ', coalesce(p.name, 'Null')"; + $fields_part .= ', p.name as project'; + break; + + case 'task': + $what_to_concat .= ", ' - ', 'Null'"; + $fields_part .= ', null as task'; + break; + + case 'cf_1': + $what_to_concat .= ", ' - ', 'Null'"; + $fields_part .= ', null as cf_1'; break; } switch ($group_by2) { @@ -1308,12 +1319,25 @@ class ttReportHelper { break; case 'user': $what_to_concat .= ", ' - ', u.name"; + $fields_part .= ', u.name as user'; break; case 'client': $what_to_concat .= ", ' - ', coalesce(c.name, 'Null')"; + $fields_part .= ', c.name as client'; break; case 'project': $what_to_concat .= ", ' - ', coalesce(p.name, 'Null')"; + $fields_part .= ', p.name as project'; + break; + + case 'task': + $what_to_concat .= ", ' - ', 'Null'"; + $fields_part .= ', null as task'; + break; + + case 'cf_1': + $what_to_concat .= ", ' - ', 'Null'"; + $fields_part .= ', null as cf_1'; break; } switch ($group_by3) { @@ -1322,24 +1346,109 @@ class ttReportHelper { break; case 'user': $what_to_concat .= ", ' - ', u.name"; + $fields_part .= ', u.name as user'; break; case 'client': $what_to_concat .= ", ' - ', coalesce(c.name, 'Null')"; + $fields_part .= ', c.name as client'; break; case 'project': $what_to_concat .= ", ' - ', coalesce(p.name, 'Null')"; + $fields_part .= ', p.name as project'; + break; + + case 'task': + $what_to_concat .= ", ' - ', 'Null'"; + $fields_part .= ', null as task'; + break; + + case 'cf_1': + $what_to_concat .= ", ' - ', 'Null'"; + $fields_part .= ', null as cf_1'; break; } - // Remove garbage from both ends. - $what_to_concat = trim($what_to_concat, "', -"); + // Remove garbage from the beginning. + if ($what_to_concat) + $what_to_concat = substr($what_to_concat, 8); $concat_part = "concat($what_to_concat) as group_field"; - $concat_part = trim($concat_part, ' -'); - return $concat_part; + return "$concat_part $fields_part"; + } + + // makeCombinedSelectPart builds a list of fields for a combined select on a union for getSubtotals. + // This is used when we include expenses. + static function makeCombinedSelectPart($options) { + $group_by1 = $options['group_by1']; + $group_by2 = $options['group_by2']; + $group_by3 = $options['group_by3']; + + $fields = "group_field"; + + switch ($group_by1) { + case 'user': + $fields .= ', user'; + break; + case 'client': + $fields_part .= ', client'; + break; + case 'project': + $fields .= ', project'; + break; + + case 'task': + $fields .= ', task'; + break; + + case 'cf_1': + $fields .= ', cf_1'; + break; + } + switch ($group_by2) { + case 'user': + $fields .= ', user'; + break; + case 'client': + $fields_part .= ', client'; + break; + case 'project': + $fields .= ', project'; + break; + + case 'task': + $fields .= ', task'; + break; + + case 'cf_1': + $fields .= ', cf_1'; + break; + } + switch ($group_by3) { + case 'user': + $fields .= ', user'; + break; + case 'client': + $fields_part .= ', client'; + break; + case 'project': + $fields .= ', project'; + break; + + case 'task': + $fields .= ', task'; + break; + + case 'cf_1': + $fields .= ', cf_1'; + break; + } + return $fields; } // makeJoinPart builds a left join part for getSubtotals query (for time items). static function makeJoinPart($options) { - global $custom_fields; // TODO: is it safe to assume the object is there when needed? + global $user; + if (ttReportHelper::groupingBy('cf_1', $options)) { + $custom_fields = new CustomFields($user->group_id); + } $group_by_fields = ttReportHelper::makeGroupByFieldsPart($options); // TODO: refactor this, perhaps? if (strpos($group_by_fields, 'user') !== false) { @@ -1411,7 +1520,7 @@ class ttReportHelper { return $group_by_fields; } - // grouping determines if we are grooping the project by either group_by1, + // grouping determines if we are grouping the report by either group_by1, // group_by2, or group_by3 values passed in $options. static function grouping($options) { $grouping = ($options['group_by1'] != null && $options['group_by1'] != 'no_grouping') || @@ -1426,6 +1535,16 @@ class ttReportHelper { return false; } + + // groupingBy determines if we are grouping a report by a value of $what + // ('user', 'project', etc.) by checking group_by1, group_by2, and group_by3 + // values passed in $options. + static function groupingBy($what, $options) { + $grouping = ($options['group_by1'] != null && $options['group_by1'] != $what) || + ($options['group_by2'] != null && $options['group_by2'] != $what) || + ($options['group_by3'] != null && $options['group_by3'] != $what); + return $grouping; + } // makeGroupByHeader builds a column header for a totals-only report using group_by1, // group_by2, and group_by3 values passed in $options. @@ -1471,4 +1590,43 @@ class ttReportHelper { $group_by_header = ltrim($group_by_header, ' -'); return $group_by_header; } + + // makeGroupByXmlTag creates an xml tag for a totals only report using group_by1, + // group_by2, and group_by3 values passed in $options. + static function makeGroupByXmlTag($options) { + if ($options['group_by1'] != null && $options['group_by1'] != 'no_grouping') { + // We have group_by1. + $tag .= '_'.$options['group_by1']; + } + if ($options['group_by2'] != null && $options['group_by2'] != 'no_grouping') { + // We have group_by2. + $tag .= '_'.$options['group_by2']; + } + if ($options['group_by3'] != null && $options['group_by3'] != 'no_grouping') { + // We have group_by3. + $tag .= '_'.$options['group_by3']; + } + $tag = ltrim($tag, '_'); + return $tag; + } + + // makeGroupByLabel builds a label for one row in a "Totals only" report of grouped by items. + // It does one thing: if we are grouping by date, the date format is converted for user. + static function makeGroupByLabel($key, $options) { + if (!ttReportHelper::groupingBy('date', $options)) + return $key; // No need to format. + + global $user; + if ($user->date_format == DB_DATEFORMAT) + return $key; // No need to format. + + $label = $key; + if (preg_match('/\d\d\d\d-\d\d-\d\d/', $key, $matches)) { + // Replace the first found match of a date in DB_DATEFORMAT. + // This is not entirely clean but better than nothing for a label in a row. + $userDate = ttDateToUserFormat($matches[0]); + $label = str_replace($matches[0], $userDate, $key); + } + return $label; + } }
'.$i18n->get('label.subtotal').''.($group_by == 'user' ? $subtotal_name : '').''.($group_by == 'client' ? $subtotal_name : '').''.($group_by == 'project' ? $subtotal_name : '').''.($group_by == 'task' ? $subtotal_name : '').''.($group_by == 'cf_1' ? $subtotal_name : '').''.$subtotals[$prev_grouped_by]['user'].''.$subtotals[$prev_grouped_by]['client'].''.$subtotals[$prev_grouped_by]['project'].''.$subtotals[$prev_grouped_by]['task'].''.$subtotals[$prev_grouped_by]['cf_1'].''.$subtotals[$prev_grouped_by]['time'].'
'.$i18n->get('label.subtotal').''.($group_by == 'user' ? $subtotal_name : '').''.($group_by == 'client' ? $subtotal_name : '').''.($group_by == 'project' ? $subtotal_name : '').''.($group_by == 'task' ? $subtotal_name : '').''.($group_by == 'cf_1' ? $subtotal_name : '').''.$subtotals[$prev_grouped_by]['user'].''.$subtotals[$prev_grouped_by]['client'].''.$subtotals[$prev_grouped_by]['project'].''.$subtotals[$prev_grouped_by]['task'].''.$subtotals[$prev_grouped_by]['cf_1'].''.$subtotals[$cur_grouped_by]['time'].'