return false;
}
- // ovelapsWithNewDuration - determines if an already existing tt_log record will overlap others
- // if we were to change its duration to a new value.
- //
- // Another error condition we check for is whether new duration puts the existing record beyond the 24:00 day boundary.
- static function ovelapsWithNewDuration($tt_log_id, $new_duration, $err) {
+ // wvCanModify (weekViewCanModify) - determines if an already existing tt_log record
+ // can be modified with a new user-provided duration.
+ static function wvCanModify($tt_log_id, $new_duration, $err) {
global $i18n;
$mdb2 = getConnection();
- // Determine if we have start time in record, as checking does not makes sense otherwise.
- $sql = "select start from tt_log where id = $tt_log_id";
+ // Determine if we have start time in record, as further checking does not makes sense otherwise.
+ $sql = "select user_id, date, start, duration from tt_log where id = $tt_log_id";
$res = $mdb2->query($sql);
if (!is_a($res, 'PEAR_Error')) {
if (!$res->numRows()) {
$err->add($i18n->getKey('error.db')); // This is not expected.
- return true;
+ return false;
}
$val = $res->fetchRow();
+ $oldDuration = $val['duration'];
if (!$val['start'])
- return false; // No start time, therefore no overlap.
+ return true; // There is no start time in the record, therefore safe to modify.
}
- // TODO: Determine finish based on the existing record start and $new_duration.
- // By probably using PHP time functions or toMinutes().
-
- // Then check whether new duration puts the existing records beyond 24:00 boundary.
- // and call the existing overlaps function.
+ // We do have start time.
+ // Quick test if new duration is less then already existing.
+ $newMinutes = ttTimeHelper::toMinutes($new_duration);
+ $oldMinutes = ttTimeHelper::toMinutes($oldDuration);
+ if ($newMinutes < $oldMinutes)
+ return true; // Safe to modify.
+
+ // Does the new duration put the record beyond 24:00 boundary?
+ $startMinutes = ttTimeHelper::toMinutes($val['start']);
+ $newEndMinutes = $startMinutes + $newMinutes;
+ if ($newEndMinutes > 1440) {
+ // Invalid duration, as new duration puts the record beyond current day.
+ $err->add($i18n->getKey('error.field'), $i18n->getKey('label.duration'));
+ return false;
+ }
- // For now return an error, until we implement the above.
+ // Does the new duration causes the record to overlap with others?
+ $user_id = $val['user_id'];
+ $date = $val['date'];
+ $startMinutes = ttTimeHelper::toMinutes($val['start']);
+ $start = ttTimeHelper::toAbsDuration($startMinutes);
+ $finish = ttTimeHelper::toAbsDuration($newEndMinutes);
+ if (ttTimeHelper::overlaps($user_id, $date, $start, $finish, $tt_log_id)) {
+ $err->add($i18n->getKey('error.overlap'));
+ return false;
+ }
- $err->add("Week view is work in progress. Editing records with existing start times is currently not supported in week view. Try day view instead.");
- return true;
+ return true; // There are no conflicts, safe to modify.
}
// getRecord - retrieves a time record identified by its id.
//
// 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.
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.
// 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);
// 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::ovelapsWithNewDuration($fields['tt_log_id'], $fields['duration'], $err)) {
+ if (!ttTimeHelper::wvCanModify($fields['tt_log_id'], $fields['duration'], $err)) {
// $err->add($i18n->getKey('error.overlap'));
return false;
}
projects / timetracker.git / blobdiff