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 // Class ttReportHelper is used for help with reports.
37 class ttReportHelper {
39 // getWhere prepares a WHERE clause for a report query.
40 static function getWhere($options) {
43 // Prepare dropdown parts.
45 if ($options['client_id'])
46 $dropdown_parts .= ' and l.client_id = '.$options['client_id'];
47 elseif ($user->isClient() && $user->client_id)
48 $dropdown_parts .= ' and l.client_id = '.$user->client_id;
49 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'].')';
50 if ($options['project_id']) $dropdown_parts .= ' and l.project_id = '.$options['project_id'];
51 if ($options['task_id']) $dropdown_parts .= ' and l.task_id = '.$options['task_id'];
52 if ($options['billable']=='1') $dropdown_parts .= ' and l.billable = 1';
53 if ($options['billable']=='2') $dropdown_parts .= ' and l.billable = 0';
54 if ($options['invoice']=='1') $dropdown_parts .= ' and l.invoice_id is not NULL';
55 if ($options['invoice']=='2') $dropdown_parts .= ' and l.invoice_id is NULL';
56 if ($options['paid_status']=='1') $dropdown_parts .= ' and l.paid = 1';
57 if ($options['paid_status']=='2') $dropdown_parts .= ' and l.paid = 0';
59 // Prepare sql query part for user list.
60 $userlist = $options['users'] ? $options['users'] : '-1';
61 if ($user->can('view_reports') || $user->can('view_all_reports') || $user->isClient())
62 $user_list_part = " and l.user_id in ($userlist)";
64 $user_list_part = " and l.user_id = ".$user->id;
65 $user_list_part .= " and l.group_id = ".$user->getActiveGroup();
67 // Prepare sql query part for where.
68 if ($options['period'])
69 $period = new Period($options['period'], new DateAndTime($user->date_format));
71 $period = new Period();
73 new DateAndTime($user->date_format, $options['period_start']),
74 new DateAndTime($user->date_format, $options['period_end']));
76 $where = " where l.status = 1 and l.date >= '".$period->getStartDate(DB_DATEFORMAT)."' and l.date <= '".$period->getEndDate(DB_DATEFORMAT)."'".
77 " $user_list_part $dropdown_parts";
81 // getExpenseWhere prepares WHERE clause for expenses query in a report.
82 static function getExpenseWhere($options) {
85 // Prepare dropdown parts.
87 if ($options['client_id'])
88 $dropdown_parts .= ' and ei.client_id = '.$options['client_id'];
89 elseif ($user->isClient() && $user->client_id)
90 $dropdown_parts .= ' and ei.client_id = '.$user->client_id;
91 if ($options['project_id']) $dropdown_parts .= ' and ei.project_id = '.$options['project_id'];
92 if ($options['invoice']=='1') $dropdown_parts .= ' and ei.invoice_id is not NULL';
93 if ($options['invoice']=='2') $dropdown_parts .= ' and ei.invoice_id is NULL';
94 if ($options['paid_status']=='1') $dropdown_parts .= ' and ei.paid = 1';
95 if ($options['paid_status']=='2') $dropdown_parts .= ' and ei.paid = 0';
97 // Prepare sql query part for user list.
98 $userlist = $options['users'] ? $options['users'] : '-1';
99 if ($user->can('view_reports') || $user->can('view_all_reports') || $user->isClient())
100 $user_list_part = " and ei.user_id in ($userlist)";
102 $user_list_part = " and ei.user_id = ".$user->id;
103 $user_list_part .= " and ei.group_id = ".$user->getActiveGroup();
105 // Prepare sql query part for where.
106 if ($options['period'])
107 $period = new Period($options['period'], new DateAndTime($user->date_format));
109 $period = new Period();
111 new DateAndTime($user->date_format, $options['period_start']),
112 new DateAndTime($user->date_format, $options['period_end']));
114 $where = " where ei.status = 1 and ei.date >= '".$period->getStartDate(DB_DATEFORMAT)."' and ei.date <= '".$period->getEndDate(DB_DATEFORMAT)."'".
115 " $user_list_part $dropdown_parts";
119 // getItems retrieves all items associated with a report.
120 // It combines tt_log and tt_expense_items in one array for presentation in one table using mysql union all.
121 // Expense items use the "note" field for item name.
122 static function getItems($options) {
124 $mdb2 = getConnection();
126 // Determine these once as they are used in multiple places in this function.
127 $canViewReports = $user->can('view_reports') || $user->can('view_all_reports');
128 $isClient = $user->isClient();
130 $group_by_option = $options['group_by'];
131 $convertTo12Hour = ('%I:%M %p' == $user->time_format) && ($options['show_start'] || $options['show_end']);
133 // Prepare a query for time items in tt_log table.
134 $fields = array(); // An array of fields for database query.
135 array_push($fields, 'l.id as id');
136 array_push($fields, '1 as type'); // Type 1 is for tt_log entries.
137 array_push($fields, 'l.date as date');
138 if($canViewReports || $isClient)
139 array_push($fields, 'u.name as user');
140 // Add client name if it is selected.
141 if ($options['show_client'] || 'client' == $group_by_option)
142 array_push($fields, 'c.name as client');
143 // Add project name if it is selected.
144 if ($options['show_project'] || 'project' == $group_by_option)
145 array_push($fields, 'p.name as project');
146 // Add task name if it is selected.
147 if ($options['show_task'] || 'task' == $group_by_option)
148 array_push($fields, 't.name as task');
150 $include_cf_1 = $options['show_custom_field_1'] || 'cf_1' == $group_by_option;
152 $custom_fields = new CustomFields($user->group_id);
153 $cf_1_type = $custom_fields->fields[0]['type'];
154 if ($cf_1_type == CustomFields::TYPE_TEXT) {
155 array_push($fields, 'cfl.value as cf_1');
156 } elseif ($cf_1_type == CustomFields::TYPE_DROPDOWN) {
157 array_push($fields, 'cfo.value as cf_1');
161 if ($options['show_start']) {
162 array_push($fields, "l.start as unformatted_start");
163 array_push($fields, "TIME_FORMAT(l.start, '%k:%i') as start");
166 if ($options['show_end'])
167 array_push($fields, "TIME_FORMAT(sec_to_time(time_to_sec(l.start) + time_to_sec(l.duration)), '%k:%i') as finish");
169 if ($options['show_duration'])
170 array_push($fields, "TIME_FORMAT(l.duration, '%k:%i') as duration");
172 if ($options['show_work_units']) {
173 if ($user->unit_totals_only)
174 array_push($fields, "null as units");
176 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");
179 if ($options['show_note'])
180 array_push($fields, 'l.comment as note');
182 $includeCost = $options['show_cost'];
184 if (MODE_TIME == $user->tracking_mode)
185 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.
187 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.
188 array_push($fields, "null as expense");
191 if ($canViewReports && $options['show_paid'])
192 array_push($fields, 'l.paid as paid');
194 if ($canViewReports && $options['show_ip']) {
195 array_push($fields, 'l.created as created');
196 array_push($fields, 'l.created_ip as created_ip');
197 array_push($fields, 'l.modified as modified');
198 array_push($fields, 'l.modified_ip as modified_ip');
200 // Add invoice name if it is selected.
201 if (($canViewReports || $isClient) && $options['show_invoice'])
202 array_push($fields, 'i.name as invoice');
204 // Prepare sql query part for left joins.
206 if ($options['show_client'] || 'client' == $group_by_option)
207 $left_joins .= " left join tt_clients c on (c.id = l.client_id)";
208 if (($canViewReports || $isClient) && $options['show_invoice'])
209 $left_joins .= " left join tt_invoices i on (i.id = l.invoice_id and i.status = 1)";
210 if ($canViewReports || $isClient || $user->isPluginEnabled('ex'))
211 $left_joins .= " left join tt_users u on (u.id = l.user_id)";
212 if ($options['show_project'] || 'project' == $group_by_option)
213 $left_joins .= " left join tt_projects p on (p.id = l.project_id)";
214 if ($options['show_task'] || 'task' == $group_by_option)
215 $left_joins .= " left join tt_tasks t on (t.id = l.task_id)";
217 if ($cf_1_type == CustomFields::TYPE_TEXT)
218 $left_joins .= " left join tt_custom_field_log cfl on (l.id = cfl.log_id and cfl.status = 1)";
219 elseif ($cf_1_type == CustomFields::TYPE_DROPDOWN) {
220 $left_joins .= " left join tt_custom_field_log cfl on (l.id = cfl.log_id and cfl.status = 1)".
221 " left join tt_custom_field_options cfo on (cfl.option_id = cfo.id)";
224 if ($includeCost && MODE_TIME != $user->tracking_mode)
225 $left_joins .= " left join tt_user_project_binds upb on (l.user_id = upb.user_id and l.project_id = upb.project_id)";
227 $where = ttReportHelper::getWhere($options);
229 // Construct sql query for tt_log items.
230 $sql = "select ".join(', ', $fields)." from tt_log l $left_joins $where";
231 // If we don't have expense items (such as when the Expenses plugin is desabled), the above is all sql we need,
232 // with an exception of sorting part, that is added in the end.
234 // However, when we have expenses, we need to do a union with a separate query for expense items from tt_expense_items table.
235 if ($options['show_cost'] && $user->isPluginEnabled('ex')) { // if ex(penses) plugin is enabled
237 $fields = array(); // An array of fields for database query.
238 array_push($fields, 'ei.id');
239 array_push($fields, '2 as type'); // Type 2 is for tt_expense_items entries.
240 array_push($fields, 'ei.date');
241 if($canViewReports || $isClient)
242 array_push($fields, 'u.name as user');
243 // Add client name if it is selected.
244 if ($options['show_client'] || 'client' == $group_by_option)
245 array_push($fields, 'c.name as client');
246 // Add project name if it is selected.
247 if ($options['show_project'] || 'project' == $group_by_option)
248 array_push($fields, 'p.name as project');
249 if ($options['show_task'] || 'task' == $group_by_option)
250 array_push($fields, 'null'); // null for task name. We need to match column count for union.
251 if ($options['show_custom_field_1'] || 'cf_1' == $group_by_option)
252 array_push($fields, 'null'); // null for cf_1.
253 if ($options['show_start']) {
254 array_push($fields, 'null'); // null for unformatted_start.
255 array_push($fields, 'null'); // null for start.
257 if ($options['show_end'])
258 array_push($fields, 'null'); // null for finish.
259 if ($options['show_duration'])
260 array_push($fields, 'null'); // null for duration.
261 if ($options['show_work_units'])
262 array_push($fields, 'null as units'); // null for work units.
263 // Use the note field to print item name.
264 if ($options['show_note'])
265 array_push($fields, 'ei.name as note');
266 array_push($fields, 'ei.cost as cost');
267 array_push($fields, 'ei.cost as expense');
269 if ($canViewReports && $options['show_paid'])
270 array_push($fields, 'ei.paid as paid');
272 if ($canViewReports && $options['show_ip']) {
273 array_push($fields, 'ei.created as created');
274 array_push($fields, 'ei.created_ip as created_ip');
275 array_push($fields, 'ei.modified as modified');
276 array_push($fields, 'ei.modified_ip as modified_ip');
278 // Add invoice name if it is selected.
279 if (($canViewReports || $isClient) && $options['show_invoice'])
280 array_push($fields, 'i.name as invoice');
282 // Prepare sql query part for left joins.
284 if ($canViewReports || $isClient)
285 $left_joins .= " left join tt_users u on (u.id = ei.user_id)";
286 if ($options['show_client'] || 'client' == $group_by_option)
287 $left_joins .= " left join tt_clients c on (c.id = ei.client_id)";
288 if ($options['show_project'] || 'project' == $group_by_option)
289 $left_joins .= " left join tt_projects p on (p.id = ei.project_id)";
290 if (($canViewReports || $isClient) && $options['show_invoice'])
291 $left_joins .= " left join tt_invoices i on (i.id = ei.invoice_id and i.status = 1)";
293 $where = ttReportHelper::getExpenseWhere($options);
295 // Construct sql query for expense items.
296 $sql_for_expense_items = "select ".join(', ', $fields)." from tt_expense_items ei $left_joins $where";
298 // Construct a union.
299 $sql = "($sql) union all ($sql_for_expense_items)";
302 // Determine sort part.
303 $sort_part = ' order by ';
304 if ($group_by_option == null || 'no_grouping' == $group_by_option || 'date' == $group_by_option)
305 $sort_part .= 'date';
307 $sort_part .= $group_by_option.', date';
308 if (($canViewReports || $isClient) && $options['users'] && 'user' != $group_by_option)
309 $sort_part .= ', user, type';
310 if ($options['show_start'])
311 $sort_part .= ', unformatted_start';
312 $sort_part .= ', id';
315 // By now we are ready with sql.
317 // Obtain items for report.
318 $res = $mdb2->query($sql);
319 if (is_a($res, 'PEAR_Error')) die($res->getMessage());
321 while ($val = $res->fetchRow()) {
322 if ($convertTo12Hour) {
323 if($val['start'] != '')
324 $val['start'] = ttTimeHelper::to12HourFormat($val['start']);
325 if($val['finish'] != '')
326 $val['finish'] = ttTimeHelper::to12HourFormat($val['finish']);
328 if (isset($val['cost'])) {
329 if ('.' != $user->decimal_mark)
330 $val['cost'] = str_replace('.', $user->decimal_mark, $val['cost']);
332 if (isset($val['expense'])) {
333 if ('.' != $user->decimal_mark)
334 $val['expense'] = str_replace('.', $user->decimal_mark, $val['expense']);
336 if ('no_grouping' != $group_by_option) {
337 $val['grouped_by'] = $val[$group_by_option];
338 if ('date' == $group_by_option) {
339 // This is needed to get the date in user date format.
340 $o_date = new DateAndTime(DB_DATEFORMAT, $val['grouped_by']);
341 $val['grouped_by'] = $o_date->toString($user->date_format);
346 // This is needed to get the date in user date format.
347 $o_date = new DateAndTime(DB_DATEFORMAT, $val['date']);
348 $val['date'] = $o_date->toString($user->date_format);
352 $report_items[] = $row;
355 return $report_items;
358 // putInSession stores tt_log and tt_expense_items ids from a report in user session
359 // as 2 comma-separated lists.
360 static function putInSession($report_items) {
361 unset($_SESSION['report_item_ids']);
362 unset($_SESSION['report_item_expense_ids']);
364 // Iterate through records and build 2 comma-separated lists.
365 foreach($report_items as $item) {
366 if ($item['type'] == 1)
367 $report_item_ids .= ','.$item['id'];
368 else if ($item['type'] == 2)
369 $report_item_expense_ids .= ','.$item['id'];
371 $report_item_ids = trim($report_item_ids, ',');
372 $report_item_expense_ids = trim($report_item_expense_ids, ',');
374 // The lists are reqdy. Put them in session.
375 if ($report_item_ids) $_SESSION['report_item_ids'] = $report_item_ids;
376 if ($report_item_expense_ids) $_SESSION['report_item_expense_ids'] = $report_item_expense_ids;
379 // getFromSession obtains tt_log and tt_expense_items ids stored in user session.
380 static function getFromSession() {
382 $report_item_ids = $_SESSION['report_item_ids'];
383 if ($report_item_ids)
384 $items['report_item_ids'] = explode(',', $report_item_ids);
385 $report_item_expense_ids = $_SESSION['report_item_expense_ids'];
386 if ($report_item_expense_ids)
387 $items['report_item_expense_ids'] = explode(',', $report_item_expense_ids);
391 // getSubtotals calculates report items subtotals when a report is grouped by.
392 // Without expenses, it's a simple select with group by.
393 // With expenses, it becomes a select with group by from a combined set of records obtained with "union all".
394 static function getSubtotals($options) {
397 $group_by_option = $options['group_by'];
398 if ('no_grouping' == $group_by_option) return null;
400 $mdb2 = getConnection();
402 // Start with sql to obtain subtotals for time items. This simple sql will be used when we have no expenses.
404 // Determine group by field and a required join.
405 switch ($group_by_option) {
407 $group_field = 'l.date';
411 $group_field = 'u.name';
412 $group_join = 'left join tt_users u on (l.user_id = u.id) ';
415 $group_field = 'c.name';
416 $group_join = 'left join tt_clients c on (l.client_id = c.id) ';
419 $group_field = 'p.name';
420 $group_join = 'left join tt_projects p on (l.project_id = p.id) ';
423 $group_field = 't.name';
424 $group_join = 'left join tt_tasks t on (l.task_id = t.id) ';
427 $group_field = 'cfo.value';
428 $custom_fields = new CustomFields($user->group_id);
429 if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT)
430 $group_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) ';
431 elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN)
432 $group_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) ';
436 $where = ttReportHelper::getWhere($options);
437 if ($options['show_cost']) {
438 if (MODE_TIME == $user->tracking_mode) {
439 if ($group_by_option != 'user')
440 $left_join = 'left join tt_users u on (l.user_id = u.id)';
441 $sql = "select $group_field as group_field, sum(time_to_sec(l.duration)) as time";
442 if ($options['show_work_units']) {
443 if ($user->unit_totals_only)
444 $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";
446 $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";
448 $sql .= ", sum(cast(l.billable * coalesce(u.rate, 0) * time_to_sec(l.duration)/3600 as decimal(10, 2))) as cost,
449 null as expenses from tt_log l
450 $group_join $left_join $where group by $group_field";
452 // If we are including cost and tracking projects, our query (the same as above) needs to join the tt_user_project_binds table.
453 $sql = "select $group_field as group_field, sum(time_to_sec(l.duration)) as time";
454 if ($options['show_work_units']) {
455 if ($user->unit_totals_only)
456 $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";
458 $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";
460 $sql .= ", sum(cast(l.billable * coalesce(upb.rate, 0) * time_to_sec(l.duration)/3600 as decimal(10,2))) as cost,
461 null as expenses from tt_log l
463 left join tt_user_project_binds upb on (l.user_id = upb.user_id and l.project_id = upb.project_id) $where group by $group_field";
466 $sql = "select $group_field as group_field, sum(time_to_sec(l.duration)) as time";
467 if ($options['show_work_units']) {
468 if ($user->unit_totals_only)
469 $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";
471 $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";
473 $sql .= ", null as expenses from tt_log l
474 $group_join $where group by $group_field";
476 // By now we have sql for time items.
478 // However, when we have expenses, we need to do a union with a separate query for expense items from tt_expense_items table.
479 if ($options['show_cost'] && $user->isPluginEnabled('ex')) { // if ex(penses) plugin is enabled
481 // Determine group by field and a required join.
483 $group_field = 'null';
484 switch ($group_by_option) {
486 $group_field = 'ei.date';
490 $group_field = 'u.name';
491 $group_join = 'left join tt_users u on (ei.user_id = u.id) ';
494 $group_field = 'c.name';
495 $group_join = 'left join tt_clients c on (ei.client_id = c.id) ';
498 $group_field = 'p.name';
499 $group_join = 'left join tt_projects p on (ei.project_id = p.id) ';
503 $where = ttReportHelper::getExpenseWhere($options);
504 $sql_for_expenses = "select $group_field as group_field, null as time";
505 if ($options['show_work_units']) $sql_for_expenses .= ", null as units";
506 $sql_for_expenses .= ", sum(ei.cost) as cost, sum(ei.cost) as expenses from tt_expense_items ei $group_join $where";
507 // Add a "group by" clause if we are grouping.
508 if ('null' != $group_field) $sql_for_expenses .= " group by $group_field";
510 // Create a combined query.
511 $combined = "select group_field, sum(time) as time";
512 if ($options['show_work_units']) $combined .= ", sum(units) as units";
513 $combined .= ", sum(cost) as cost, sum(expenses) as expenses from (($sql) union all ($sql_for_expenses)) t group by group_field";
518 $res = $mdb2->query($sql);
519 if (is_a($res, 'PEAR_Error')) die($res->getMessage());
521 while ($val = $res->fetchRow()) {
522 if ('date' == $group_by_option) {
523 // This is needed to get the date in user date format.
524 $o_date = new DateAndTime(DB_DATEFORMAT, $val['group_field']);
525 $val['group_field'] = $o_date->toString($user->date_format);
528 $time = $val['time'] ? sec_to_time_fmt_hm($val['time']) : null;
529 if ($options['show_cost']) {
530 if ('.' != $user->decimal_mark) {
531 $val['cost'] = str_replace('.', $user->decimal_mark, $val['cost']);
532 $val['expenses'] = str_replace('.', $user->decimal_mark, $val['expenses']);
534 $subtotals[$val['group_field']] = array('name'=>$val['group_field'],'time'=>$time, 'units'=> $val['units'], 'cost'=>$val['cost'],'expenses'=>$val['expenses']);
536 $subtotals[$val['group_field']] = array('name'=>$val['group_field'],'time'=>$time, 'units'=> $val['units']);
542 // getTotals calculates total hours and cost for all report items.
543 static function getTotals($options)
547 $mdb2 = getConnection();
549 $where = ttReportHelper::getWhere($options);
552 $time_part = "sum(time_to_sec(l.duration)) as time";
553 if ($options['show_work_units']) {
554 $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";
556 if ($options['show_cost']) {
557 if (MODE_TIME == $user->tracking_mode)
558 $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";
560 $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";
562 $cost_part = ", null as cost, null as expenses";
564 if ($options['show_cost']) {
565 if (MODE_TIME == $user->tracking_mode) {
566 $left_joins = "left join tt_users u on (l.user_id = u.id)";
568 $left_joins = "left join tt_user_project_binds upb on (l.user_id = upb.user_id and l.project_id = upb.project_id)";
571 // Prepare a query for time items.
572 $sql = "select $time_part $units_part $cost_part from tt_log l $left_joins $where";
574 // If we have expenses, query becomes a bit more complex.
575 if ($options['show_cost'] && $user->isPluginEnabled('ex')) {
576 $where = ttReportHelper::getExpenseWhere($options);
577 $sql_for_expenses = "select null as time";
578 if ($options['show_work_units']) $sql_for_expenses .= ", null as units";
579 $sql_for_expenses .= ", sum(cost) as cost, sum(cost) as expenses from tt_expense_items ei $where";
581 // Create a combined query.
582 $combined = "select sum(time) as time";
583 if ($options['show_work_units']) $combined .= ", sum(units) as units";
584 $combined .= ", sum(cost) as cost, sum(expenses) as expenses from (($sql) union all ($sql_for_expenses)) t";
589 $res = $mdb2->query($sql);
590 if (is_a($res, 'PEAR_Error')) die($res->getMessage());
592 $val = $res->fetchRow();
593 $total_time = $val['time'] ? sec_to_time_fmt_hm($val['time']) : null;
594 if ($options['show_cost']) {
595 $total_cost = $val['cost'];
596 if (!$total_cost) $total_cost = '0.00';
597 if ('.' != $user->decimal_mark)
598 $total_cost = str_replace('.', $user->decimal_mark, $total_cost);
599 $total_expenses = $val['expenses'];
600 if (!$total_expenses) $total_expenses = '0.00';
601 if ('.' != $user->decimal_mark)
602 $total_expenses = str_replace('.', $user->decimal_mark, $total_expenses);
605 if ($options['period'])
606 $period = new Period($options['period'], new DateAndTime($user->date_format));
608 $period = new Period();
610 new DateAndTime($user->date_format, $options['period_start']),
611 new DateAndTime($user->date_format, $options['period_end']));
614 $totals['start_date'] = $period->getStartDate();
615 $totals['end_date'] = $period->getEndDate();
616 $totals['time'] = $total_time;
617 $totals['units'] = $val['units'];
618 $totals['cost'] = $total_cost;
619 $totals['expenses'] = $total_expenses;
624 // The assignToInvoice assigns a set of records to a specific invoice.
625 static function assignToInvoice($invoice_id, $time_log_ids, $expense_item_ids)
627 $mdb2 = getConnection();
629 $sql = "update tt_log set invoice_id = ".$mdb2->quote($invoice_id).
630 " where id in(".join(', ', $time_log_ids).")";
631 $affected = $mdb2->exec($sql);
632 if (is_a($affected, 'PEAR_Error')) die($affected->getMessage());
634 if ($expense_item_ids) {
635 $sql = "update tt_expense_items set invoice_id = ".$mdb2->quote($invoice_id).
636 " where id in(".join(', ', $expense_item_ids).")";
637 $affected = $mdb2->exec($sql);
638 if (is_a($affected, 'PEAR_Error')) die($affected->getMessage());
642 // The markPaid marks a set of records as either paid or unpaid.
643 static function markPaid($time_log_ids, $expense_item_ids, $paid = true)
645 $mdb2 = getConnection();
646 $paid_val = (int) $paid;
648 $sql = "update tt_log set paid = $paid_val where id in(".join(', ', $time_log_ids).")";
649 $affected = $mdb2->exec($sql);
650 if (is_a($affected, 'PEAR_Error')) die($affected->getMessage());
652 if ($expense_item_ids) {
653 $sql = "update tt_expense_items set paid = $paid_val where id in(".join(', ', $expense_item_ids).")";
654 $affected = $mdb2->exec($sql);
655 if (is_a($affected, 'PEAR_Error')) die($affected->getMessage());
659 // prepareReportBody - prepares an email body for report.
660 static function prepareReportBody($options, $comment = null)
665 // Determine these once as they are used in multiple places in this function.
666 $canViewReports = $user->can('view_reports') || $user->can('view_all_reports');
667 $isClient = $user->isClient();
669 $items = ttReportHelper::getItems($options);
670 $group_by = $options['group_by'];
671 if ($group_by && 'no_grouping' != $group_by)
672 $subtotals = ttReportHelper::getSubtotals($options);
673 $totals = ttReportHelper::getTotals($options);
675 // Use custom fields plugin if it is enabled.
676 if ($user->isPluginEnabled('cf'))
677 $custom_fields = new CustomFields($user->group_id);
679 // Define some styles to use in email.
680 $style_title = 'text-align: center; font-size: 15pt; font-family: Arial, Helvetica, sans-serif;';
681 $tableHeader = 'font-weight: bold; background-color: #a6ccf7; text-align: left;';
682 $tableHeaderCentered = 'font-weight: bold; background-color: #a6ccf7; text-align: center;';
683 $rowItem = 'background-color: #ffffff;';
684 $rowItemAlt = 'background-color: #f5f5f5;';
685 $rowSubtotal = 'background-color: #e0e0e0;';
686 $cellLeftAligned = 'text-align: left; vertical-align: top;';
687 $cellRightAligned = 'text-align: right; vertical-align: top;';
688 $cellLeftAlignedSubtotal = 'font-weight: bold; text-align: left; vertical-align: top;';
689 $cellRightAlignedSubtotal = 'font-weight: bold; text-align: right; vertical-align: top;';
691 // Start creating email body.
693 $body .= '<head><meta http-equiv="content-type" content="text/html; charset='.CHARSET.'"></head>';
697 $body .= '<p style="'.$style_title.'">'.$i18n->get('form.mail.report_subject').': '.$totals['start_date'].' - '.$totals['end_date'].'</p>';
700 if ($comment) $body .= '<p>'.htmlspecialchars($comment).'</p>';
702 if ($options['show_totals_only']) {
703 // Totals only report. Output subtotals.
705 // Determine group_by header.
706 if ('cf_1' == $group_by)
707 $group_by_header = htmlspecialchars($custom_fields->fields[0]['label']);
709 $key = 'label.'.$group_by;
710 $group_by_header = $i18n->get($key);
713 $body .= '<table border="0" cellpadding="4" cellspacing="0" width="100%">';
715 $body .= '<td style="'.$tableHeader.'">'.$group_by_header.'</td>';
716 if ($options['show_duration'])
717 $body .= '<td style="'.$tableHeaderCentered.'" width="5%">'.$i18n->get('label.duration').'</td>';
718 if ($options['show_work_units'])
719 $body .= '<td style="'.$tableHeaderCentered.'" width="5%">'.$i18n->get('label.work_units_short').'</td>';
720 if ($options['show_cost'])
721 $body .= '<td style="'.$tableHeaderCentered.'" width="5%">'.$i18n->get('label.cost').'</td>';
723 foreach($subtotals as $subtotal) {
724 $body .= '<tr style="'.$rowSubtotal.'">';
725 $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($subtotal['name'] ? htmlspecialchars($subtotal['name']) : ' ').'</td>';
726 if ($options['show_duration']) {
727 $body .= '<td style="'.$cellRightAlignedSubtotal.'">';
728 if ($subtotal['time'] <> '0:00') $body .= $subtotal['time'];
731 if ($options['show_work_units']) {
732 $body .= '<td style="'.$cellRightAlignedSubtotal.'">';
733 $body .= $subtotal['units'];
736 if ($options['show_cost']) {
737 $body .= '<td style="'.$cellRightAlignedSubtotal.'">';
738 $body .= ($canViewReports || $isClient) ? $subtotal['cost'] : $subtotal['expenses'];
745 $body .= '<tr><td> </td></tr>';
746 $body .= '<tr style="'.$rowSubtotal.'">';
747 $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$i18n->get('label.total').'</td>';
748 if ($options['show_duration']) {
749 $body .= '<td style="'.$cellRightAlignedSubtotal.'">';
750 if ($totals['time'] <> '0:00') $body .= $totals['time'];
753 if ($options['show_work_units']) {
754 $body .= '<td style="'.$cellRightAlignedSubtotal.'">';
755 $body .= $totals['units'];
758 if ($options['show_cost']) {
759 $body .= '<td nowrap style="'.$cellRightAlignedSubtotal.'">'.htmlspecialchars($user->currency).' ';
760 $body .= ($canViewReports || $isClient) ? $totals['cost'] : $totals['expenses'];
769 // Print table header.
770 $body .= '<table border="0" cellpadding="4" cellspacing="0" width="100%">';
772 $body .= '<td style="'.$tableHeader.'">'.$i18n->get('label.date').'</td>';
773 if ($canViewReports || $isClient)
774 $body .= '<td style="'.$tableHeader.'">'.$i18n->get('label.user').'</td>';
775 if ($options['show_client'])
776 $body .= '<td style="'.$tableHeader.'">'.$i18n->get('label.client').'</td>';
777 if ($options['show_project'])
778 $body .= '<td style="'.$tableHeader.'">'.$i18n->get('label.project').'</td>';
779 if ($options['show_task'])
780 $body .= '<td style="'.$tableHeader.'">'.$i18n->get('label.task').'</td>';
781 if ($options['show_custom_field_1'])
782 $body .= '<td style="'.$tableHeader.'">'.htmlspecialchars($custom_fields->fields[0]['label']).'</td>';
783 if ($options['show_start'])
784 $body .= '<td style="'.$tableHeaderCentered.'" width="5%">'.$i18n->get('label.start').'</td>';
785 if ($options['show_end'])
786 $body .= '<td style="'.$tableHeaderCentered.'" width="5%">'.$i18n->get('label.finish').'</td>';
787 if ($options['show_duration'])
788 $body .= '<td style="'.$tableHeaderCentered.'" width="5%">'.$i18n->get('label.duration').'</td>';
789 if ($options['show_work_units'])
790 $body .= '<td style="'.$tableHeaderCentered.'" width="5%">'.$i18n->get('label.work_units_short').'</td>';
791 if ($options['show_note'])
792 $body .= '<td style="'.$tableHeader.'">'.$i18n->get('label.note').'</td>';
793 if ($options['show_cost'])
794 $body .= '<td style="'.$tableHeaderCentered.'" width="5%">'.$i18n->get('label.cost').'</td>';
795 if ($options['show_paid'])
796 $body .= '<td style="'.$tableHeaderCentered.'" width="5%">'.$i18n->get('label.paid').'</td>';
797 if ($options['show_ip'])
798 $body .= '<td style="'.$tableHeaderCentered.'" width="5%">'.$i18n->get('label.ip').'</td>';
799 if ($options['show_invoice'])
800 $body .= '<td style="'.$tableHeader.'">'.$i18n->get('label.invoice').'</td>';
803 // Initialize variables to print subtotals.
804 if ($items && 'no_grouping' != $group_by) {
805 $print_subtotals = true;
807 $prev_grouped_by = '';
808 $cur_grouped_by = '';
810 // Initialize variables to alternate color of rows for different dates.
813 $row_style = $rowItem;
815 // Print report items.
816 if (is_array($items)) {
817 foreach ($items as $record) {
818 $cur_date = $record['date'];
819 // Print a subtotal row after a block of grouped items.
820 if ($print_subtotals) {
821 $cur_grouped_by = $record['grouped_by'];
822 if ($cur_grouped_by != $prev_grouped_by && !$first_pass) {
823 $body .= '<tr style="'.$rowSubtotal.'">';
824 $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$i18n->get('label.subtotal').'</td>';
825 $subtotal_name = htmlspecialchars($subtotals[$prev_grouped_by]['name']);
826 if ($canViewReports || $isClient) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($group_by == 'user' ? $subtotal_name : '').'</td>';
827 if ($options['show_client']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($group_by == 'client' ? $subtotal_name : '').'</td>';
828 if ($options['show_project']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($group_by == 'project' ? $subtotal_name : '').'</td>';
829 if ($options['show_task']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($group_by == 'task' ? $subtotal_name : '').'</td>';
830 if ($options['show_custom_field_1']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($group_by == 'cf_1' ? $subtotal_name : '').'</td>';
831 if ($options['show_start']) $body .= '<td></td>';
832 if ($options['show_end']) $body .= '<td></td>';
833 if ($options['show_duration']) $body .= '<td style="'.$cellRightAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['time'].'</td>';
834 if ($options['show_work_units']) $body .= '<td style="'.$cellRightAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['units'].'</td>';
835 if ($options['show_note']) $body .= '<td></td>';
836 if ($options['show_cost']) {
837 $body .= '<td style="'.$cellRightAlignedSubtotal.'">';
838 $body .= ($canViewReports || $isClient) ? $subtotals[$prev_grouped_by]['cost'] : $subtotals[$prev_grouped_by]['expenses'];
841 if ($options['show_paid']) $body .= '<td></td>';
842 if ($options['show_ip']) $body .= '<td></td>';
843 if ($options['show_invoice']) $body .= '<td></td>';
845 $body .= '<tr><td> </td></tr>';
850 // Print a regular row.
851 if ($cur_date != $prev_date)
852 $row_style = ($row_style == $rowItem) ? $rowItemAlt : $rowItem;
853 $body .= '<tr style="'.$row_style.'">';
854 $body .= '<td style="'.$cellLeftAligned.'">'.$record['date'].'</td>';
855 if ($canViewReports || $isClient)
856 $body .= '<td style="'.$cellLeftAligned.'">'.htmlspecialchars($record['user']).'</td>';
857 if ($options['show_client'])
858 $body .= '<td style="'.$cellLeftAligned.'">'.htmlspecialchars($record['client']).'</td>';
859 if ($options['show_project'])
860 $body .= '<td style="'.$cellLeftAligned.'">'.htmlspecialchars($record['project']).'</td>';
861 if ($options['show_task'])
862 $body .= '<td style="'.$cellLeftAligned.'">'.htmlspecialchars($record['task']).'</td>';
863 if ($options['show_custom_field_1'])
864 $body .= '<td style="'.$cellLeftAligned.'">'.htmlspecialchars($record['cf_1']).'</td>';
865 if ($options['show_start'])
866 $body .= '<td nowrap style="'.$cellRightAligned.'">'.$record['start'].'</td>';
867 if ($options['show_end'])
868 $body .= '<td nowrap style="'.$cellRightAligned.'">'.$record['finish'].'</td>';
869 if ($options['show_duration'])
870 $body .= '<td style="'.$cellRightAligned.'">'.$record['duration'].'</td>';
871 if ($options['show_work_units'])
872 $body .= '<td style="'.$cellRightAligned.'">'.$record['units'].'</td>';
873 if ($options['show_note'])
874 $body .= '<td style="'.$cellLeftAligned.'">'.htmlspecialchars($record['note']).'</td>';
875 if ($options['show_cost'])
876 $body .= '<td style="'.$cellRightAligned.'">'.$record['cost'].'</td>';
877 if ($options['show_paid']) {
878 $body .= '<td style="'.$cellRightAligned.'">';
879 $body .= $record['paid'] == 1 ? $i18n->get('label.yes') : $i18n->get('label.no');
882 if ($options['show_ip']) {
883 $body .= '<td style="'.$cellRightAligned.'">';
884 $body .= $record['modified'] ? $record['modified_ip'].' '.$record['modified'] : $record['created_ip'].' '.$record['created'];
887 if ($options['show_invoice'])
888 $body .= '<td style="'.$cellRightAligned.'">'.htmlspecialchars($record['invoice']).'</td>';
891 $prev_date = $record['date'];
892 if ($print_subtotals)
893 $prev_grouped_by = $record['grouped_by'];
897 // Print a terminating subtotal.
898 if ($print_subtotals) {
899 $body .= '<tr style="'.$rowSubtotal.'">';
900 $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$i18n->get('label.subtotal').'</td>';
901 $subtotal_name = htmlspecialchars($subtotals[$cur_grouped_by]['name']);
902 if ($canViewReports || $isClient) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($group_by == 'user' ? $subtotal_name : '').'</td>';
903 if ($options['show_client']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($group_by == 'client' ? $subtotal_name : '').'</td>';
904 if ($options['show_project']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($group_by == 'project' ? $subtotal_name : '').'</td>';
905 if ($options['show_task']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($group_by == 'task' ? $subtotal_name : '').'</td>';
906 if ($options['show_custom_field_1']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($group_by == 'cf_1' ? $subtotal_name : '').'</td>';
907 if ($options['show_start']) $body .= '<td></td>';
908 if ($options['show_end']) $body .= '<td></td>';
909 if ($options['show_duration']) $body .= '<td style="'.$cellRightAlignedSubtotal.'">'.$subtotals[$cur_grouped_by]['time'].'</td>';
910 if ($options['show_work_units']) $body .= '<td style="'.$cellRightAlignedSubtotal.'">'.$subtotals[$cur_grouped_by]['units'].'</td>';
911 if ($options['show_note']) $body .= '<td></td>';
912 if ($options['show_cost']) {
913 $body .= '<td style="'.$cellRightAlignedSubtotal.'">';
914 $body .= ($canViewReports || $isClient) ? $subtotals[$cur_grouped_by]['cost'] : $subtotals[$cur_grouped_by]['expenses'];
917 if ($options['show_paid']) $body .= '<td></td>';
918 if ($options['show_ip']) $body .= '<td></td>';
919 if ($options['show_invoice']) $body .= '<td></td>';
924 $body .= '<tr><td> </td></tr>';
925 $body .= '<tr style="'.$rowSubtotal.'">';
926 $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$i18n->get('label.total').'</td>';
927 if ($canViewReports || $isClient) $body .= '<td></td>';
928 if ($options['show_client']) $body .= '<td></td>';
929 if ($options['show_project']) $body .= '<td></td>';
930 if ($options['show_task']) $body .= '<td></td>';
931 if ($options['show_custom_field_1']) $body .= '<td></td>';
932 if ($options['show_start']) $body .= '<td></td>';
933 if ($options['show_end']) $body .= '<td></td>';
934 if ($options['show_duration']) $body .= '<td style="'.$cellRightAlignedSubtotal.'">'.$totals['time'].'</td>';
935 if ($options['show_work_units']) $body .= '<td style="'.$cellRightAlignedSubtotal.'">'.$totals['units'].'</td>';
936 if ($options['show_note']) $body .= '<td></td>';
937 if ($options['show_cost']) {
938 $body .= '<td nowrap style="'.$cellRightAlignedSubtotal.'">'.htmlspecialchars($user->currency).' ';
939 $body .= ($canViewReports || $isClient) ? $totals['cost'] : $totals['expenses'];
942 if ($options['show_paid']) $body .= '<td></td>';
943 if ($options['show_ip']) $body .= '<td></td>';
944 if ($options['show_invoice']) $body .= '<td></td>';
951 if (!defined('REPORT_FOOTER') || !(REPORT_FOOTER == false))
952 $body .= '<p style="text-align: center;">'.$i18n->get('form.mail.footer').'</p>';
954 // Finish creating email body.
955 $body .= '</body></html>';
960 // checkFavReportCondition - checks whether it is okay to send fav report.
961 static function checkFavReportCondition($options, $condition)
963 $items = ttReportHelper::getItems($options);
965 $condition = str_replace('count', '', $condition);
966 $count_required = (int) trim(str_replace('>', '', $condition));
968 if (count($items) > $count_required)
969 return true; // Condition ok.
974 // sendFavReport - sends a favorite report to a specified email, called from cron.php
975 static function sendFavReport($options, $subject, $email, $cc) {
976 // We are called from cron.php, we have no $bean in session.
977 // cron.php sets global $user and $i18n objects to match our favorite report user.
981 // Prepare report body.
982 $body = ttReportHelper::prepareReportBody($options);
984 import('mail.Mailer');
985 $mailer = new Mailer();
986 $mailer->setCharSet(CHARSET);
987 $mailer->setContentType('text/html');
988 $mailer->setSender(SENDER);
990 $mailer->setReceiverCC($cc);
991 if (!empty($user->bcc_email))
992 $mailer->setReceiverBCC($user->bcc_email);
993 $mailer->setReceiver($email);
994 $mailer->setMailMode(MAIL_MODE);
995 if (empty($subject)) $subject = $options['name'];
996 if (!$mailer->send($subject, $body))
1002 // getReportOptions - returns an array of report options constructed from session bean.
1004 // Note: similarly to ttFavReportHelper::getReportOptions, this function is a part of
1005 // refactoring to simplify maintenance of report generating functions, as we currently
1006 // have 2 sets: normal reporting (from bean), and fav report emailing (from db fields).
1007 // Using options obtained from either db or bean shall allow us to use only one set of functions.
1008 static function getReportOptions($bean) {
1011 // Prepare an array of report options.
1014 // Construct one by one.
1015 $options['name'] = null; // No name required.
1016 $options['user_id'] = $user->id; // Not sure if we need user_id here. Fav reports use it to recycle $user object in cron.php.
1017 $options['client_id'] = $bean->getAttribute('client');
1018 $options['cf_1_option_id'] = $bean->getAttribute('option');
1019 $options['project_id'] = $bean->getAttribute('project');
1020 $options['task_id'] = $bean->getAttribute('task');
1021 $options['billable'] = $bean->getAttribute('include_records');
1022 $options['invoice'] = $bean->getAttribute('invoice');
1023 $options['paid_status'] = $bean->getAttribute('paid_status');
1024 if (is_array($bean->getAttribute('users'))) $options['users'] = join(',', $bean->getAttribute('users'));
1025 $options['period'] = $bean->getAttribute('period');
1026 $options['period_start'] = $bean->getAttribute('start_date');
1027 $options['period_end'] = $bean->getAttribute('end_date');
1028 $options['show_client'] = $bean->getAttribute('chclient');
1029 $options['show_invoice'] = $bean->getAttribute('chinvoice');
1030 $options['show_paid'] = $bean->getAttribute('chpaid');
1031 $options['show_ip'] = $bean->getAttribute('chip');
1032 $options['show_project'] = $bean->getAttribute('chproject');
1033 $options['show_start'] = $bean->getAttribute('chstart');
1034 $options['show_duration'] = $bean->getAttribute('chduration');
1035 $options['show_cost'] = $bean->getAttribute('chcost');
1036 $options['show_task'] = $bean->getAttribute('chtask');
1037 $options['show_end'] = $bean->getAttribute('chfinish');
1038 $options['show_note'] = $bean->getAttribute('chnote');
1039 $options['show_custom_field_1'] = $bean->getAttribute('chcf_1');
1040 $options['show_work_units'] = $bean->getAttribute('chunits');
1041 $options['show_totals_only'] = $bean->getAttribute('chtotalsonly');
1042 $options['group_by'] = $bean->getAttribute('group_by');
1046 // verifyBean is a security function to make sure data in bean makes sense for a group.
1047 static function verifyBean($bean) {
1051 $users_in_bean = $bean->getAttribute('users');
1052 if (is_array($users_in_bean)) {
1053 $users_in_group = ttTeamHelper::getUsers();
1054 foreach ($users_in_group as $user_in_group) {
1055 $valid_ids[] = $user_in_group['id'];
1057 foreach ($users_in_bean as $user_in_bean) {
1058 if (!in_array($user_in_bean, $valid_ids)) {
1064 // TODO: add additional checks here. Perhaps do it before saving the bean for consistency.