return $result;
}
- // getDataForWeekView - builds an array to render a table of durations and comments for week view.
+ // getDataForWeekView - builds an array to render a table of durations and comments for a week view.
// In 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.
+ // We identify similar 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"
// $dataArray = array(
// array( // Row 0. This is a special, one-off row for a new week entry with empty values.
// 'row_id' => null, // Row identifier. Null for a new entry.
- // 'label' => 'New entry', // Human readable label for the row describing what this time entry is for.
+ // 'label' => 'New entry:', // Human readable label for the row describing what this time entry is for.
// 'day_0' => array('control_id' => '0_day_0', 'tt_log_id' => null, 'duration' => null), // control_id is row_id plus day header for column.
// 'day_1' => array('control_id' => '0_day_1', 'tt_log_id' => null, 'duration' => null),
// 'day_2' => array('control_id' => '0_day_2', 'tt_log_id' => null, 'duration' => null),
// 'day_6' => array('control_id' => '0_day_6', 'tt_log_id' => null, 'duration' => null)
// ),
//
- // TODO: work in progress re-documenting the array for improved week view. Trying to implement this now.
// array( // Row 1. This row represents daily comments for a new entry in row above (row 0).
- // 'row_id' => null, // Row identifier. See ttWeekViewHelper::makeRowIdentifier().
- // 'label' => 'Notes', // Human readable label.
+ // 'row_id' => null,
+ // 'label' => 'Notes:',
// 'day_0' => array('control_id' => '1_day_0', 'tt_log_id' => null, 'note' => null),
// 'day_1' => array('control_id' => '1_day_1', 'tt_log_id' => null, 'note' => null),
// 'day_2' => array('control_id' => '1_day_2', 'tt_log_id' => null, 'note' => null),
// 'day_5' => array('control_id' => '1_day_5', 'tt_log_id' => null, 'note' => null),
// 'day_6' => array('control_id' => '1_day_6', 'tt_log_id' => null, 'note' => null)
// ),
- // TODO: work in progress...
//
- // array( // Row 1.
- // 'row_id' => 'cl:546,bl:1,pr:23456,ts:27464,cf_1:7623_0', // Row identifier. See ttWeekViewHelper::makeRowIdentifier().
- // 'label' => 'Anuko - Time Tracker - Coding', // Human readable label for the row describing what this time entry is for.
- // 'day_0' => array('control_id' => '1_day_0', 'tt_log_id' => 12345, 'duration' => '00:00'), // control_id is row_id plus day header for column.
- // 'day_1' => array('control_id' => '1_day_1', 'tt_log_id' => 12346, 'duration' => '01:00'),
- // 'day_2' => array('control_id' => '1_day_2', 'tt_log_id' => 12347, 'duration' => '02:00'),
- // 'day_3' => array('control_id' => '1_day_3', 'tt_log_id' => null, 'duration' => null),
- // 'day_4' => array('control_id' => '1_day_4', 'tt_log_id' => 12348, 'duration' => '04:00'),
- // 'day_5' => array('control_id' => '1_day_5', 'tt_log_id' => 12349, 'duration' => '04:00'),
- // 'day_6' => array('control_id' => '1_day_6', 'tt_log_id' => null, 'duration' => null)
- // ),
// array( // Row 2.
- // 'row_id' => 'bl:0_0',
- // 'label' => '', // In this case the label is empty as we don't have anything to put into it, as we only have billable flag.
- // 'day_0' => array('control_id' => '2_day_0', 'tt_log_id' => null, 'duration' => null),
- // 'day_1' => array('control_id' => '2_day_1', 'tt_log_id' => 12350, 'duration' => '01:30'),
- // 'day_2' => array('control_id' => '2_day_2', 'tt_log_id' => null, 'duration' => null),
- // 'day_3' => array('control_id' => '2_day_3', 'tt_log_id' => 12351,'duration' => '02:30'),
- // 'day_4' => array('control_id' => '2_day_4', 'tt_log_id' => 12352, 'duration' => '04:00'),
- // 'day_5' => array('control_id' => '2_day_5', 'tt_log_id' => null, 'duration' => null),
+ // 'row_id' => 'cl:546,bl:1,pr:23456,ts:27464,cf_1:7623_0',
+ // 'label' => 'Anuko - Time Tracker - Coding - Option 2',
+ // 'day_0' => array('control_id' => '2_day_0', 'tt_log_id' => 12345, 'duration' => '00:00'),
+ // 'day_1' => array('control_id' => '2_day_1', 'tt_log_id' => 12346, 'duration' => '01:00'),
+ // 'day_2' => array('control_id' => '2_day_2', 'tt_log_id' => 12347, 'duration' => '02:00'),
+ // 'day_3' => array('control_id' => '2_day_3', 'tt_log_id' => null, 'duration' => null),
+ // 'day_4' => array('control_id' => '2_day_4', 'tt_log_id' => 12348, 'duration' => '04:00'),
+ // 'day_5' => array('control_id' => '2_day_5', 'tt_log_id' => 12349, 'duration' => '04:00'),
// 'day_6' => array('control_id' => '2_day_6', 'tt_log_id' => null, 'duration' => null)
+ // ),
+ // array( // Row 3.
+ // 'row_id' => 'cl:546,bl:1,pr:23456,ts:27464,cf_1:7623_0_notes',
+ // 'label' => 'Notes:',
+ // 'day_0' => array('control_id' => '3_day_0', 'tt_log_id' => 12345, 'note' => 'Comment one'),
+ // 'day_1' => array('control_id' => '3_day_1', 'tt_log_id' => 12346, 'note' => 'Comment two'),
+ // 'day_2' => array('control_id' => '3_day_2', 'tt_log_id' => 12347, 'note' => 'Comment three'),
+ // 'day_3' => array('control_id' => '3_day_3', 'tt_log_id' => null, 'note' => null),
+ // 'day_4' => array('control_id' => '3_day_4', 'tt_log_id' => 12348, 'note' => 'Comment four'),
+ // 'day_5' => array('control_id' => '3_day_5', 'tt_log_id' => 12349, 'note' => 'Comment five'),
+ // 'day_6' => array('control_id' => '3_day_6', 'tt_log_id' => null, 'note' => null)
// )
// );
static function getDataForWeekView($records, $dayHeaders) {
+ global $user;
global $i18n;
$dataArray = array();
$control_id = '0_'. $dayHeaders[$i];
$dataArray[0][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'duration' => null);
}
- // Construct the second row for daily comments for a brand new entry.
- $dataArray[] = array('row_id' => null,'label' => $i18n->getKey('label.notes').':'); // Insert row.
- // Insert empty cells with proper control ids.
- for ($i = 0; $i < 7; $i++) {
- $control_id = '1_'. $dayHeaders[$i];
- $dataArray[1][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'note' => null);
+ if ($user->isPluginEnabled('wvns')) {
+ // Construct the second row for daily comments for a brand new entry.
+ $dataArray[] = array('row_id' => null,'label' => $i18n->getKey('label.notes').':'); // Insert row.
+ // Insert empty cells with proper control ids.
+ for ($i = 0; $i < 7; $i++) {
+ $control_id = '1_'. $dayHeaders[$i];
+ $dataArray[1][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'note' => null);
+ }
}
// Iterate through records and build $dataArray cell by cell.
}
// Find row.
$pos = ttWeekViewHelper::findRow($row_id, $dataArray);
+ if ($pos < 0) {
+ // Insert row for durations.
+ $dataArray[] = array('row_id' => $row_id,'label' => ttWeekViewHelper::makeRowLabel($record));
+ $pos = ttWeekViewHelper::findRow($row_id, $dataArray);
+ // Insert empty cells with proper control ids.
+ for ($i = 0; $i < 7; $i++) {
+ $control_id = $pos.'_'. $dayHeaders[$i];
+ $dataArray[$pos][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'duration' => null);
+ }
+ // Insert row for comments.
+ if ($user->isPluginEnabled('wvns')) {
+ $dataArray[] = array('row_id' => $row_id.'_notes','label' => $i18n->getKey('label.notes').':');
+ $pos++;
+ // Insert empty cells with proper control ids.
+ for ($i = 0; $i < 7; $i++) {
+ $control_id = $pos.'_'. $dayHeaders[$i];
+ $dataArray[$pos][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'note' => null);
+ }
+ $pos--;
+ }
+ }
+ // Insert actual cell data from $record (one cell only).
+ $dataArray[$pos][$day_header] = array('control_id' => $pos.'_'. $day_header, 'tt_log_id' => $record['id'],'duration' => $record['duration']);
+ // Insert existing comment from $record into the comment cell.
+ if ($user->isPluginEnabled('wvns')) {
+ $pos++;
+ $dataArray[$pos][$day_header] = array('control_id' => $pos.'_'. $day_header, 'tt_log_id' => $record['id'],'note' => $record['comment']);
+ }
+ }
+ return $dataArray;
+ }
+
+ // prePopulateFromPastWeeks - is a complementary function to getDataForWeekView.
+ // It builds an "empty" $dataArray with only labels present. Labels are taken from
+ // the most recent active past week, up to 5 weeks back from now.
+ // This is a data entry acceleration feature to help users quickly populate their
+ // regular entry list for a new week, even after a long vacation.
+ static function prePopulateFromPastWeeks($startDate, $dayHeaders) {
+ global $user;
+ global $i18n;
+
+ // First, determine past week start and end dates.
+ $objDate = new DateAndTime(DB_DATEFORMAT, $startDate);
+ $objDate->decDay(7);
+ $pastWeekStartDate = $objDate->toString(DB_DATEFORMAT);
+ $objDate->incDay(6);
+ $pastWeekEndDate = $objDate->toString(DB_DATEFORMAT);
+ unset($objDate);
+
+ // Obtain past week(s) records.
+ $records = ttWeekViewHelper::getRecordsForInterval($user->getActiveUser(), $pastWeekStartDate, $pastWeekEndDate);
+ // Handle potential situation of no records by re-trying for up to 4 more previous weeks (after a long vacation, etc.).
+ if (!$records) {
+ for ($i = 0; $i < 4; $i++) {
+ $objDate = new DateAndTime(DB_DATEFORMAT, $pastWeekStartDate);
+ $objDate->decDay(7);
+ $pastWeekStartDate = $objDate->toString(DB_DATEFORMAT);
+ $objDate->incDay(6);
+ $pastWeekEndDate = $objDate->toString(DB_DATEFORMAT);
+ unset($objDate);
+
+ $records = ttWeekViewHelper::getRecordsForInterval($user->getActiveUser(), $pastWeekStartDate, $pastWeekEndDate);
+ // Break out of the loop if we found something.
+ if ($records) break;
+ }
+ }
+
+ // Construct the first row for a brand new entry.
+ $dataArray[] = array('row_id' => null,'label' => $i18n->getKey('form.week.new_entry').':'); // Insert row.
+ // Insert empty cells with proper control ids.
+ for ($i = 0; $i < 7; $i++) {
+ $control_id = '0_'. $dayHeaders[$i];
+ $dataArray[0][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'duration' => null);
+ }
+ // Construct the second row for daily comments for a brand new entry.
+ $dataArray[] = array('row_id' => null,'label' => $i18n->getKey('label.notes').':'); // Insert row.
+ // Insert empty cells with proper control ids.
+ for ($i = 0; $i < 7; $i++) {
+ $control_id = '1_'. $dayHeaders[$i];
+ $dataArray[1][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'note' => null);
+ }
+
+ // Iterate through records and build an "empty" $dataArray.
+ foreach ($records as $record) {
+ // Create row id with 0 suffix. In prepopulated view, we only need one row for similar records.
+ $row_id = ttWeekViewHelper::makeRowIdentifier($record).'_0';
+ // Find row.
+ $pos = ttWeekViewHelper::findRow($row_id, $dataArray);
if ($pos < 0) {
// Insert row for durations.
$dataArray[] = array('row_id' => $row_id,'label' => ttWeekViewHelper::makeRowLabel($record));
}
$pos--;
}
- // Insert actual cell data from $record (one cell only).
- $dataArray[$pos][$day_header] = array('control_id' => $pos.'_'. $day_header, 'tt_log_id' => $record['id'],'duration' => $record['duration']);
- // Insert existing comment from $record into the duration cell.
- $pos++;
- $dataArray[$pos][$day_header] = array('control_id' => $pos.'_'. $day_header, 'tt_log_id' => $record['id'],'note' => $record['comment']);
}
+
return $dataArray;
}
projects / timetracker.git / blobdiff