-
- // findRow returns an existing row position in $dataArray, -1 otherwise.
- static function findRow($row_id, $dataArray) {
- $pos = 0; // Row position in array.
- foreach($dataArray as $row) {
- if ($row['row_id'] == $row_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;
- }
-
- // parseFromWeekViewRow - obtains field value encoded in row identifier.
- // For example, for a row id like "cl:546,bl:0,pr:23456,ts:27464,cf_1:example text"
- // requesting a client "cl" should return 546.
- static function parseFromWeekViewRow($row_id, $field_label) {
- // Find beginning of label.
- $pos = strpos($row_id, $field_label);
- if ($pos === false) return null; // Not found.
-
- // Strip suffix from row id.
- $suffixPos = strrpos($row_id, '_');
- if ($suffixPos)
- $remaninder = substr($row_id, 0, $suffixPos);
-
- // Find beginning of value.
- $posBegin = 1 + strpos($remaninder, ':', $pos);
- // Find end of value.
- $posEnd = strpos($remaninder, ',', $posBegin);
- if ($posEnd === false) $posEnd = strlen($remaninder);
- // Return value.
- return substr($remaninder, $posBegin, $posEnd - $posBegin);
- }
-
- // 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;
- }
-
- // 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[] = (string) $objDate->getDate(); // It returns an int on first call.
- if (strlen($dayHeaders[0]) == 1) // Which is an implementation detail of DateAndTime class.
- $dayHeaders[0] = '0'.$dayHeaders[0]; // Add a 0 for single digit day.
- $objDate->incDay();
- $dayHeaders[] = $objDate->getDate(); // After incDay it returns a string with leading 0, when necessary.
- $objDate->incDay();
- $dayHeaders[] = $objDate->getDate();
- $objDate->incDay();
- $dayHeaders[] = $objDate->getDate();
- $objDate->incDay();
- $dayHeaders[] = $objDate->getDate();
- $objDate->incDay();
- $dayHeaders[] = $objDate->getDate();
- $objDate->incDay();
- $dayHeaders[] = $objDate->getDate();
- unset($objDate);
- return $dayHeaders;
- }
-
- // getLockedDaysForWeek - builds an array of locked days in week.
- static function getLockedDaysForWeek($start_date) {
- global $user;
- $lockedDays = array();
- $objDate = new DateAndTime(DB_DATEFORMAT, $start_date);
- for ($i = 0; $i < 7; $i++) {
- $lockedDays[] = $user->isDateLocked($objDate);
- $objDate->incDay();
- }
- unset($objDate);
- return $lockedDays;
- }
-
- // 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.day_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;
- }
-
- // dateFromDayHeader calculates date from start date and day header in week view.
- static function dateFromDayHeader($start_date, $day_header) {
- $objDate = new DateAndTime(DB_DATEFORMAT, $start_date);
- $currentDayHeader = (string) $objDate->getDate(); // It returns an int on first call.
- if (strlen($currentDayHeader) == 1) // Which is an implementation detail of DateAndTime class.
- $currentDayHeader = '0'.$currentDayHeader; // Add a 0 for single digit day.
- $i = 1;
- while ($currentDayHeader != $day_header && $i < 7) {
- // Iterate through remaining days to find a match.
- $objDate->incDay();
- $currentDayHeader = $objDate->getDate(); // After incDay it returns a string with leading 0, when necessary.
- $i++;
- }
- return $objDate->toString(DB_DATEFORMAT);
- }
-
- // insertDurationFromWeekView - inserts a new record in log tables from a week view post.
- static function insertDurationFromWeekView($fields, $custom_fields, $err) {
- global $i18n;
- global $user;
-
- // Determine date for a new entry.
- $entry_date = ttTimeHelper::dateFromDayHeader($fields['start_date'], $fields['day_header']);
- $objEntryDate = new DateAndTime(DB_DATEFORMAT, $entry_date);
-
- // Prohibit creating entries in future.
- if (defined('FUTURE_ENTRIES') && !isTrue(FUTURE_ENTRIES) && $fields['browser_today']) {
- $objBrowserToday = new DateAndTime(DB_DATEFORMAT, $fields['browser_today']);
- if ($objEntryDate->after($objBrowserToday)) {
- $err->add($i18n->getKey('error.future_date'));
- return false;
- }
- }
-
- // Prepare an array of fields for regular insert function.
- $fields4insert = array();
- $fields4insert['user_id'] = $user->getActiveUser();
- $fields4insert['date'] = $entry_date;
- $fields4insert['duration'] = $fields['duration'];
- $fields4insert['client'] = ttTimeHelper::parseFromWeekViewRow($fields['row_id'], 'cl');
- $fields4insert['billable'] = ttTimeHelper::parseFromWeekViewRow($fields['row_id'], 'bl');
- $fields4insert['project'] = ttTimeHelper::parseFromWeekViewRow($fields['row_id'], 'pr');
- $fields4insert['task'] = ttTimeHelper::parseFromWeekViewRow($fields['row_id'], 'ts');
- $fields4insert['note'] = $fields['note'];
-
- // Try to insert a record.
- $id = ttTimeHelper::insert($fields4insert);
- if (!$id) return false; // Something failed.
-
- // Insert custom field if we have it.
- $result = true;
- $cf_1 = ttTimeHelper::parseFromWeekViewRow($fields['row_id'], 'cf_1');
- if ($custom_fields && $cf_1) {
- if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT)
- $result = $custom_fields->insert($id, $custom_fields->fields[0]['id'], null, $cf_1);
- elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN)
- $result = $custom_fields->insert($id, $custom_fields->fields[0]['id'], $cf_1, null);
- }
-
- return $result;
- }
-
-
- // modifyFromWeekView - modifies a duration of an existing record from a week view post.
- static function modifyDurationFromWeekView($fields, $err) {
- global $i18n;
- global $user;
-
- // Possible errors: 1) Overlap if the existing record has start time. 2) Going beyond 24 hour boundary.
- // TODO: rename this function.
- // Handle different errors with specific error messages.
- if (!ttTimeHelper::wvCanModify($fields['tt_log_id'], $fields['duration'], $err)) {
- // $err->add($i18n->getKey('error.overlap'));
- return false;
- }
-
- $mdb2 = getConnection();
- $duration = $fields['duration'];
- $tt_log_id = $fields['tt_log_id'];
- $user_id = $user->getActiveUser();
- $sql = "update tt_log set duration = '$duration' where id = $tt_log_id and user_id = $user_id";
- $affected = $mdb2->exec($sql);
- if (is_a($affected, 'PEAR_Error'))
- return false;
-
- return true;
- }