2 // +----------------------------------------------------------------------+
3 // | Anuko Time Tracker
4 // +----------------------------------------------------------------------+
5 // | Copyright (c) Anuko International Ltd. (https://www.anuko.com)
6 // +----------------------------------------------------------------------+
7 // | LIBERAL FREEWARE LICENSE: This source code document may be used
8 // | by anyone for any purpose, and freely redistributed alone or in
9 // | combination with other software, provided that the license is obeyed.
11 // | There are only two ways to violate the license:
13 // | 1. To redistribute this code in source form, with the copyright
14 // | notice or license removed or altered. (Distributing in compiled
15 // | forms without embedded copyright notices is permitted).
17 // | 2. To redistribute modified versions of this code in *any* form
18 // | that bears insufficient indications that the modifications are
19 // | not the work of the original author(s).
21 // | This license applies to this document only, not any other software
22 // | that it may be combined with.
24 // +----------------------------------------------------------------------+
26 // | https://www.anuko.com/time_tracker/credits.htm
27 // +----------------------------------------------------------------------+
29 import('ttClientHelper');
30 import('DateAndTime');
32 import('ttTimeHelper');
34 require_once(dirname(__FILE__).'/../../plugins/CustomFields.class.php');
36 // Definitions of types for timesheet dropdown.
37 define('TIMESHEET_ALL', 0); // Include all records.
38 define('TIMESHEET_NOT_ASSIGNED', 1); // Include records not assigned to timesheets.
39 define('TIMESHEET_ASSIGNED', 2); // Include records assigned to timesheets.
40 define('TIMESHEET_PENDING', 3); // Include records in submitted timesheets that are pending manager approval.
41 define('TIMESHEET_APPROVED', 4); // Include records in approved timesheets.
42 define('TIMESHEET_NOT_APPROVED', 5); // Include records in disapproved timesheets.
44 // Class ttReportHelper is used for help with reports.
45 class ttReportHelper {
47 // getWhere prepares a WHERE clause for a report query.
48 static function getWhere($options) {
51 $group_id = $user->getGroup();
52 $org_id = $user->org_id;
54 // A shortcut for timesheets.
55 if ($options['timesheet_id']) {
56 $where = " where l.timesheet_id = ".$options['timesheet_id']." and l.group_id = $group_id and l.org_id = $org_id";
60 // Prepare dropdown parts.
62 if ($options['client_id'])
63 $dropdown_parts .= ' and l.client_id = '.$options['client_id'];
64 elseif ($user->isClient() && $user->client_id)
65 $dropdown_parts .= ' and l.client_id = '.$user->client_id;
66 if ($options['cf_1_option_id']) $dropdown_parts .= ' and l.id in(select log_id from tt_custom_field_log where status = 1 and option_id = '.$options['cf_1_option_id'].')';
67 if ($options['project_id']) $dropdown_parts .= ' and l.project_id = '.$options['project_id'];
68 if ($options['task_id']) $dropdown_parts .= ' and l.task_id = '.$options['task_id'];
69 if ($options['billable']=='1') $dropdown_parts .= ' and l.billable = 1';
70 if ($options['billable']=='2') $dropdown_parts .= ' and l.billable = 0';
71 if ($options['invoice']=='1') $dropdown_parts .= ' and l.invoice_id is not null';
72 if ($options['invoice']=='2') $dropdown_parts .= ' and l.invoice_id is null';
73 if ($options['timesheet']==TIMESHEET_NOT_ASSIGNED) $dropdown_parts .= ' and l.timesheet_id is null';
74 if ($options['timesheet']==TIMESHEET_ASSIGNED) $dropdown_parts .= ' and l.timesheet_id is not null';
75 if ($options['approved']=='1') $dropdown_parts .= ' and l.approved = 1';
76 if ($options['approved']=='2') $dropdown_parts .= ' and l.approved = 0';
77 if ($options['paid_status']=='1') $dropdown_parts .= ' and l.paid = 1';
78 if ($options['paid_status']=='2') $dropdown_parts .= ' and l.paid = 0';
80 // Prepare sql query part for user list.
81 $userlist = $options['users'] ? $options['users'] : '-1';
82 if ($user->can('view_reports') || $user->can('view_all_reports') || $user->isClient())
83 $user_list_part = " and l.user_id in ($userlist)";
85 $user_list_part = " and l.user_id = ".$user->getUser();
86 $user_list_part .= " and l.group_id = $group_id and l.org_id = $org_id";
88 // Prepare sql query part for where.
89 $dateFormat = $user->getDateFormat();
90 if ($options['period'])
91 $period = new Period($options['period'], new DateAndTime($dateFormat));
93 $period = new Period();
95 new DateAndTime($dateFormat, $options['period_start']),
96 new DateAndTime($dateFormat, $options['period_end']));
98 $where = " where l.status = 1 and l.date >= '".$period->getStartDate(DB_DATEFORMAT)."' and l.date <= '".$period->getEndDate(DB_DATEFORMAT)."'".
99 " $user_list_part $dropdown_parts";
103 // getExpenseWhere prepares WHERE clause for expenses query in a report.
104 static function getExpenseWhere($options) {
107 $group_id = $user->getGroup();
108 $org_id = $user->org_id;
110 // Prepare dropdown parts.
111 $dropdown_parts = '';
112 if ($options['client_id'])
113 $dropdown_parts .= ' and ei.client_id = '.$options['client_id'];
114 elseif ($user->isClient() && $user->client_id)
115 $dropdown_parts .= ' and ei.client_id = '.$user->client_id;
116 if ($options['project_id']) $dropdown_parts .= ' and ei.project_id = '.$options['project_id'];
117 if ($options['invoice']=='1') $dropdown_parts .= ' and ei.invoice_id is not null';
118 if ($options['invoice']=='2') $dropdown_parts .= ' and ei.invoice_id is null';
119 if (isset($options['timesheet']) && ($options['timesheet']!=TIMESHEET_ALL && $options['timesheet']!=TIMESHEET_NOT_ASSIGNED)) {
120 $dropdown_parts .= ' and 0 = 1'; // Expense items do not have a timesheet_id.
122 if ($options['approved']=='1') $dropdown_parts .= ' and ei.approved = 1';
123 if ($options['approved']=='2') $dropdown_parts .= ' and ei.approved = 0';
124 if ($options['paid_status']=='1') $dropdown_parts .= ' and ei.paid = 1';
125 if ($options['paid_status']=='2') $dropdown_parts .= ' and ei.paid = 0';
127 // Prepare sql query part for user list.
128 $userlist = $options['users'] ? $options['users'] : '-1';
129 if ($user->can('view_reports') || $user->can('view_all_reports') || $user->isClient())
130 $user_list_part = " and ei.user_id in ($userlist)";
132 $user_list_part = " and ei.user_id = ".$user->getUser();
133 $user_list_part .= " and ei.group_id = $group_id and ei.org_id = $org_id";
135 // Prepare sql query part for where.
136 $dateFormat = $user->getDateFormat();
137 if ($options['period'])
138 $period = new Period($options['period'], new DateAndTime($dateFormat));
140 $period = new Period();
142 new DateAndTime($dateFormat, $options['period_start']),
143 new DateAndTime($dateFormat, $options['period_end']));
145 $where = " where ei.status = 1 and ei.date >= '".$period->getStartDate(DB_DATEFORMAT)."' and ei.date <= '".$period->getEndDate(DB_DATEFORMAT)."'".
146 " $user_list_part $dropdown_parts";
150 // getItems retrieves all items associated with a report.
151 // It combines tt_log and tt_expense_items in one array for presentation in one table using mysql union all.
152 // Expense items use the "note" field for item name.
153 static function getItems($options) {
155 $mdb2 = getConnection();
157 // Determine these once as they are used in multiple places in this function.
158 $canViewReports = $user->can('view_reports') || $user->can('view_all_reports');
159 $isClient = $user->isClient();
161 $grouping = ttReportHelper::grouping($options);
163 $grouping_by_date = ttReportHelper::groupingBy('date', $options);
164 $grouping_by_client = ttReportHelper::groupingBy('client', $options);
165 $grouping_by_project = ttReportHelper::groupingBy('project', $options);
166 $grouping_by_task = ttReportHelper::groupingBy('task', $options);
167 $grouping_by_user = ttReportHelper::groupingBy('user', $options);
168 $grouping_by_cf_1 = ttReportHelper::groupingBy('cf_1', $options);
170 $convertTo12Hour = ('%I:%M %p' == $user->getTimeFormat()) && ($options['show_start'] || $options['show_end']);
171 $trackingMode = $user->getTrackingMode();
172 $decimalMark = $user->getDecimalMark();
174 // Prepare a query for time items in tt_log table.
175 $fields = array(); // An array of fields for database query.
176 array_push($fields, 'l.id');
177 array_push($fields, 'l.user_id');
178 array_push($fields, '1 as type'); // Type 1 is for tt_log entries.
179 array_push($fields, 'l.date');
180 if($canViewReports || $isClient)
181 array_push($fields, 'u.name as user');
182 // Add client name if it is selected.
183 if ($options['show_client'] || $grouping_by_client)
184 array_push($fields, 'c.name as client');
185 // Add project name if it is selected.
186 if ($options['show_project'] || $grouping_by_project)
187 array_push($fields, 'p.name as project');
188 // Add task name if it is selected.
189 if ($options['show_task'] || $grouping_by_task)
190 array_push($fields, 't.name as task');
192 $include_cf_1 = $options['show_custom_field_1'] || $grouping_by_cf_1;
194 $custom_fields = new CustomFields();
195 $cf_1_type = $custom_fields->fields[0]['type'];
196 if ($cf_1_type == CustomFields::TYPE_TEXT) {
197 array_push($fields, 'cfl.value as cf_1');
198 } elseif ($cf_1_type == CustomFields::TYPE_DROPDOWN) {
199 array_push($fields, 'cfo.value as cf_1');
203 if ($options['show_start']) {
204 array_push($fields, "l.start as unformatted_start");
205 array_push($fields, "TIME_FORMAT(l.start, '%k:%i') as start");
208 if ($options['show_end'])
209 array_push($fields, "TIME_FORMAT(sec_to_time(time_to_sec(l.start) + time_to_sec(l.duration)), '%k:%i') as finish");
211 if ($options['show_duration'])
212 array_push($fields, "TIME_FORMAT(l.duration, '%k:%i') as duration");
214 if ($options['show_work_units']) {
215 if ($user->getConfigOption('unit_totals_only'))
216 array_push($fields, "null as units");
218 $firstUnitThreshold = $user->getConfigInt('1st_unit_threshold', 0);
219 $minutesInUnit = $user->getConfigInt('minutes_in_unit', 15);
220 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");
224 if ($options['show_note'])
225 array_push($fields, 'l.comment as note');
227 $includeCost = $options['show_cost'];
229 if (MODE_TIME == $trackingMode)
230 array_push($fields, "cast(l.billable * coalesce(u.rate, 0) * time_to_sec(l.duration)/3600 as decimal(10,2)) as cost"); // Use default user rate.
232 array_push($fields, "cast(l.billable * coalesce(upb.rate, 0) * time_to_sec(l.duration)/3600 as decimal(10,2)) as cost"); // Use project rate for user.
233 array_push($fields, "null as expense");
236 if ($options['show_approved'])
237 array_push($fields, 'l.approved');
239 if ($canViewReports && $options['show_paid'])
240 array_push($fields, 'l.paid');
242 if ($canViewReports && $options['show_ip']) {
243 array_push($fields, 'l.created');
244 array_push($fields, 'l.created_ip');
245 array_push($fields, 'l.modified');
246 array_push($fields, 'l.modified_ip');
248 // Add invoice name if it is selected.
249 if (($canViewReports || $isClient) && $options['show_invoice'])
250 array_push($fields, 'i.name as invoice');
251 // Add timesheet name if it is selected.
252 if ($options['show_timesheet'])
253 array_push($fields, 'ts.name as timesheet_name');
255 // Prepare sql query part for left joins.
257 if ($options['show_client'] || $grouping_by_client)
258 $left_joins .= " left join tt_clients c on (c.id = l.client_id)";
259 if (($canViewReports || $isClient) && $options['show_invoice'])
260 $left_joins .= " left join tt_invoices i on (i.id = l.invoice_id and i.status = 1)";
261 if ($canViewReports || $isClient || $user->isPluginEnabled('ex'))
262 $left_joins .= " left join tt_users u on (u.id = l.user_id)";
263 if ($options['show_project'] || $grouping_by_project)
264 $left_joins .= " left join tt_projects p on (p.id = l.project_id)";
265 if ($options['show_task'] || $grouping_by_task)
266 $left_joins .= " left join tt_tasks t on (t.id = l.task_id)";
268 if ($cf_1_type == CustomFields::TYPE_TEXT)
269 $left_joins .= " left join tt_custom_field_log cfl on (l.id = cfl.log_id and cfl.status = 1)";
270 elseif ($cf_1_type == CustomFields::TYPE_DROPDOWN) {
271 $left_joins .= " left join tt_custom_field_log cfl on (l.id = cfl.log_id and cfl.status = 1)".
272 " left join tt_custom_field_options cfo on (cfl.option_id = cfo.id)";
275 if ($includeCost && MODE_TIME != $trackingMode)
276 $left_joins .= " left join tt_user_project_binds upb on (l.user_id = upb.user_id and l.project_id = upb.project_id)";
278 // Prepare sql query part for inner joins.
280 if ($user->isPluginEnabled('ts')) {
281 $timesheet_option = $options['timesheet'];
282 if ($timesheet_option == TIMESHEET_PENDING)
283 $inner_joins .= " inner join tt_timesheets ts on (l.timesheet_id = ts.id and ts.submit_status = 1 and ts.approve_status is null)";
284 else if ($timesheet_option == TIMESHEET_APPROVED)
285 $inner_joins .= " inner join tt_timesheets ts on (l.timesheet_id = ts.id and ts.approve_status = 1)";
286 else if ($timesheet_option == TIMESHEET_NOT_APPROVED)
287 $inner_joins .= " inner join tt_timesheets ts on (l.timesheet_id = ts.id and ts.approve_status = 0)";
288 else if ($options['show_timesheet'])
289 $inner_joins .= " left join tt_timesheets ts on (l.timesheet_id = ts.id)"; // Left join for timesheet nme.
292 $where = ttReportHelper::getWhere($options);
294 // Construct sql query for tt_log items.
295 $sql = "select ".join(', ', $fields)." from tt_log l $left_joins $inner_joins $where";
296 // If we don't have expense items (such as when the Expenses plugin is disabled), the above is all sql we need,
297 // with an exception of sorting part, that is added in the end.
299 // However, when we have expenses, we need to do a union with a separate query for expense items from tt_expense_items table.
300 if ($options['show_cost'] && $user->isPluginEnabled('ex')) { // if ex(penses) plugin is enabled
302 $fields = array(); // An array of fields for database query.
303 array_push($fields, 'ei.id');
304 array_push($fields, 'ei.user_id');
305 array_push($fields, '2 as type'); // Type 2 is for tt_expense_items entries.
306 array_push($fields, 'ei.date');
307 if($canViewReports || $isClient)
308 array_push($fields, 'u.name as user');
309 // Add client name if it is selected.
310 if ($options['show_client'] || $grouping_by_client)
311 array_push($fields, 'c.name as client');
312 // Add project name if it is selected.
313 if ($options['show_project'] || $grouping_by_project)
314 array_push($fields, 'p.name as project');
315 if ($options['show_task'] || $grouping_by_task)
316 array_push($fields, 'null'); // null for task name. We need to match column count for union.
317 if ($options['show_custom_field_1'] || $grouping_by_cf_1)
318 array_push($fields, 'null'); // null for cf_1.
319 if ($options['show_start']) {
320 array_push($fields, 'null'); // null for unformatted_start.
321 array_push($fields, 'null'); // null for start.
323 if ($options['show_end'])
324 array_push($fields, 'null'); // null for finish.
325 if ($options['show_duration'])
326 array_push($fields, 'null'); // null for duration.
327 if ($options['show_work_units'])
328 array_push($fields, 'null as units'); // null for work units.
329 // Use the note field to print item name.
330 if ($options['show_note'])
331 array_push($fields, 'ei.name as note');
332 array_push($fields, 'ei.cost as cost');
333 array_push($fields, 'ei.cost as expense');
335 if ($options['show_approved'])
336 array_push($fields, 'ei.approved');
338 if ($canViewReports && $options['show_paid'])
339 array_push($fields, 'ei.paid');
341 if ($canViewReports && $options['show_ip']) {
342 array_push($fields, 'ei.created');
343 array_push($fields, 'ei.created_ip');
344 array_push($fields, 'ei.modified');
345 array_push($fields, 'ei.modified_ip');
347 // Add invoice name if it is selected.
348 if (($canViewReports || $isClient) && $options['show_invoice'])
349 array_push($fields, 'i.name as invoice');
350 if ($options['show_timesheet'])
351 array_push($fields, 'null as timesheet_name');
353 // Prepare sql query part for left joins.
355 if ($canViewReports || $isClient)
356 $left_joins .= " left join tt_users u on (u.id = ei.user_id)";
357 if ($options['show_client'] || $grouping_by_client)
358 $left_joins .= " left join tt_clients c on (c.id = ei.client_id)";
359 if ($options['show_project'] || $grouping_by_project)
360 $left_joins .= " left join tt_projects p on (p.id = ei.project_id)";
361 if (($canViewReports || $isClient) && $options['show_invoice'])
362 $left_joins .= " left join tt_invoices i on (i.id = ei.invoice_id and i.status = 1)";
364 $where = ttReportHelper::getExpenseWhere($options);
366 // Construct sql query for expense items.
367 $sql_for_expense_items = "select ".join(', ', $fields)." from tt_expense_items ei $left_joins $where";
369 // Construct a union.
370 $sql = "($sql) union all ($sql_for_expense_items)";
373 // Determine sort part.
374 $sort_part = ' order by ';
376 $sort_part2 .= ($options['group_by1'] != null && $options['group_by1'] != 'no_grouping') ? ', '.$options['group_by1'] : '';
377 $sort_part2 .= ($options['group_by2'] != null && $options['group_by2'] != 'no_grouping') ? ', '.$options['group_by2'] : '';
378 $sort_part2 .= ($options['group_by3'] != null && $options['group_by3'] != 'no_grouping') ? ', '.$options['group_by3'] : '';
379 if (!$grouping_by_date) $sort_part2 .= ', date';
380 $sort_part .= ltrim($sort_part2, ', '); // Remove leading comma and space.
382 $sort_part .= 'date';
384 if (($canViewReports || $isClient) && $options['users'] && !$grouping_by_user)
385 $sort_part .= ', user, type';
386 if ($options['show_start'])
387 $sort_part .= ', unformatted_start';
388 $sort_part .= ', id';
391 // By now we are ready with sql.
393 // Obtain items for report.
394 $res = $mdb2->query($sql);
395 if (is_a($res, 'PEAR_Error')) die($res->getMessage());
397 while ($val = $res->fetchRow()) {
398 if ($convertTo12Hour) {
399 if($val['start'] != '')
400 $val['start'] = ttTimeHelper::to12HourFormat($val['start']);
401 if($val['finish'] != '')
402 $val['finish'] = ttTimeHelper::to12HourFormat($val['finish']);
404 if (isset($val['cost'])) {
405 if ('.' != $decimalMark)
406 $val['cost'] = str_replace('.', $decimalMark, $val['cost']);
408 if (isset($val['expense'])) {
409 if ('.' != $decimalMark)
410 $val['expense'] = str_replace('.', $decimalMark, $val['expense']);
413 if ($grouping) $val['grouped_by'] = ttReportHelper::makeGroupByKey($options, $val);
414 $val['date'] = ttDateToUserFormat($val['date']);
416 $report_items[] = $val;
419 return $report_items;
422 // putInSession stores tt_log and tt_expense_items ids from a report in user session
423 // as 2 comma-separated lists.
424 static function putInSession($report_items) {
425 unset($_SESSION['report_item_ids']);
426 unset($_SESSION['report_item_expense_ids']);
428 // Iterate through records and build 2 comma-separated lists.
429 foreach($report_items as $item) {
430 if ($item['type'] == 1)
431 $report_item_ids .= ','.$item['id'];
432 else if ($item['type'] == 2)
433 $report_item_expense_ids .= ','.$item['id'];
435 $report_item_ids = trim($report_item_ids, ',');
436 $report_item_expense_ids = trim($report_item_expense_ids, ',');
438 // The lists are reqdy. Put them in session.
439 if ($report_item_ids) $_SESSION['report_item_ids'] = $report_item_ids;
440 if ($report_item_expense_ids) $_SESSION['report_item_expense_ids'] = $report_item_expense_ids;
443 // getFromSession obtains tt_log and tt_expense_items ids stored in user session.
444 static function getFromSession() {
446 $report_item_ids = $_SESSION['report_item_ids'];
447 if ($report_item_ids)
448 $items['report_item_ids'] = explode(',', $report_item_ids);
449 $report_item_expense_ids = $_SESSION['report_item_expense_ids'];
450 if ($report_item_expense_ids)
451 $items['report_item_expense_ids'] = explode(',', $report_item_expense_ids);
455 // getSubtotals calculates report items subtotals when a report is grouped by.
456 // Without expenses, it's a simple select with group by.
457 // With expenses, it becomes a select with group by from a combined set of records obtained with "union all".
458 static function getSubtotals($options) {
460 $mdb2 = getConnection();
462 $concat_part = ttReportHelper::makeConcatPart($options);
463 $work_unit_part = ttReportHelper::makeWorkUnitPart($options);
464 $join_part = ttReportHelper::makeJoinPart($options);
465 $cost_part = ttReportHelper::makeCostPart($options);
466 $where = ttReportHelper::getWhere($options);
467 $group_by_part = ttReportHelper::makeGroupByPart($options);
469 $parts = "$concat_part, sum(time_to_sec(l.duration)) as time, null as expenses".$work_unit_part.$cost_part;
470 $sql = "select $parts from tt_log l $join_part $where $group_by_part";
471 // By now we have sql for time items.
473 // However, when we have expenses, we need to do a union with a separate query for expense items from tt_expense_items table.
474 if ($options['show_cost'] && $user->isPluginEnabled('ex')) { // if ex(penses) plugin is enabled
476 $concat_part = ttReportHelper::makeConcatExpensesPart($options);
477 $join_part = ttReportHelper::makeJoinExpensesPart($options);
478 $where = ttReportHelper::getExpenseWhere($options);
479 $group_by_expenses_part = ttReportHelper::makeGroupByExpensesPart($options);
480 $sql_for_expenses = "select $concat_part, null as time";
481 if ($options['show_work_units']) $sql_for_expenses .= ", null as units";
482 $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";
484 // Create a combined query.
485 $fields = ttReportHelper::makeCombinedSelectPart($options);
486 $combined = "select $fields, sum(time) as time";
487 if ($options['show_work_units']) $combined .= ", sum(units) as units";
488 $combined .= ", sum(cost) as cost, sum(expenses) as expenses from (($sql) union all ($sql_for_expenses)) t group by $fields";
493 $res = $mdb2->query($sql);
494 if (is_a($res, 'PEAR_Error')) die($res->getMessage());
495 while ($val = $res->fetchRow()) {
496 $time = $val['time'] ? sec_to_time_fmt_hm($val['time']) : null;
497 $rowLabel = ttReportHelper::makeGroupByLabel($val['group_field'], $options);
498 if ($options['show_cost']) {
499 $decimalMark = $user->getDecimalMark();
500 if ('.' != $decimalMark) {
501 $val['cost'] = str_replace('.', $decimalMark, $val['cost']);
502 $val['expenses'] = str_replace('.', $decimalMark, $val['expenses']);
504 $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']);
506 $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']);
512 // getTotals calculates total hours and cost for all report items.
513 static function getTotals($options)
516 $mdb2 = getConnection();
518 $trackingMode = $user->getTrackingMode();
519 $decimalMark = $user->getDecimalMark();
520 $where = ttReportHelper::getWhere($options);
523 $time_part = "sum(time_to_sec(l.duration)) as time";
524 if ($options['show_work_units']) {
525 $unitTotalsOnly = $user->getConfigOption('unit_totals_only');
526 $firstUnitThreshold = $user->getConfigInt('1st_unit_threshold', 0);
527 $minutesInUnit = $user->getConfigInt('minutes_in_unit', 15);
528 $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";
530 if ($options['show_cost']) {
531 if (MODE_TIME == $trackingMode)
532 $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";
534 $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";
536 $cost_part = ", null as cost, null as expenses";
538 if ($options['show_cost']) {
539 if (MODE_TIME == $trackingMode) {
540 $left_joins = "left join tt_users u on (l.user_id = u.id)";
542 $left_joins = "left join tt_user_project_binds upb on (l.user_id = upb.user_id and l.project_id = upb.project_id)";
545 // Prepare sql query part for inner joins.
547 if ($user->isPluginEnabled('ts') && $options['timesheet']) {
548 $timesheet_option = $options['timesheet'];
549 if ($timesheet_option == TIMESHEET_PENDING)
550 $inner_joins .= " inner join tt_timesheets ts on (l.timesheet_id = ts.id and ts.submit_status = 1 and ts.approve_status is null)";
551 else if ($timesheet_option == TIMESHEET_APPROVED)
552 $inner_joins .= " inner join tt_timesheets ts on (l.timesheet_id = ts.id and ts.approve_status = 1)";
553 else if ($timesheet_option == TIMESHEET_NOT_APPROVED)
554 $inner_joins .= " inner join tt_timesheets ts on (l.timesheet_id = ts.id and ts.approve_status = 0)";
556 // Prepare a query for time items.
557 $sql = "select $time_part $units_part $cost_part from tt_log l $left_joins $inner_joins $where";
559 // If we have expenses, query becomes a bit more complex.
560 if ($options['show_cost'] && $user->isPluginEnabled('ex')) {
561 $where = ttReportHelper::getExpenseWhere($options);
562 $sql_for_expenses = "select null as time";
563 if ($options['show_work_units']) $sql_for_expenses .= ", null as units";
564 $sql_for_expenses .= ", sum(cost) as cost, sum(cost) as expenses from tt_expense_items ei $where";
566 // Create a combined query.
567 $combined = "select sum(time) as time";
568 if ($options['show_work_units']) $combined .= ", sum(units) as units";
569 $combined .= ", sum(cost) as cost, sum(expenses) as expenses from (($sql) union all ($sql_for_expenses)) t";
574 $res = $mdb2->query($sql);
575 if (is_a($res, 'PEAR_Error')) die($res->getMessage());
577 $val = $res->fetchRow();
578 $total_time = $val['time'] ? sec_to_time_fmt_hm($val['time']) : null;
579 if ($options['show_cost']) {
580 $total_cost = $val['cost'];
581 if (!$total_cost) $total_cost = '0.00';
582 if ('.' != $decimalMark)
583 $total_cost = str_replace('.', $decimalMark, $total_cost);
584 $total_expenses = $val['expenses'];
585 if (!$total_expenses) $total_expenses = '0.00';
586 if ('.' != $decimalMark)
587 $total_expenses = str_replace('.', $decimalMark, $total_expenses);
590 $dateFormat = $user->getDateFormat();
591 if ($options['period'])
592 $period = new Period($options['period'], new DateAndTime($dateFormat));
594 $period = new Period();
596 new DateAndTime($dateFormat, $options['period_start']),
597 new DateAndTime($dateFormat, $options['period_end']));
600 $totals['start_date'] = $period->getStartDate();
601 $totals['end_date'] = $period->getEndDate();
602 $totals['time'] = $total_time;
603 $totals['units'] = $val['units'];
604 $totals['cost'] = $total_cost;
605 $totals['expenses'] = $total_expenses;
610 // The assignToInvoice assigns a set of records to a specific invoice.
611 static function assignToInvoice($invoice_id, $time_log_ids, $expense_item_ids) {
613 $mdb2 = getConnection();
615 $group_id = $user->getGroup();
616 $org_id = $user->org_id;
619 $sql = "update tt_log set invoice_id = ".$mdb2->quote($invoice_id).
620 " where id in(".join(', ', $time_log_ids).") and group_id = $group_id and org_id = $org_id";
621 $affected = $mdb2->exec($sql);
622 if (is_a($affected, 'PEAR_Error')) die($affected->getMessage());
624 if ($expense_item_ids) {
625 $sql = "update tt_expense_items set invoice_id = ".$mdb2->quote($invoice_id).
626 " where id in(".join(', ', $expense_item_ids).") and group_id = $group_id and org_id = $org_id";
627 $affected = $mdb2->exec($sql);
628 if (is_a($affected, 'PEAR_Error')) die($affected->getMessage());
632 // The assignToTimesheet assigns a set of tt_log records to a specific timesheet.
633 static function assignToTimesheet($timesheet_id, $time_log_ids) {
635 $mdb2 = getConnection();
637 $user_id = $user->getUser();
638 $group_id = $user->getGroup();
639 $org_id = $user->org_id;
642 // Use inner join as a protection mechanism not to do anything with "acted upon" timesheets.
643 // Allow oprations only with pending timesheets.
645 // Assigning a timesheet to records.
646 $inner_join = " inner join tt_timesheets ts on (ts.id = $timesheet_id".
647 " and ts.user_id = $user_id and ts.approve_status is null". // Timesheet to assign to is pending.
648 // Part below: existing timesheet either not exists or is also pending.
649 " and (l.timesheet_id is null or (l.timesheet_id = ts.id and ts.approve_status is null)))";
651 $inner_join = " inner join tt_timesheets ts on (ts.id = l.timesheet_id".
652 " and ts.user_id = $user_id and ts.approve_status is null)"; // Do not deassign from acted-upon timesheets.
655 $sql = "update tt_log l $inner_join".
656 " set l.timesheet_id = ".$mdb2->quote($timesheet_id).
657 " where l.id in(".join(', ', $time_log_ids).") and l.user_id = $user_id and l.group_id = $group_id and l.org_id = $org_id";
658 $affected = $mdb2->exec($sql);
659 if (is_a($affected, 'PEAR_Error')) die($affected->getMessage());
663 // The markApproved marks a set of records as either approved or unapproved.
664 static function markApproved($time_log_ids, $expense_item_ids, $approved = true) {
666 $mdb2 = getConnection();
668 $group_id = $user->getGroup();
669 $org_id = $user->org_id;
671 $approved_val = (int) $approved;
673 $sql = "update tt_log set approved = $approved_val".
674 " where id in(".join(', ', $time_log_ids).") and group_id = $group_id and org_id = $org_id";
675 $affected = $mdb2->exec($sql);
676 if (is_a($affected, 'PEAR_Error')) die($affected->getMessage());
678 if ($expense_item_ids) {
679 $sql = "update tt_expense_items set approved = $approved_val".
680 " where id in(".join(', ', $expense_item_ids).") and group_id = $group_id and org_id = $org_id";
681 $affected = $mdb2->exec($sql);
682 if (is_a($affected, 'PEAR_Error')) die($affected->getMessage());
686 // The markPaid marks a set of records as either paid or unpaid.
687 static function markPaid($time_log_ids, $expense_item_ids, $paid = true) {
689 $mdb2 = getConnection();
691 $group_id = $user->getGroup();
692 $org_id = $user->org_id;
694 $paid_val = (int) $paid;
696 $sql = "update tt_log set paid = $paid_val".
697 " where id in(".join(', ', $time_log_ids).") and group_id = $group_id and org_id = $org_id";
698 $affected = $mdb2->exec($sql);
699 if (is_a($affected, 'PEAR_Error')) die($affected->getMessage());
701 if ($expense_item_ids) {
702 $sql = "update tt_expense_items set paid = $paid_val".
703 " where id in(".join(', ', $expense_item_ids).") and group_id = $group_id and org_id = $org_id";
704 $affected = $mdb2->exec($sql);
705 if (is_a($affected, 'PEAR_Error')) die($affected->getMessage());
709 // prepareReportBody - prepares an email body for report.
710 static function prepareReportBody($options, $comment = null)
715 // Determine these once as they are used in multiple places in this function.
716 $canViewReports = $user->can('view_reports') || $user->can('view_all_reports');
717 $isClient = $user->isClient();
719 $items = ttReportHelper::getItems($options);
720 $grouping = ttReportHelper::grouping($options);
722 $subtotals = ttReportHelper::getSubtotals($options);
723 $totals = ttReportHelper::getTotals($options);
725 // Use custom fields plugin if it is enabled.
726 if ($user->isPluginEnabled('cf'))
727 $custom_fields = new CustomFields();
729 // Define some styles to use in email.
730 $style_title = 'text-align: center; font-size: 15pt; font-family: Arial, Helvetica, sans-serif;';
731 $tableHeader = 'font-weight: bold; background-color: #a6ccf7; text-align: left;';
732 $tableHeaderCentered = 'font-weight: bold; background-color: #a6ccf7; text-align: center;';
733 $rowItem = 'background-color: #ffffff;';
734 $rowItemAlt = 'background-color: #f5f5f5;';
735 $rowSubtotal = 'background-color: #e0e0e0;';
736 $cellLeftAligned = 'text-align: left; vertical-align: top;';
737 $cellRightAligned = 'text-align: right; vertical-align: top;';
738 $cellLeftAlignedSubtotal = 'font-weight: bold; text-align: left; vertical-align: top;';
739 $cellRightAlignedSubtotal = 'font-weight: bold; text-align: right; vertical-align: top;';
741 // Start creating email body.
743 $body .= '<head><meta http-equiv="content-type" content="text/html; charset='.CHARSET.'"></head>';
747 $body .= '<p style="'.$style_title.'">'.$i18n->get('form.mail.report_subject').': '.$totals['start_date'].' - '.$totals['end_date'].'</p>';
750 if ($comment) $body .= '<p>'.htmlspecialchars($comment).'</p>';
752 if ($options['show_totals_only']) {
753 // Totals only report. Output subtotals.
754 $group_by_header = ttReportHelper::makeGroupByHeader($options);
756 $body .= '<table border="0" cellpadding="4" cellspacing="0" width="100%">';
758 $body .= '<td style="'.$tableHeader.'">'.$group_by_header.'</td>';
759 if ($options['show_duration'])
760 $body .= '<td style="'.$tableHeaderCentered.'" width="5%">'.$i18n->get('label.duration').'</td>';
761 if ($options['show_work_units'])
762 $body .= '<td style="'.$tableHeaderCentered.'" width="5%">'.$i18n->get('label.work_units_short').'</td>';
763 if ($options['show_cost'])
764 $body .= '<td style="'.$tableHeaderCentered.'" width="5%">'.$i18n->get('label.cost').'</td>';
766 foreach($subtotals as $subtotal) {
767 $body .= '<tr style="'.$rowSubtotal.'">';
768 $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($subtotal['name'] ? htmlspecialchars($subtotal['name']) : ' ').'</td>';
769 if ($options['show_duration']) {
770 $body .= '<td style="'.$cellRightAlignedSubtotal.'">';
771 if ($subtotal['time'] <> '0:00') $body .= $subtotal['time'];
774 if ($options['show_work_units']) {
775 $body .= '<td style="'.$cellRightAlignedSubtotal.'">';
776 $body .= $subtotal['units'];
779 if ($options['show_cost']) {
780 $body .= '<td style="'.$cellRightAlignedSubtotal.'">';
781 $body .= ($canViewReports || $isClient) ? $subtotal['cost'] : $subtotal['expenses'];
788 $body .= '<tr><td> </td></tr>';
789 $body .= '<tr style="'.$rowSubtotal.'">';
790 $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$i18n->get('label.total').'</td>';
791 if ($options['show_duration']) {
792 $body .= '<td style="'.$cellRightAlignedSubtotal.'">';
793 if ($totals['time'] <> '0:00') $body .= $totals['time'];
796 if ($options['show_work_units']) {
797 $body .= '<td style="'.$cellRightAlignedSubtotal.'">';
798 $body .= $totals['units'];
801 if ($options['show_cost']) {
802 $body .= '<td nowrap style="'.$cellRightAlignedSubtotal.'">'.htmlspecialchars($user->currency).' ';
803 $body .= ($canViewReports || $isClient) ? $totals['cost'] : $totals['expenses'];
812 // Print table header.
813 $body .= '<table border="0" cellpadding="4" cellspacing="0" width="100%">';
815 $body .= '<td style="'.$tableHeader.'">'.$i18n->get('label.date').'</td>';
816 if ($canViewReports || $isClient)
817 $body .= '<td style="'.$tableHeader.'">'.$i18n->get('label.user').'</td>';
818 if ($options['show_client'])
819 $body .= '<td style="'.$tableHeader.'">'.$i18n->get('label.client').'</td>';
820 if ($options['show_project'])
821 $body .= '<td style="'.$tableHeader.'">'.$i18n->get('label.project').'</td>';
822 if ($options['show_task'])
823 $body .= '<td style="'.$tableHeader.'">'.$i18n->get('label.task').'</td>';
824 if ($options['show_custom_field_1'])
825 $body .= '<td style="'.$tableHeader.'">'.htmlspecialchars($custom_fields->fields[0]['label']).'</td>';
826 if ($options['show_start'])
827 $body .= '<td style="'.$tableHeaderCentered.'" width="5%">'.$i18n->get('label.start').'</td>';
828 if ($options['show_end'])
829 $body .= '<td style="'.$tableHeaderCentered.'" width="5%">'.$i18n->get('label.finish').'</td>';
830 if ($options['show_duration'])
831 $body .= '<td style="'.$tableHeaderCentered.'" width="5%">'.$i18n->get('label.duration').'</td>';
832 if ($options['show_work_units'])
833 $body .= '<td style="'.$tableHeaderCentered.'" width="5%">'.$i18n->get('label.work_units_short').'</td>';
834 if ($options['show_note'])
835 $body .= '<td style="'.$tableHeader.'">'.$i18n->get('label.note').'</td>';
836 if ($options['show_cost'])
837 $body .= '<td style="'.$tableHeaderCentered.'" width="5%">'.$i18n->get('label.cost').'</td>';
838 if ($options['show_approved'])
839 $body .= '<td style="'.$tableHeaderCentered.'" width="5%">'.$i18n->get('label.approved').'</td>';
840 if ($options['show_paid'])
841 $body .= '<td style="'.$tableHeaderCentered.'" width="5%">'.$i18n->get('label.paid').'</td>';
842 if ($options['show_ip'])
843 $body .= '<td style="'.$tableHeaderCentered.'" width="5%">'.$i18n->get('label.ip').'</td>';
844 if ($options['show_invoice'])
845 $body .= '<td style="'.$tableHeader.'">'.$i18n->get('label.invoice').'</td>';
846 if ($options['show_timesheet'])
847 $body .= '<td style="'.$tableHeader.'">'.$i18n->get('label.timesheet').'</td>';
850 // Initialize variables to print subtotals.
851 if ($items && $grouping) {
852 $print_subtotals = true;
854 $prev_grouped_by = '';
855 $cur_grouped_by = '';
857 // Initialize variables to alternate color of rows for different dates.
860 $row_style = $rowItem;
862 // Print report items.
863 if (is_array($items)) {
864 foreach ($items as $record) {
865 $cur_date = $record['date'];
866 // Print a subtotal row after a block of grouped items.
867 if ($print_subtotals) {
868 $cur_grouped_by = $record['grouped_by'];
869 if ($cur_grouped_by != $prev_grouped_by && !$first_pass) {
870 $body .= '<tr style="'.$rowSubtotal.'">';
871 $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$i18n->get('label.subtotal').'</td>';
872 $subtotal_name = htmlspecialchars($subtotals[$prev_grouped_by]['name']);
873 if ($canViewReports || $isClient) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['user'].'</td>';
874 if ($options['show_client']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['client'].'</td>';
875 if ($options['show_project']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['project'].'</td>';
876 if ($options['show_task']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['task'].'</td>';
877 if ($options['show_custom_field_1']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['cf_1'].'</td>';
878 if ($options['show_start']) $body .= '<td></td>';
879 if ($options['show_end']) $body .= '<td></td>';
880 if ($options['show_duration']) $body .= '<td style="'.$cellRightAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['time'].'</td>';
881 if ($options['show_work_units']) $body .= '<td style="'.$cellRightAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['units'].'</td>';
882 if ($options['show_note']) $body .= '<td></td>';
883 if ($options['show_cost']) {
884 $body .= '<td style="'.$cellRightAlignedSubtotal.'">';
885 $body .= ($canViewReports || $isClient) ? $subtotals[$prev_grouped_by]['cost'] : $subtotals[$prev_grouped_by]['expenses'];
888 if ($options['show_approved']) $body .= '<td></td>';
889 if ($options['show_paid']) $body .= '<td></td>';
890 if ($options['show_ip']) $body .= '<td></td>';
891 if ($options['show_invoice']) $body .= '<td></td>';
892 if ($options['show_timesheet']) $body .= '<td></td>';
894 $body .= '<tr><td> </td></tr>';
899 // Print a regular row.
900 if ($cur_date != $prev_date)
901 $row_style = ($row_style == $rowItem) ? $rowItemAlt : $rowItem;
902 $body .= '<tr style="'.$row_style.'">';
903 $body .= '<td style="'.$cellLeftAligned.'">'.$record['date'].'</td>';
904 if ($canViewReports || $isClient)
905 $body .= '<td style="'.$cellLeftAligned.'">'.htmlspecialchars($record['user']).'</td>';
906 if ($options['show_client'])
907 $body .= '<td style="'.$cellLeftAligned.'">'.htmlspecialchars($record['client']).'</td>';
908 if ($options['show_project'])
909 $body .= '<td style="'.$cellLeftAligned.'">'.htmlspecialchars($record['project']).'</td>';
910 if ($options['show_task'])
911 $body .= '<td style="'.$cellLeftAligned.'">'.htmlspecialchars($record['task']).'</td>';
912 if ($options['show_custom_field_1'])
913 $body .= '<td style="'.$cellLeftAligned.'">'.htmlspecialchars($record['cf_1']).'</td>';
914 if ($options['show_start'])
915 $body .= '<td nowrap style="'.$cellRightAligned.'">'.$record['start'].'</td>';
916 if ($options['show_end'])
917 $body .= '<td nowrap style="'.$cellRightAligned.'">'.$record['finish'].'</td>';
918 if ($options['show_duration'])
919 $body .= '<td style="'.$cellRightAligned.'">'.$record['duration'].'</td>';
920 if ($options['show_work_units'])
921 $body .= '<td style="'.$cellRightAligned.'">'.$record['units'].'</td>';
922 if ($options['show_note'])
923 $body .= '<td style="'.$cellLeftAligned.'">'.htmlspecialchars($record['note']).'</td>';
924 if ($options['show_cost'])
925 $body .= '<td style="'.$cellRightAligned.'">'.$record['cost'].'</td>';
926 if ($options['show_approved']) {
927 $body .= '<td style="'.$cellRightAligned.'">';
928 $body .= $record['approved'] == 1 ? $i18n->get('label.yes') : $i18n->get('label.no');
931 if ($options['show_paid']) {
932 $body .= '<td style="'.$cellRightAligned.'">';
933 $body .= $record['paid'] == 1 ? $i18n->get('label.yes') : $i18n->get('label.no');
936 if ($options['show_ip']) {
937 $body .= '<td style="'.$cellRightAligned.'">';
938 $body .= $record['modified'] ? $record['modified_ip'].' '.$record['modified'] : $record['created_ip'].' '.$record['created'];
941 if ($options['show_invoice'])
942 $body .= '<td style="'.$cellRightAligned.'">'.htmlspecialchars($record['invoice']).'</td>';
943 if ($options['show_timesheet'])
944 $body .= '<td style="'.$cellRightAligned.'">'.htmlspecialchars($record['timesheet']).'</td>';
947 $prev_date = $record['date'];
948 if ($print_subtotals)
949 $prev_grouped_by = $record['grouped_by'];
953 // Print a terminating subtotal.
954 if ($print_subtotals) {
955 $body .= '<tr style="'.$rowSubtotal.'">';
956 $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$i18n->get('label.subtotal').'</td>';
957 $subtotal_name = htmlspecialchars($subtotals[$cur_grouped_by]['name']);
958 if ($canViewReports || $isClient) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['user'].'</td>';
959 if ($options['show_client']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['client'].'</td>';
960 if ($options['show_project']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['project'].'</td>';
961 if ($options['show_task']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['task'].'</td>';
962 if ($options['show_custom_field_1']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['cf_1'].'</td>';
963 if ($options['show_start']) $body .= '<td></td>';
964 if ($options['show_end']) $body .= '<td></td>';
965 if ($options['show_duration']) $body .= '<td style="'.$cellRightAlignedSubtotal.'">'.$subtotals[$cur_grouped_by]['time'].'</td>';
966 if ($options['show_work_units']) $body .= '<td style="'.$cellRightAlignedSubtotal.'">'.$subtotals[$cur_grouped_by]['units'].'</td>';
967 if ($options['show_note']) $body .= '<td></td>';
968 if ($options['show_cost']) {
969 $body .= '<td style="'.$cellRightAlignedSubtotal.'">';
970 $body .= ($canViewReports || $isClient) ? $subtotals[$cur_grouped_by]['cost'] : $subtotals[$cur_grouped_by]['expenses'];
973 if ($options['show_approved']) $body .= '<td></td>';
974 if ($options['show_paid']) $body .= '<td></td>';
975 if ($options['show_ip']) $body .= '<td></td>';
976 if ($options['show_invoice']) $body .= '<td></td>';
977 if ($options['show_timesheet']) $body .= '<td></td>';
982 $body .= '<tr><td> </td></tr>';
983 $body .= '<tr style="'.$rowSubtotal.'">';
984 $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$i18n->get('label.total').'</td>';
985 if ($canViewReports || $isClient) $body .= '<td></td>';
986 if ($options['show_client']) $body .= '<td></td>';
987 if ($options['show_project']) $body .= '<td></td>';
988 if ($options['show_task']) $body .= '<td></td>';
989 if ($options['show_custom_field_1']) $body .= '<td></td>';
990 if ($options['show_start']) $body .= '<td></td>';
991 if ($options['show_end']) $body .= '<td></td>';
992 if ($options['show_duration']) $body .= '<td style="'.$cellRightAlignedSubtotal.'">'.$totals['time'].'</td>';
993 if ($options['show_work_units']) $body .= '<td style="'.$cellRightAlignedSubtotal.'">'.$totals['units'].'</td>';
994 if ($options['show_note']) $body .= '<td></td>';
995 if ($options['show_cost']) {
996 $body .= '<td nowrap style="'.$cellRightAlignedSubtotal.'">'.htmlspecialchars($user->currency).' ';
997 $body .= ($canViewReports || $isClient) ? $totals['cost'] : $totals['expenses'];
1000 if ($options['show_approved']) $body .= '<td></td>';
1001 if ($options['show_paid']) $body .= '<td></td>';
1002 if ($options['show_ip']) $body .= '<td></td>';
1003 if ($options['show_invoice']) $body .= '<td></td>';
1004 if ($options['show_timesheet']) $body .= '<td></td>';
1007 $body .= '</table>';
1011 if (!defined('REPORT_FOOTER') || !(REPORT_FOOTER == false))
1012 $body .= '<p style="text-align: center;">'.$i18n->get('form.mail.footer').'</p>';
1014 // Finish creating email body.
1015 $body .= '</body></html>';
1020 // checkFavReportCondition - checks whether it is okay to send fav report.
1021 static function checkFavReportCondition($options, $condition)
1023 $items = ttReportHelper::getItems($options);
1025 $condition = trim(str_replace('count', '', $condition));
1027 $greater_or_equal = ttStartsWith($condition, '>=');
1028 if ($greater_or_equal) $condition = trim(str_replace('>=', '', $condition));
1030 $less_or_equal = ttStartsWith($condition, '<=');
1031 if ($less_or_equal) $condition = trim(str_replace('<=', '', $condition));
1033 $not_equal = ttStartsWith($condition, '<>');
1034 if ($not_equal) $condition = trim(str_replace('<>', '', $condition));
1036 $greater = ttStartsWith($condition, '>');
1037 if ($greater) $condition = trim(str_replace('>', '', $condition));
1039 $less = ttStartsWith($condition, '<');
1040 if ($less) $condition = trim(str_replace('<', '', $condition));
1042 $equal = ttStartsWith($condition, '=');
1043 if ($equal) $condition = trim(str_replace('=', '', $condition));
1045 $count_required = (int) $condition;
1047 if ($greater && count($items) > $count_required) return true;
1048 if ($greater_or_equal && count($items) >= $count_required) return true;
1049 if ($less && count($items) < $count_required) return true;
1050 if ($less_or_equal && count($items) <= $count_required) return true;
1051 if ($equal && count($items) == $count_required) return true;
1052 if ($not_equal && count($items) <> $count_required) return true;
1057 // sendFavReport - sends a favorite report to a specified email, called from cron.php
1058 static function sendFavReport($options, $subject, $email, $cc) {
1059 // We are called from cron.php, we have no $bean in session.
1060 // cron.php sets global $user and $i18n objects to match our favorite report user.
1064 // Prepare report body.
1065 $body = ttReportHelper::prepareReportBody($options);
1067 import('mail.Mailer');
1068 $mailer = new Mailer();
1069 $mailer->setCharSet(CHARSET);
1070 $mailer->setContentType('text/html');
1071 $mailer->setSender(SENDER);
1073 $mailer->setReceiverCC($cc);
1074 if (!empty($user->bcc_email))
1075 $mailer->setReceiverBCC($user->bcc_email);
1076 $mailer->setReceiver($email);
1077 $mailer->setMailMode(MAIL_MODE);
1078 if (empty($subject)) $subject = $options['name'];
1079 if (!$mailer->send($subject, $body))
1085 // getReportOptions - returns an array of report options constructed from session bean.
1087 // Note: similarly to ttFavReportHelper::getReportOptions, this function is a part of
1088 // refactoring to simplify maintenance of report generating functions, as we currently
1089 // have 2 sets: normal reporting (from bean), and fav report emailing (from db fields).
1090 // Using options obtained from either db or bean shall allow us to use only one set of functions.
1091 static function getReportOptions($bean) {
1094 // Prepare an array of report options.
1097 // Construct one by one.
1098 $options['name'] = null; // No name required.
1099 $options['user_id'] = $user->id; // Not sure if we need user_id here. Fav reports use it to recycle $user object in cron.php.
1100 $options['client_id'] = $bean->getAttribute('client');
1101 $options['cf_1_option_id'] = $bean->getAttribute('option');
1102 $options['project_id'] = $bean->getAttribute('project');
1103 $options['task_id'] = $bean->getAttribute('task');
1104 $options['billable'] = $bean->getAttribute('include_records');
1105 $options['invoice'] = $bean->getAttribute('invoice');
1106 $options['paid_status'] = $bean->getAttribute('paid_status');
1107 $options['approved'] = $bean->getAttribute('approved');
1108 if ($user->isPluginEnabled('ap') && $user->isClient() && !$user->can('view_client_unapproved'))
1109 $options['approved'] = 1; // Restrict clients to approved records only.
1110 $options['timesheet'] = $bean->getAttribute('timesheet');
1111 if (is_array($bean->getAttribute('users'))) $options['users'] = join(',', $bean->getAttribute('users'));
1112 $options['period'] = $bean->getAttribute('period');
1113 $options['period_start'] = $bean->getAttribute('start_date');
1114 $options['period_end'] = $bean->getAttribute('end_date');
1115 $options['show_client'] = $bean->getAttribute('chclient');
1116 $options['show_invoice'] = $bean->getAttribute('chinvoice');
1117 $options['show_approved'] = $bean->getAttribute('chapproved');
1118 $options['show_paid'] = $bean->getAttribute('chpaid');
1119 $options['show_ip'] = $bean->getAttribute('chip');
1120 $options['show_project'] = $bean->getAttribute('chproject');
1121 $options['show_start'] = $bean->getAttribute('chstart');
1122 $options['show_duration'] = $bean->getAttribute('chduration');
1123 $options['show_cost'] = $bean->getAttribute('chcost');
1124 $options['show_task'] = $bean->getAttribute('chtask');
1125 $options['show_end'] = $bean->getAttribute('chfinish');
1126 $options['show_note'] = $bean->getAttribute('chnote');
1127 $options['show_custom_field_1'] = $bean->getAttribute('chcf_1');
1128 $options['show_work_units'] = $bean->getAttribute('chunits');
1129 $options['show_timesheet'] = $bean->getAttribute('chtimesheet');
1130 $options['show_totals_only'] = $bean->getAttribute('chtotalsonly');
1131 $options['group_by1'] = $bean->getAttribute('group_by1');
1132 $options['group_by2'] = $bean->getAttribute('group_by2');
1133 $options['group_by3'] = $bean->getAttribute('group_by3');
1137 // verifyBean is a security function to make sure data in bean makes sense for a group.
1138 static function verifyBean($bean) {
1142 $users_in_bean = $bean->getAttribute('users');
1143 if (is_array($users_in_bean)) {
1144 $users_in_group = ttGroupHelper::getUsers();
1145 foreach ($users_in_group as $user_in_group) {
1146 $valid_ids[] = $user_in_group['id'];
1148 foreach ($users_in_bean as $user_in_bean) {
1149 if (!in_array($user_in_bean, $valid_ids)) {
1155 // TODO: add additional checks here. Perhaps do it before saving the bean for consistency.
1159 // makeGroupByKey builds a combined group by key from group_by1, group_by2 and group_by3 values
1160 // (passed in $options) and a row of data ($row obtained from a db query).
1161 static function makeGroupByKey($options, $row) {
1162 if ($options['group_by1'] != null && $options['group_by1'] != 'no_grouping') {
1163 // We have group_by1.
1164 $group_by1 = $options['group_by1'];
1165 $group_by1_value = $row[$group_by1];
1166 //if ($group_by1 == 'date') $group_by1_value = ttDateToUserFormat($group_by1_value);
1167 if (empty($group_by1_value)) $group_by1_value = 'Null'; // To match what comes out of makeConcatPart.
1168 $group_by_key .= ' - '.$group_by1_value;
1170 if ($options['group_by2'] != null && $options['group_by2'] != 'no_grouping') {
1171 // We have group_by2.
1172 $group_by2 = $options['group_by2'];
1173 $group_by2_value = $row[$group_by2];
1174 //if ($group_by2 == 'date') $group_by2_value = ttDateToUserFormat($group_by2_value);
1175 if (empty($group_by2_value)) $group_by2_value = 'Null'; // To match what comes out of makeConcatPart.
1176 $group_by_key .= ' - '.$group_by2_value;
1178 if ($options['group_by3'] != null && $options['group_by3'] != 'no_grouping') {
1179 // We have group_by3.
1180 $group_by3 = $options['group_by3'];
1181 $group_by3_value = $row[$group_by3];
1182 //if ($group_by3 == 'date') $group_by3_value = ttDateToUserFormat($group_by3_value);
1183 if (empty($group_by3_value)) $group_by3_value = 'Null'; // To match what comes out of makeConcatPart.
1184 $group_by_key .= ' - '.$group_by3_value;
1186 $group_by_key = trim($group_by_key, ' -');
1187 return $group_by_key;
1190 // makeGroupByPart builds a combined group by part for sql query for time items using group_by1,
1191 // group_by2, and group_by3 values passed in $options.
1192 static function makeGroupByPart($options) {
1193 if (!ttReportHelper::grouping($options)) return null;
1195 $group_by1 = $options['group_by1'];
1196 $group_by2 = $options['group_by2'];
1197 $group_by3 = $options['group_by3'];
1199 switch ($group_by1) {
1201 $group_by_parts .= ', l.date';
1204 $group_by_parts .= ', u.name';
1207 $group_by_parts .= ', c.name';
1210 $group_by_parts .= ', p.name';
1213 $group_by_parts .= ', t.name';
1216 $group_by_parts .= ', cfo.value';
1219 switch ($group_by2) {
1221 $group_by_parts .= ', l.date';
1224 $group_by_parts .= ', u.name';
1227 $group_by_parts .= ', c.name';
1230 $group_by_parts .= ', p.name';
1233 $group_by_parts .= ', t.name';
1236 $group_by_parts .= ', cfo.value';
1239 switch ($group_by3) {
1241 $group_by_parts .= ', l.date';
1244 $group_by_parts .= ', u.name';
1247 $group_by_parts .= ', c.name';
1250 $group_by_parts .= ', p.name';
1253 $group_by_parts .= ', t.name';
1256 $group_by_parts .= ', cfo.value';
1259 // Remove garbage from the beginning.
1260 $group_by_parts = ltrim($group_by_parts, ', ');
1261 $group_by_part = "group by $group_by_parts";
1262 return $group_by_part;
1265 // makeGroupByExpensesPart builds a combined group by part for sql query for expense items using
1266 // group_by1, group_by2, and group_by3 values passed in $options.
1267 static function makeGroupByExpensesPart($options) {
1268 $no_grouping = ($options['group_by1'] == null || $options['group_by1'] == 'no_grouping') &&
1269 ($options['group_by2'] == null || $options['group_by2'] == 'no_grouping') &&
1270 ($options['group_by3'] == null || $options['group_by3'] == 'no_grouping');
1271 if ($no_grouping) return null;
1273 $group_by1 = $options['group_by1'];
1274 $group_by2 = $options['group_by2'];
1275 $group_by3 = $options['group_by3'];
1277 switch ($group_by1) {
1279 $group_by_parts .= ', ei.date';
1282 $group_by_parts .= ', u.name';
1285 $group_by_parts .= ', c.name';
1288 $group_by_parts .= ', p.name';
1291 switch ($group_by2) {
1293 $group_by_parts .= ', ei.date';
1296 $group_by_parts .= ', u.name';
1299 $group_by_parts .= ', c.name';
1302 $group_by_parts .= ', p.name';
1305 switch ($group_by3) {
1307 $group_by_parts .= ', ei.date';
1310 $group_by_parts .= ', u.name';
1313 $group_by_parts .= ', c.name';
1316 $group_by_parts .= ', p.name';
1319 // Remove garbage from the beginning.
1320 $group_by_parts = ltrim($group_by_parts, ', ');
1321 if ($group_by_parts)
1322 $group_by_part = "group by $group_by_parts";
1323 return $group_by_part;
1326 // makeConcatPart builds a concatenation part for getSubtotals query (for time items).
1327 static function makeConcatPart($options) {
1328 $group_by1 = $options['group_by1'];
1329 $group_by2 = $options['group_by2'];
1330 $group_by3 = $options['group_by3'];
1332 switch ($group_by1) {
1334 $what_to_concat .= ", ' - ', l.date";
1337 $what_to_concat .= ", ' - ', u.name";
1338 $fields_part .= ', u.name as user';
1341 $what_to_concat .= ", ' - ', coalesce(c.name, 'Null')";
1342 $fields_part .= ', c.name as client';
1345 $what_to_concat .= ", ' - ', coalesce(p.name, 'Null')";
1346 $fields_part .= ', p.name as project';
1349 $what_to_concat .= ", ' - ', coalesce(t.name, 'Null')";
1350 $fields_part .= ', t.name as task';
1353 $what_to_concat .= ", ' - ', coalesce(cfo.value, 'Null')";
1354 $fields_part .= ', cfo.value as cf_1';
1357 switch ($group_by2) {
1359 $what_to_concat .= ", ' - ', l.date";
1362 $what_to_concat .= ", ' - ', u.name";
1363 $fields_part .= ', u.name as user';
1366 $what_to_concat .= ", ' - ', coalesce(c.name, 'Null')";
1367 $fields_part .= ', c.name as client';
1370 $what_to_concat .= ", ' - ', coalesce(p.name, 'Null')";
1371 $fields_part .= ', p.name as project';
1374 $what_to_concat .= ", ' - ', coalesce(t.name, 'Null')";
1375 $fields_part .= ', t.name as task';
1378 $what_to_concat .= ", ' - ', coalesce(cfo.value, 'Null')";
1379 $fields_part .= ', cfo.value as cf_1';
1382 switch ($group_by3) {
1384 $what_to_concat .= ", ' - ', l.date";
1387 $what_to_concat .= ", ' - ', u.name";
1388 $fields_part .= ', u.name as user';
1391 $what_to_concat .= ", ' - ', coalesce(c.name, 'Null')";
1392 $fields_part .= ', c.name as client';
1395 $what_to_concat .= ", ' - ', coalesce(p.name, 'Null')";
1396 $fields_part .= ', p.name as project';
1399 $what_to_concat .= ", ' - ', coalesce(t.name, 'Null')";
1400 $fields_part .= ', t.name as task';
1403 $what_to_concat .= ", ' - ', coalesce(cfo.value, 'Null')";
1404 $fields_part .= ', cfo.value as cf_1';
1407 // Remove garbage from both ends.
1408 $what_to_concat = trim($what_to_concat, "', -");
1409 $concat_part = "concat($what_to_concat) as group_field";
1410 $concat_part = trim($concat_part, ' -');
1411 return "$concat_part $fields_part";
1414 // makeConcatPart builds a concatenation part for getSubtotals query (for expense items).
1415 static function makeConcatExpensesPart($options) {
1416 $group_by1 = $options['group_by1'];
1417 $group_by2 = $options['group_by2'];
1418 $group_by3 = $options['group_by3'];
1420 switch ($group_by1) {
1422 $what_to_concat .= ", ' - ', ei.date";
1425 $what_to_concat .= ", ' - ', u.name";
1426 $fields_part .= ', u.name as user';
1429 $what_to_concat .= ", ' - ', coalesce(c.name, 'Null')";
1430 $fields_part .= ', c.name as client';
1433 $what_to_concat .= ", ' - ', coalesce(p.name, 'Null')";
1434 $fields_part .= ', p.name as project';
1438 $what_to_concat .= ", ' - ', 'Null'";
1439 $fields_part .= ', null as task';
1443 $what_to_concat .= ", ' - ', 'Null'";
1444 $fields_part .= ', null as cf_1';
1447 switch ($group_by2) {
1449 $what_to_concat .= ", ' - ', ei.date";
1452 $what_to_concat .= ", ' - ', u.name";
1453 $fields_part .= ', u.name as user';
1456 $what_to_concat .= ", ' - ', coalesce(c.name, 'Null')";
1457 $fields_part .= ', c.name as client';
1460 $what_to_concat .= ", ' - ', coalesce(p.name, 'Null')";
1461 $fields_part .= ', p.name as project';
1465 $what_to_concat .= ", ' - ', 'Null'";
1466 $fields_part .= ', null as task';
1470 $what_to_concat .= ", ' - ', 'Null'";
1471 $fields_part .= ', null as cf_1';
1474 switch ($group_by3) {
1476 $what_to_concat .= ", ' - ', ei.date";
1479 $what_to_concat .= ", ' - ', u.name";
1480 $fields_part .= ', u.name as user';
1483 $what_to_concat .= ", ' - ', coalesce(c.name, 'Null')";
1484 $fields_part .= ', c.name as client';
1487 $what_to_concat .= ", ' - ', coalesce(p.name, 'Null')";
1488 $fields_part .= ', p.name as project';
1492 $what_to_concat .= ", ' - ', 'Null'";
1493 $fields_part .= ', null as task';
1497 $what_to_concat .= ", ' - ', 'Null'";
1498 $fields_part .= ', null as cf_1';
1501 // Remove garbage from the beginning.
1502 if ($what_to_concat)
1503 $what_to_concat = substr($what_to_concat, 8);
1504 $concat_part = "concat($what_to_concat) as group_field";
1505 return "$concat_part $fields_part";
1508 // makeCombinedSelectPart builds a list of fields for a combined select on a union for getSubtotals.
1509 // This is used when we include expenses.
1510 static function makeCombinedSelectPart($options) {
1511 $group_by1 = $options['group_by1'];
1512 $group_by2 = $options['group_by2'];
1513 $group_by3 = $options['group_by3'];
1515 $fields = "group_field";
1517 switch ($group_by1) {
1519 $fields .= ', user';
1522 $fields_part .= ', client';
1525 $fields .= ', project';
1529 $fields .= ', task';
1533 $fields .= ', cf_1';
1536 switch ($group_by2) {
1538 $fields .= ', user';
1541 $fields_part .= ', client';
1544 $fields .= ', project';
1548 $fields .= ', task';
1552 $fields .= ', cf_1';
1555 switch ($group_by3) {
1557 $fields .= ', user';
1560 $fields_part .= ', client';
1563 $fields .= ', project';
1567 $fields .= ', task';
1571 $fields .= ', cf_1';
1577 // makeJoinPart builds a left join part for getSubtotals query (for time items).
1578 static function makeJoinPart($options) {
1581 $trackingMode = $user->getTrackingMode();
1582 if (ttReportHelper::groupingBy('user', $options) || MODE_TIME == $trackingMode) {
1583 $join .= ' left join tt_users u on (l.user_id = u.id)';
1585 if (ttReportHelper::groupingBy('client', $options)) {
1586 $join .= ' left join tt_clients c on (l.client_id = c.id)';
1588 if (ttReportHelper::groupingBy('project', $options)) {
1589 $join .= ' left join tt_projects p on (l.project_id = p.id)';
1591 if (ttReportHelper::groupingBy('task', $options)) {
1592 $join .= ' left join tt_tasks t on (l.task_id = t.id)';
1594 if (ttReportHelper::groupingBy('cf_1', $options)) {
1595 $custom_fields = new CustomFields();
1596 if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT)
1597 $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.value = cfo.id)';
1598 elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN)
1599 $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)';
1601 if ($options['show_cost'] && $trackingMode != MODE_TIME) {
1602 $join .= ' left join tt_user_project_binds upb on (l.user_id = upb.user_id and l.project_id = upb.project_id)';
1604 // Prepare inner joins.
1605 $inner_joins = null;
1606 if ($user->isPluginEnabled('ts') && $options['timesheet']) {
1607 $timesheet_option = $options['timesheet'];
1608 if ($timesheet_option == TIMESHEET_PENDING)
1609 $inner_joins .= " inner join tt_timesheets ts on (l.timesheet_id = ts.id and ts.submit_status = 1 and ts.approve_status is null)";
1610 else if ($timesheet_option == TIMESHEET_APPROVED)
1611 $inner_joins .= " inner join tt_timesheets ts on (l.timesheet_id = ts.id and ts.approve_status = 1)";
1612 else if ($timesheet_option == TIMESHEET_NOT_APPROVED)
1613 $inner_joins .= " inner join tt_timesheets ts on (l.timesheet_id = ts.id and ts.approve_status = 0)";
1615 $join .= $inner_joins;
1619 // makeWorkUnitPart builds an sql part for work units for time items.
1620 static function makeWorkUnitPart($options) {
1623 $workUnits = $options['show_work_units'];
1625 $unitTotalsOnly = $user->getConfigOption('unit_totals_only');
1626 $firstUnitThreshold = $user->getConfigInt('1st_unit_threshold', 0);
1627 $minutesInUnit = $user->getConfigInt('minutes_in_unit', 15);
1628 if ($unitTotalsOnly)
1629 $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";
1631 $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";
1633 return $work_unit_part;
1636 // makeCostPart builds a cost part for time items.
1637 static function makeCostPart($options) {
1640 if ($options['show_cost']) {
1641 if (MODE_TIME == $user->getTrackingMode())
1642 $cost_part = ", sum(cast(l.billable * coalesce(u.rate, 0) * time_to_sec(l.duration)/3600 as decimal(10, 2))) as cost";
1644 $cost_part .= ", sum(cast(l.billable * coalesce(upb.rate, 0) * time_to_sec(l.duration)/3600 as decimal(10,2))) as cost";
1649 // makeJoinExpensesPart builds a left join part for getSubtotals query for expense items.
1650 static function makeJoinExpensesPart($options) {
1653 if (ttReportHelper::groupingBy('user', $options)) {
1654 $join .= ' left join tt_users u on (ei.user_id = u.id)';
1656 if (ttReportHelper::groupingBy('client', $options)) {
1657 $join .= ' left join tt_clients c on (ei.client_id = c.id)';
1659 if (ttReportHelper::groupingBy('project', $options)) {
1660 $join .= ' left join tt_projects p on (ei.project_id = p.id)';
1665 // grouping determines if we are grouping the report by either group_by1,
1666 // group_by2, or group_by3 values passed in $options.
1667 static function grouping($options) {
1668 $grouping = ($options['group_by1'] != null && $options['group_by1'] != 'no_grouping') ||
1669 ($options['group_by2'] != null && $options['group_by2'] != 'no_grouping') ||
1670 ($options['group_by3'] != null && $options['group_by3'] != 'no_grouping');
1674 // groupingBy determines if we are grouping a report by a value of $what
1675 // ('date', 'user', 'project', etc.) by checking group_by1, group_by2,
1676 // and group_by3 values passed in $options.
1677 static function groupingBy($what, $options) {
1678 $grouping = ($options['group_by1'] == $what) || ($options['group_by2'] == $what) || ($options['group_by3'] == $what);
1682 // makeGroupByHeader builds a column header for a totals-only report using group_by1,
1683 // group_by2, and group_by3 values passed in $options.
1684 static function makeGroupByHeader($options) {
1686 global $custom_fields;
1688 $no_grouping = ($options['group_by1'] == null || $options['group_by1'] == 'no_grouping') &&
1689 ($options['group_by2'] == null || $options['group_by2'] == 'no_grouping') &&
1690 ($options['group_by3'] == null || $options['group_by3'] == 'no_grouping');
1691 if ($no_grouping) return null;
1693 if ($options['group_by1'] != null && $options['group_by1'] != 'no_grouping') {
1694 // We have group_by1.
1695 $group_by1 = $options['group_by1'];
1696 if ('cf_1' == $group_by1)
1697 $group_by_header .= ' - '.$custom_fields->fields[0]['label'];
1699 $key = 'label.'.$group_by1;
1700 $group_by_header .= ' - '.$i18n->get($key);
1703 if ($options['group_by2'] != null && $options['group_by2'] != 'no_grouping') {
1704 // We have group_by2.
1705 $group_by2 = $options['group_by2'];
1706 if ('cf_1' == $group_by2)
1707 $group_by_header .= ' - '.$custom_fields->fields[0]['label'];
1709 $key = 'label.'.$group_by2;
1710 $group_by_header .= ' - '.$i18n->get($key);
1713 if ($options['group_by3'] != null && $options['group_by3'] != 'no_grouping') {
1714 // We have group_by3.
1715 $group_by3 = $options['group_by3'];
1716 if ('cf_1' == $group_by3)
1717 $group_by_header .= ' - '.$custom_fields->fields[0]['label'];
1719 $key = 'label.'.$group_by3;
1720 $group_by_header .= ' - '.$i18n->get($key);
1723 $group_by_header = ltrim($group_by_header, ' -');
1724 return $group_by_header;
1727 // makeGroupByXmlTag creates an xml tag for a totals only report using group_by1,
1728 // group_by2, and group_by3 values passed in $options.
1729 static function makeGroupByXmlTag($options) {
1730 if ($options['group_by1'] != null && $options['group_by1'] != 'no_grouping') {
1731 // We have group_by1.
1732 $tag .= '_'.$options['group_by1'];
1734 if ($options['group_by2'] != null && $options['group_by2'] != 'no_grouping') {
1735 // We have group_by2.
1736 $tag .= '_'.$options['group_by2'];
1738 if ($options['group_by3'] != null && $options['group_by3'] != 'no_grouping') {
1739 // We have group_by3.
1740 $tag .= '_'.$options['group_by3'];
1742 $tag = ltrim($tag, '_');
1746 // makeGroupByLabel builds a label for one row in a "Totals only" report of grouped by items.
1747 // It does one thing: if we are grouping by date, the date format is converted for user.
1748 static function makeGroupByLabel($key, $options) {
1749 if (!ttReportHelper::groupingBy('date', $options))
1750 return $key; // No need to format.
1753 if ($user->getDateFormat() == DB_DATEFORMAT)
1754 return $key; // No need to format.
1757 if (preg_match('/\d\d\d\d-\d\d-\d\d/', $key, $matches)) {
1758 // Replace the first found match of a date in DB_DATEFORMAT.
1759 // This is not entirely clean but better than nothing for a label in a row.
1760 $userDate = ttDateToUserFormat($matches[0]);
1761 $label = str_replace($matches[0], $userDate, $key);