Added a capability to add new records from week view.
[timetracker.git] / WEB-INF / lib / ttTimeHelper.class.php
index 81a5ccf..cf521b6 100644 (file)
@@ -587,6 +587,56 @@ class ttTimeHelper {
     return false;
   }
 
+  // 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 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 false;
+      }
+      $val = $res->fetchRow();
+      $oldDuration = $val['duration'];
+      if (!$val['start'])
+        return true; // There is no start time in the record, therefore safe to modify.
+    }
+
+    // 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;
+    }
+
+    // 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;
+    }
+
+    return true; // There are no conflicts, safe to modify.
+  }
+
   // getRecord - retrieves a time record identified by its id.
   static function getRecord($id, $user_id) {
     global $user;
@@ -744,35 +794,56 @@ class ttTimeHelper {
   //
   // 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.
@@ -1024,38 +1095,22 @@ class ttTimeHelper {
 
   // modifyFromWeekView - modifies a duration of an existing record from a week view post.
   static function modifyDurationFromWeekView($fields, $err) {
+    global $i18n;
+    global $user;
 
-    // Possible error conditions. Overlap? What else?
-
-    $err->add("Week view is work in progress. Editing records is not yet implemented. Try deleting and then inserting a record instead.");
-    return false;
-
-  // static function modifyDurationFromWeekView($tt_log_id, $new_duration, $user_id) {
-
-    // TODO: handle overlaps and potential other error conditions such as going beyond 24 hr mark. Other errors?
-    // If the entry has start time, check if new duration goes beyond the existing day.
-
-    // Future entries. Possibly do this check out of this function.
-    /*
-     *     // Prohibit creating entries in future.
-    if (defined('FUTURE_ENTRIES') && !isTrue(FUTURE_ENTRIES)) {
-      $browser_today = new DateAndTime(DB_DATEFORMAT, $request->getParameter('browser_today', null));
-      if ($selected_date->after($browser_today))
-        $err->add($i18n->getKey('error.future_date'));
-    }
-     */
-
-    /*
-     *     // Prohibit creating an overlapping record.
-    if ($err->no()) {
-      if (ttTimeHelper::overlaps($user->getActiveUser(), $cl_date, $cl_start, $cl_finish))
-        $err->add($i18n->getKey('error.overlap'));
+    // 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();
-
-    $sql = "update tt_log set duration = '$new_duration' where id = $tt_log_id and user_id = $user_id";
+    $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;