X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=WEB-INF%2Flib%2FttWeekViewHelper.class.php;h=782f309b477304b44e13c3fb1c8ae552889a9d2a;hb=3b3e56c2f4e2a9624f0e25b1d5b0892a421a00bd;hp=5c03a373ac0bb66c974e3f4e4e7ab8af26d177b9;hpb=85910e4038e5f54d82a29ceafc32b8e14e18628e;p=timetracker.git

diff --git a/WEB-INF/lib/ttWeekViewHelper.class.php b/WEB-INF/lib/ttWeekViewHelper.class.php
index 5c03a373..782f309b 100644
--- a/WEB-INF/lib/ttWeekViewHelper.class.php
+++ b/WEB-INF/lib/ttWeekViewHelper.class.php
@@ -45,7 +45,7 @@ class ttWeekViewHelper {
 
     $custom_field_1 = null;
     if ($user->isPluginEnabled('cf')) {
-      $custom_fields = new CustomFields($user->team_id);
+      $custom_fields = new CustomFields();
       $cf_1_type = $custom_fields->fields[0]['type'];
       if ($cf_1_type == CustomFields::TYPE_TEXT) {
         $custom_field_1 = ', cfl.value as cf_1_value';
@@ -85,9 +85,9 @@ class ttWeekViewHelper {
     return $result;
   }
 
-  // getDataForWeekView - builds an array to render a table of durations 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"
@@ -96,11 +96,15 @@ class ttWeekViewHelper {
   // "cl:546,bl:0,pr:23456,ts:27464,cf_1:7623"
   // The above means client 546, not billable, project 23456, task 27464, custom field option id 7623.
   //
+  // Daily comments are implemented as alternate rows following week durations.
+  // For example: row_0 - new entry durations, row_1 - new entry daily comments,
+  //              row_2 - existing entry durations, row_3 - existing entry comments, etc.
+  //
   // Description of $dataArray format that the function returns.
   // $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.
+  //     '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),
@@ -109,45 +113,68 @@ class ttWeekViewHelper {
   //     '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 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 1. This row represents daily comments for a new entry in row above (row 0).
+  //     '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_3' => array('control_id' => '1_day_3', 'tt_log_id' => null, 'note' => null),
+  //     'day_4' => array('control_id' => '1_day_4', '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)
   //   ),
+  //
   //   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();
 
     // Construct the first row for a brand new entry.
-    $dataArray[] = array('row_id' => null,'label' => $i18n->getKey('form.week.new_entry')); // Insert row.
+    $dataArray[] = array('row_id' => null,'label' => $i18n->get('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);
     }
+    if ($user->isPluginEnabled('wvns')) {
+      // Construct the second row for daily comments for a brand new entry.
+      $dataArray[] = array('row_id' => null,'label' => $i18n->get('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.
     foreach ($records as $record) {
-      // Create record id without suffix.
+      // Create row id without suffix.
       $row_id_no_suffix = ttWeekViewHelper::makeRowIdentifier($record);
       // Handle potential multiple records with the same attributes by using a numerical suffix.
       $suffix = 0;
@@ -160,20 +187,117 @@ class ttWeekViewHelper {
       // Find row.
       $pos = ttWeekViewHelper::findRow($row_id, $dataArray);
       if ($pos < 0) {
-        $dataArray[] = array('row_id' => $row_id,'label' => ttWeekViewHelper::makeRowLabel($record)); // Insert row.
+        // 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->get('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->getUser(), $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->getUser(), $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->get('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->get('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 = 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.
+        $dataArray[] = array('row_id' => $row_id.'_notes','label' => $i18n->get('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--;
+      }
+    }
+
+    return $dataArray;
+  }
+
   // cellExists is a helper function for getDataForWeekView() to see if a cell with a given label
   // and a day header already exists.
   static function cellExists($row_id, $day_header, $dataArray) {
@@ -201,7 +325,7 @@ class ttWeekViewHelper {
 
     // Insert label.
     global $i18n;
-    $dayTotals['label'] = $i18n->getKey('label.day_total');
+    $dayTotals['label'] = $i18n->get('label.day_total').':';
 
     foreach ($dataArray as $row) {
       foreach($dayHeaders as $dayHeader) {
@@ -358,17 +482,19 @@ class ttWeekViewHelper {
     $objEntryDate = new DateAndTime(DB_DATEFORMAT, $entry_date);
 
     // Prohibit creating entries in future.
-    if (defined('FUTURE_ENTRIES') && !isTrue(FUTURE_ENTRIES) && $fields['browser_today']) {
+    if (!$user->future_entries && $fields['browser_today']) {
       $objBrowserToday = new DateAndTime(DB_DATEFORMAT, $fields['browser_today']);
       if ($objEntryDate->after($objBrowserToday)) {
-        $err->add($i18n->getKey('error.future_date'));
+        $err->add($i18n->get('error.future_date'));
         return false;
       }
     }
 
     // Prepare an array of fields for regular insert function.
     $fields4insert = array();
-    $fields4insert['user_id'] = $user->getActiveUser();
+    $fields4insert['user_id'] = $user->getUser();
+    $fields4insert['group_id'] = $user->getGroup();
+    $fields4insert['org_id'] = $user->org_id;
     $fields4insert['date'] = $entry_date;
     $fields4insert['duration'] = $fields['duration'];
     $fields4insert['client'] = ttWeekViewHelper::parseFromWeekViewRow($fields['row_id'], 'cl');
@@ -400,17 +526,13 @@ class ttWeekViewHelper {
     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 (!ttWeekViewHelper::canModify($fields['tt_log_id'], $fields['duration'], $err)) {
-      // $err->add($i18n->getKey('error.overlap'));
+    if (!ttWeekViewHelper::canModify($fields['tt_log_id'], $fields['duration'], $err))
       return false;
-    }
 
     $mdb2 = getConnection();
     $duration = $fields['duration'];
     $tt_log_id = $fields['tt_log_id'];
-    $user_id = $user->getActiveUser();
+    $user_id = $user->getUser();
     $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'))
@@ -430,7 +552,7 @@ class ttWeekViewHelper {
     $res = $mdb2->query($sql);
     if (!is_a($res, 'PEAR_Error')) {
       if (!$res->numRows()) {
-        $err->add($i18n->getKey('error.db')); // This is not expected.
+        $err->add($i18n->get('error.db')); // This is not expected.
         return false;
       }
       $val = $res->fetchRow();
@@ -451,7 +573,7 @@ class ttWeekViewHelper {
     $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'));
+      $err->add($i18n->get('error.field'), $i18n->get('label.duration'));
       return false;
     }
 
@@ -462,10 +584,26 @@ class ttWeekViewHelper {
     $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'));
+      $err->add($i18n->get('error.overlap'));
       return false;
     }
 
     return true; // There are no conflicts, safe to modify.
   }
+
+  // modifyCommentFromWeekView - modifies a comment in an existing record from a week view post.
+  static function modifyCommentFromWeekView($fields) {
+    global $user;
+
+    $mdb2 = getConnection();
+    $tt_log_id = $fields['tt_log_id'];
+    $comment = $fields['comment'];
+    $user_id = $user->getUser();
+    $sql = "update tt_log set comment = ".$mdb2->quote($fields['comment'])." where id = $tt_log_id and user_id = $user_id";
+    $affected = $mdb2->exec($sql);
+    if (is_a($affected, 'PEAR_Error'))
+      return false;
+
+    return true;
+  }
 }