// The ttTimeHelper is a class to help with time-related values.
class ttTimeHelper {
+ // isWeekend determines if $date falls on weekend.
+ static function isWeekend($date) {
+ $weekDay = date('w', strtotime($date));
+ return ($weekDay == WEEKEND_START_DAY || $weekDay == (WEEKEND_START_DAY + 1) % 7);
+ }
+
+ // isHoliday determines if $date falls on a holiday.
+ static function isHoliday($date) {
+ global $i18n;
+ // $date is expected as string in DB_DATEFORMAT.
+ $month = date('m', strtotime($date));
+ $day = date('d', strtotime($date));
+ if (in_array($month.'/'.$day, $i18n->holidays))
+ return true;
+
+ return false;
+ }
+
// isValidTime validates a value as a time string.
static function isValidTime($value) {
if (strlen($value)==0 || !isset($value)) return false;
if ($value == '24:00' || $value == '2400') return true;
if (preg_match('/^([0-1]{0,1}[0-9]|2[0-3]):?[0-5][0-9]$/', $value )) { // 0:00 - 23:59, 000 - 2359
- if ('00:00' == ttTimeHelper::normalizeDuration($value))
- return false;
return true;
}
if (preg_match('/^([0-1]{0,1}[0-9]|2[0-4])h?$/', $value )) { // 0, 1 ... 24
- if ('00:00' == ttTimeHelper::normalizeDuration($value))
- return false;
return true;
}
- if (preg_match('/^([0-1]{0,1}[0-9]|2[0-3])?[.][0-9]{1,4}h?$/', $value )) { // decimal values like 0.5, 1.25h, ... .. 23.9999h
- if ('00:00' == ttTimeHelper::normalizeDuration($value))
- return false;
+
+ global $user;
+ $localizedPattern = '/^([0-1]{0,1}[0-9]|2[0-3])?['.$user->decimal_mark.'][0-9]{1,4}h?$/';
+ if (preg_match($localizedPattern, $value )) { // decimal values like 0.5, 1.25h, ... .. 23.9999h (or with comma)
return true;
}
$time_value = $value;
// If we have a decimal format - convert to time format 00:00.
+ global $user;
+ if ($user->decimal_mark == ',')
+ $time_value = str_replace (',', '.', $time_value);
+
if((strpos($time_value, '.') !== false) || (strpos($time_value, 'h') !== false)) {
$val = floatval($time_value);
$mins = round($val * 60);
return (int)@$time_a[1] + ((int)@$time_a[0]) * 60;
}
- // toAbsDuration - converts a number of minutes to format 00:00
+ // toAbsDuration - converts a number of minutes to format 0:00
// even if $minutes is negative.
static function toAbsDuration($minutes){
$hours = (string)((int)abs($minutes / 60));
$mins = (string)(abs($minutes % 60));
- if (strlen($hours) == 1)
- $hours = '0'.$hours;
if (strlen($mins) == 1)
$mins = '0' . $mins;
return $hours.':'.$mins;
$mdb2 = getConnection();
$period = new Period(INTERVAL_THIS_WEEK, $date);
- $sql = "select sum(time_to_sec(duration)) as sm from tt_log where user_id = $user_id and date >= '".$period->getBeginDate(DB_DATEFORMAT)."' and date <= '".$period->getEndDate(DB_DATEFORMAT)."' and status = 1";
+ $sql = "select sum(time_to_sec(duration)) as sm from tt_log where user_id = $user_id and date >= '".$period->getStartDate(DB_DATEFORMAT)."' and date <= '".$period->getEndDate(DB_DATEFORMAT)."' and status = 1";
$res = $mdb2->query($sql);
if (!is_a($res, 'PEAR_Error')) {
$val = $res->fetchRow();
$mdb2 = getConnection();
$period = new Period(INTERVAL_THIS_MONTH, $date);
- $sql = "select sum(time_to_sec(duration)) as sm from tt_log where user_id = $user_id and date >= '".$period->getBeginDate(DB_DATEFORMAT)."' and date <= '".$period->getEndDate(DB_DATEFORMAT)."' and status = 1";
+ $sql = "select sum(time_to_sec(duration)) as sm from tt_log where user_id = $user_id and date >= '".$period->getStartDate(DB_DATEFORMAT)."' and date <= '".$period->getEndDate(DB_DATEFORMAT)."' and status = 1";
$res = $mdb2->query($sql);
if (!is_a($res, 'PEAR_Error')) {
$val = $res->fetchRow();
return $result;
}
+ // getRecordsForInterval - returns time records for a user for a given interval of dates.
+ static function getRecordsForInterval($user_id, $start_date, $end_date) {
+ global $user;
+ $sql_time_format = "'%k:%i'"; // 24 hour format.
+ if ('%I:%M %p' == $user->time_format)
+ $sql_time_format = "'%h:%i %p'"; // 12 hour format for MySQL TIME_FORMAT function.
+
+ $result = array();
+ $mdb2 = getConnection();
+
+ $client_field = null;
+ if ($user->isPluginEnabled('cl'))
+ $client_field = ', c.id as client_id, c.name as client';
+
+ $custom_field_1 = null;
+ if ($user->isPluginEnabled('cf')) {
+ $custom_fields = new CustomFields($user->team_id);
+ $cf_1_type = $custom_fields->fields[0]['type'];
+ if ($cf_1_type == CustomFields::TYPE_TEXT) {
+ $custom_field_1 = ', cfl.value as cf_1_value';
+ } elseif ($cf_1_type == CustomFields::TYPE_DROPDOWN) {
+ $custom_field_1 = ', cfo.id as cf_1_id, cfo.value as cf_1_value';
+ }
+ }
+
+ $left_joins = " left join tt_projects p on (l.project_id = p.id)".
+ " left join tt_tasks t on (l.task_id = t.id)";
+ if ($user->isPluginEnabled('cl'))
+ $left_joins .= " left join tt_clients c on (l.client_id = c.id)";
+ if ($user->isPluginEnabled('cf')) {
+ if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT)
+ $left_joins .= 'left join tt_custom_field_log cfl on (l.id = cfl.log_id and cfl.status = 1) left join tt_custom_field_options cfo on (cfl.value = cfo.id) ';
+ elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN)
+ $left_joins .= 'left join tt_custom_field_log cfl on (l.id = cfl.log_id and cfl.status = 1) left join tt_custom_field_options cfo on (cfl.option_id = cfo.id) ';
+ }
+
+ $sql = "select l.id as id, l.date as date, TIME_FORMAT(l.start, $sql_time_format) as start,
+ TIME_FORMAT(sec_to_time(time_to_sec(l.start) + time_to_sec(l.duration)), $sql_time_format) as finish,
+ TIME_FORMAT(l.duration, '%k:%i') as duration, p.id as project_id, p.name as project,
+ t.id as task_id, t.name as task, l.comment, l.billable, l.invoice_id $client_field $custom_field_1
+ from tt_log l
+ $left_joins
+ where l.date >= '$start_date' and l.date <= '$end_date' and l.user_id = $user_id and l.status = 1
+ order by p.name, t.name, l.date, l.start, l.id";
+ $res = $mdb2->query($sql);
+ if (!is_a($res, 'PEAR_Error')) {
+ while ($val = $res->fetchRow()) {
+ if($val['duration']=='0:00')
+ $val['finish'] = '';
+ $result[] = $val;
+ }
+ } else return false;
+
+ return $result;
+ }
+
+ // getGroupedRecordsForInterval - returns time records for a user for a given interval of dates grouped in an array of dates.
+ // Example: for a week view we want one row representing the same attributes to have 7 values for each day of week.
+ // We identify simlar records by a combination of client, billable, project, task, and custom field values.
+ // This will allow us to extend the feature when more custom fields are added.
+ //
+ // "cl:546,bl:1,pr:23456,ts:27464,cf_1:example text"
+ // The above means client 546, billable, project 23456, task 27464, custom field text "example text".
+ //
+ // "cl:546,bl:0,pr:23456,ts:27464,cf_1:7623"
+ // The above means client 546, not billable, project 23456, task 27464, custom field option id 7623.
+ static function getGroupedRecordsForInterval($user_id, $start_date, $end_date) {
+ // Start by obtaining all records in interval.
+ // Then, iterate through them to build an array.
+ $records = ttTimeHelper::getRecordsForInterval($user_id, $start_date, $end_date);
+ $groupedRecords = array();
+ foreach ($records as $record) {
+ $record_identifier_no_suffix = ttTimeHelper::makeRecordIdentifier($record);
+ // Handle potential multiple records with the same attributes by using a numerical suffix.
+ $suffix = 0;
+ $record_identifier = $record_identifier_no_suffix.'_'.$suffix;
+ while (!empty($groupedRecords[$record_identifier][$record['date']])) {
+ $suffix++;
+ $record_identifier = $record_identifier_no_suffix.'_'.$suffix;
+ }
+ $groupedRecords[$record_identifier][$record['date']] = array('id'=>$record['id'], 'duration'=>$record['duration']);
+ $groupedRecords[$record_identifier]['client'] = $record['client'];
+ $groupedRecords[$record_identifier]['cf_1_value'] = $record['cf_1_value'];
+ $groupedRecords[$record_identifier]['project'] = $record['project'];
+ $groupedRecords[$record_identifier]['task'] = $record['task'];
+ $groupedRecords[$record_identifier]['billable'] = $record['billable'];
+ }
+
+ return $groupedRecords;
+ }
+
+ // getDataForWeekView - builds an array to render a table of durations for week view.
+ static function getDataForWeekView($user_id, $start_date, $end_date) {
+ // Start by obtaining all records in interval.
+ $records = ttTimeHelper::getRecordsForInterval($user_id, $start_date, $end_date);
+
+ $dataArray = array();
+
+ // Iterate through records and build $dataArray cell by cell.
+ foreach ($records as $record) {
+ // Create record id without suffix.
+ $record_id_no_suffix = ttTimeHelper::makeRecordIdentifier($record);
+ // Handle potential multiple records with the same attributes by using a numerical suffix.
+ $suffix = 0;
+ $record_id = $record_id_no_suffix.'_'.$suffix;
+ $day_header = substr($record['date'], 8); // Day number in month.
+ while (ttTimeHelper::cellExists($record_id, $day_header, $dataArray)) {
+ $suffix++;
+ $record_id = $record_id_no_suffix.'_'.$suffix;
+ }
+ // Find row.
+ $pos = ttTimeHelper::findRow($record_id, $dataArray);
+ if ($pos < 0) {
+ $dataArray[] = array('id' => $record_id,'label' => ttTimeHelper::makeRecordLabel($record)); // Insert row.
+ $pos = ttTimeHelper::findRow($record_id, $dataArray);
+ }
+ // Insert cell data from $record.
+ $dataArray[$pos][$day_header] = array('id' => $record['id'],'duration' => $record['duration']);
+ }
+ return $dataArray;
+ }
+
+ // cellExists is a helper function for getDataForWeekView() to see if a cell with a given label
+ // and a day header already exists.
+ static function cellExists($record_id, $day_header, $dataArray) {
+ foreach($dataArray as $row) {
+ if ($row['id'] == $record_id && !empty($row[$day_header]['duration']))
+ return true;
+ }
+ return false;
+ }
+
+ // findRow returns an existing row position in $dataArray, -1 otherwise.
+ static function findRow($record_id, $dataArray) {
+ $pos = 0; // Row position in array.
+ foreach($dataArray as $row) {
+ if ($row['id'] == $record_id)
+ return $pos;
+ $pos++; // Increment for search.
+ }
+ return -1; // Row not found.
+ }
+
+ // makeRecordIdentifier - builds a string identifying a record for a grouped display (such as a week view).
+ // For example:
+ // "cl:546,bl:0,pr:23456,ts:27464,cf_1:example text"
+ // "cl:546,bl:1,pr:23456,ts:27464,cf_1:7623"
+ // See comment for getGroupedRecordsForInterval.
+ static function makeRecordIdentifier($record) {
+ global $user;
+ // Start with client.
+ if ($user->isPluginEnabled('cl'))
+ $record_identifier = $record['client_id'] ? 'cl'.$record['client_id'] : '';
+ // Add billable flag.
+ if (!empty($record_identifier)) $record_identifier .= ',';
+ $record_identifier .= 'bl:'.$record['billable'];
+ // Add project.
+ $record_identifier .= $record['project_id'] ? ',pr:'.$record['project_id'] : '';
+ // Add task.
+ $record_identifier .= $record['task_id'] ? ',ts:'.$record['task_id'] : '';
+ // Add custom field 1. This requires modifying the query to get the data we need.
+ if ($user->isPluginEnabled('cf')) {
+ if ($record['cf_1_id'])
+ $record_identifier .= ',cf_1:'.$record['cf_1_id'];
+ else if ($record['cf_1_value'])
+ $record_identifier .= ',cf_1:'.$record['cf_1_value'];
+ }
+
+ return $record_identifier;
+ }
+
+ // makeRecordLabel - builds a human readable label for a row in week view,
+ // which is a combination ot record properties.
+ // Client - Project - Task - Custom field 1.
+ // Note that billable property is not part of the label. Instead, we intend to
+ // identify such records with a different color in week view.
+ static function makeRecordLabel($record) {
+ global $user;
+ // Start with client.
+ if ($user->isPluginEnabled('cl'))
+ $label = $record['client'];
+
+ // Add project.
+ if (!empty($label) && !empty($record['project'])) $label .= ' - ';
+ $label .= $record['project'];
+
+ // Add task.
+ if (!empty($label) && !empty($record['task'])) $label .= ' - ';
+ $label .= $record['task'];
+
+ // Add custom field 1.
+ if ($user->isPluginEnabled('cf')) {
+ if (!empty($label) && !empty($record['cf_1_value'])) $label .= ' - ';
+ $label .= $record['cf_1_value'];
+ }
+
+ return $label;
+ }
+
+ // getGroupedRecordsTotals - returns day totals for grouped records.
+ static function getGroupedRecordsTotals($groupedRecords) {
+ $groupedRecordsTotals = array();
+ foreach ($groupedRecords as $groupedRecord) {
+ foreach($groupedRecord as $key => $dayEntry) {
+ if ($dayEntry['duration']) {
+ $minutes = ttTimeHelper::toMinutes($dayEntry['duration']);
+ $groupedRecordsTotals[$key] += $minutes;
+ }
+ }
+ }
+ // Convert minutes to hh:mm for display.
+ foreach ($groupedRecordsTotals as $key => $single_total) {
+ $groupedRecordsTotals[$key] = ttTimeHelper::toAbsDuration($single_total);
+ }
+
+ return $groupedRecordsTotals;
+ }
+
+ // getDayHeadersForWeek - obtains day column headers for week view, which are simply day numbers in month.
+ static function getDayHeadersForWeek($start_date) {
+ $dayHeaders = array();
+ $objDate = new DateAndTime(DB_DATEFORMAT, $start_date);
+ $dayHeaders['day_header_0'] = (string)$objDate->getDate(); // It returns an int on first call. Why?
+ $objDate->incDay();
+ $dayHeaders['day_header_1'] = $objDate->getDate();
+ $objDate->incDay();
+ $dayHeaders['day_header_2'] = $objDate->getDate();
+ $objDate->incDay();
+ $dayHeaders['day_header_3'] = $objDate->getDate();
+ $objDate->incDay();
+ $dayHeaders['day_header_4'] = $objDate->getDate();
+ $objDate->incDay();
+ $dayHeaders['day_header_5'] = $objDate->getDate();
+ $objDate->incDay();
+ $dayHeaders['day_header_6'] = $objDate->getDate();
+ unset($objDate);
+ return $dayHeaders;
+ }
+
+ // getDayTotals calculates total durations for each day from the existing data in $dataArray.
+ static function getDayTotals($dataArray, $dayHeaders) {
+ $dayTotals = array();
+
+ // Insert label.
+ global $i18n;
+ $dayTotals['label'] = $i18n->getKey('label.total');
+
+ foreach ($dataArray as $row) {
+ foreach($dayHeaders as $dayHeader) {
+ if (array_key_exists($dayHeader, $row)) {
+ $minutes = ttTimeHelper::toMinutes($row[$dayHeader]['duration']);
+ $dayTotals[$dayHeader] += $minutes;
+ }
+ }
+ }
+ // Convert minutes to hh:mm for display.
+ foreach($dayHeaders as $dayHeader) {
+ $dayTotals[$dayHeader] = ttTimeHelper::toAbsDuration($dayTotals[$dayHeader]);
+ }
+ return $dayTotals;
+ }
}
+
projects / timetracker.git / blobdiff