//
// Description of $dataArray format that the function returns.
// $dataArray = array(
- // array( // Row 0.
- // 'row_id' => 'cl:546,bl:1,pr:23456,ts:27464,cf_1:7623_0', // Row identifier. See ttTimeHelper::makeRecordIdentifier().
- // 'label' => 'Anuko - Time Tracker - Coding', // Human readable label for the row describing what this time entry is for.
- // 'day_0' => array('control_id' => '0_day_0', 'tt_log_id' => 12345, 'duration' => '00:00'), // control_id is row_id plus day header for column.
- // 'day_1' => array('control_id' => '0_day_1', 'tt_log_id' => 12346, 'duration' => '01:00'),
- // 'day_2' => array('control_id' => '0_day_2', 'tt_log_id' => 12347, 'duration' => '02:00'),
+ // 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.
+ // '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_3' => array('control_id' => '0_day_3', 'tt_log_id' => null, 'duration' => null),
- // 'day_4' => array('control_id' => '0_day_4', 'tt_log_id' => 12348, 'duration' => '04:00'),
- // 'day_5' => array('control_id' => '0_day_5', 'tt_log_id' => 12349, 'duration' => '04:00'),
+ // 'day_4' => array('control_id' => '0_day_4', 'tt_log_id' => null, 'duration' => null),
+ // 'day_5' => array('control_id' => '0_day_5', 'tt_log_id' => null, 'duration' => null),
// 'day_6' => array('control_id' => '0_day_6', 'tt_log_id' => null, 'duration' => null)
// ),
// array( // Row 1.
+ // 'row_id' => 'cl:546,bl:1,pr:23456,ts:27464,cf_1:7623_0', // Row identifier. See ttTimeHelper::makeRecordIdentifier().
+ // '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' => '1_day_0', 'tt_log_id' => null, 'duration' => null),
- // 'day_1' => array('control_id' => '1_day_1', 'tt_log_id' => 12350, 'duration' => '01:30'),
- // 'day_2' => array('control_id' => '1_day_2', 'tt_log_id' => null, 'duration' => null),
- // 'day_3' => array('control_id' => '1_day_3', 'tt_log_id' => 12351,'duration' => '02:30'),
- // 'day_4' => array('control_id' => '1_day_4', 'tt_log_id' => 12352, 'duration' => '04:00'),
- // 'day_5' => array('control_id' => '1_day_5', 'tt_log_id' => null, 'duration' => null),
- // 'day_6' => array('control_id' => '1_day_6', 'tt_log_id' => null, 'duration' => null)
+ // '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),
+ // 'day_6' => array('control_id' => '2_day_6', 'tt_log_id' => null, 'duration' => null)
// )
// );
static function getDataForWeekView($user_id, $start_date, $end_date, $dayHeaders) {
+ global $i18n;
+
// Start by obtaining all records in interval.
$records = ttTimeHelper::getRecordsForInterval($user_id, $start_date, $end_date);
$dataArray = array();
+ // 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);
+ }
+
// Iterate through records and build $dataArray cell by cell.
foreach ($records as $record) {
// Create record id without suffix.
// Find row.
$pos = ttTimeHelper::findRow($record_id, $dataArray);
if ($pos < 0) {
- $dataArray[] = array('row_id' => $record_id,'label' => ttTimeHelper::makeRecordLabel($record)); // Insert row.
+ $dataArray[] = array('row_id' => $record_id,'label' => ttWeekViewHelper::makeRowLabel($record)); // Insert row.
$pos = ttTimeHelper::findRow($record_id, $dataArray);
// Insert empty cells with proper control ids.
for ($i = 0; $i < 7; $i++) {
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.total');
+ $dayTotals['label'] = $i18n->getKey('label.day_total');
foreach ($dataArray as $row) {
foreach($dayHeaders as $dayHeader) {
$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['client'] = ttWeekViewHelper::parseFromWeekViewRow($fields['row_id'], 'cl');
+ $fields4insert['billable'] = ttWeekViewHelper::parseFromWeekViewRow($fields['row_id'], 'bl');
+ $fields4insert['project'] = ttWeekViewHelper::parseFromWeekViewRow($fields['row_id'], 'pr');
+ $fields4insert['task'] = ttWeekViewHelper::parseFromWeekViewRow($fields['row_id'], 'ts');
+ $fields4insert['note'] = $fields['note'];
// Try to insert a record.
$id = ttTimeHelper::insert($fields4insert);
// Insert custom field if we have it.
$result = true;
- $cf_1 = ttTimeHelper::parseFromWeekViewRow($fields['row_id'], 'cf_1');
+ $cf_1 = ttWeekViewHelper::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);
projects / timetracker.git / blobdiff