Made week view controls read-only for locked days.
[timetracker.git] / week.php
index dea27e3..8d3e2ba 100644 (file)
--- a/week.php
+++ b/week.php
@@ -28,6 +28,8 @@
 
 require_once('initialize.php');
 import('form.Form');
+import('form.DefaultCellRenderer');
+import('form.Table');
 import('ttUserHelper');
 import('ttTeamHelper');
 import('ttClientHelper');
@@ -40,7 +42,6 @@ if (!ttAccessCheck(right_data_entry)) {
   exit();
 }
 
-// TODO: redo this block to use week start date instead.
 // Initialize and store date in session.
 $cl_date = $request->getParameter('date', @$_SESSION['date']);
 $selected_date = new DateAndTime(DB_DATEFORMAT, $cl_date);
@@ -50,6 +51,20 @@ if(!$cl_date)
   $cl_date = $selected_date->toString(DB_DATEFORMAT);
 $_SESSION['date'] = $cl_date;
 
+// Determine selected week start and end dates.
+$weekStartDay = $user->week_start;
+$t_arr = localtime($selected_date->getTimestamp());
+$t_arr[5] = $t_arr[5] + 1900;
+if ($t_arr[6] < $weekStartDay)
+  $startWeekBias = $weekStartDay - 7;
+else
+  $startWeekBias = $weekStartDay;
+$startDate = new DateAndTime();
+$startDate->setTimestamp(mktime(0,0,0,$t_arr[4]+1,$t_arr[3]-$t_arr[6]+$startWeekBias,$t_arr[5]));
+$endDate = new DateAndTime();
+$endDate->setTimestamp(mktime(0,0,0,$t_arr[4]+1,$t_arr[3]-$t_arr[6]+6+$startWeekBias,$t_arr[5]));
+// The above is needed to set date range (timestring) in page title.
+
 // Use custom fields plugin if it is enabled.
 if ($user->isPluginEnabled('cf')) {
   require_once('plugins/CustomFields.class.php');
@@ -71,10 +86,6 @@ if ($user->isPluginEnabled('mq')){
 }
 
 // Initialize variables.
-$cl_start = trim($request->getParameter('start'));
-$cl_finish = trim($request->getParameter('finish'));
-$cl_duration = trim($request->getParameter('duration'));
-$cl_note = trim($request->getParameter('note'));
 // Custom field.
 $cl_cf_1 = trim($request->getParameter('cf_1', ($request->getMethod()=='POST'? null : @$_SESSION['cf_1'])));
 $_SESSION['cf_1'] = $cl_cf_1;
@@ -95,8 +106,53 @@ $_SESSION['project'] = $cl_project;
 $cl_task = $request->getParameter('task', ($request->getMethod()=='POST'? null : @$_SESSION['task']));
 $_SESSION['task'] = $cl_task;
 
-// Elements of timeRecordForm.
-$form = new Form('timeRecordForm');
+// Get the data we need to display week view.
+// Get column headers, which are day numbers in month.
+$dayHeaders = ttTimeHelper::getDayHeadersForWeek($startDate->toString(DB_DATEFORMAT));
+$lockedDays = ttTimeHelper::getLockedDaysForWeek($startDate->toString(DB_DATEFORMAT));
+// Build data array for the table. Format is described in the function..
+$dataArray = ttTimeHelper::getDataForWeekView($user->getActiveUser(), $startDate->toString(DB_DATEFORMAT), $endDate->toString(DB_DATEFORMAT), $dayHeaders);
+// Build day totals (total durations for each day in week).
+$dayTotals = ttTimeHelper::getDayTotals($dataArray, $dayHeaders);
+
+// TODO: refactoring ongoing down from here.
+
+// 1) Handle editable - not editable records properly meaning that UI should reflect this.
+// 2) Start coding modification of existing records.
+// 3) Then adding new records for existing rows.
+// 4) Then add code and UI for adding a new row.
+
+// Actually this is work in progress at this point, even documenting the array, as we still miss control IDs, and
+// editing entries is not yet implemented. When this is done, we will have to re-document the above.
+
+// Define rendering class for a label field to the left of durations.
+class LabelCellRenderer extends DefaultCellRenderer {
+  function render(&$table, $value, $row, $column, $selected = false) {
+    $this->setOptions(array('width'=>200,'valign'=>'middle'));
+    $this->setValue(htmlspecialchars($value)); // This escapes HTML for output.
+    return $this->toString();
+  }
+}
+
+// Define rendering class for a single cell for time entry in week view table.
+class TimeCellRenderer extends DefaultCellRenderer {
+  function render(&$table, $value, $row, $column, $selected = false) {
+    $field_name = $table->getValueAt($row,$column)['control_id']; // Our text field names (and ids) are like x_y (row_column).
+    $field = new TextField($field_name);
+    // Disable control if the date is locked.
+    global $lockedDays;
+    if ($lockedDays[$column-1])
+      $field->setEnabled(false);
+    $field->setFormName($table->getFormName());
+    $field->setSize(2);
+    $field->setValue($table->getValueAt($row,$column)['duration']);
+    $this->setValue($field->getHtml());
+    return $this->toString();
+  }
+}
+
+// Elements of weekTimeForm.
+$form = new Form('weekTimeForm');
 
 if ($user->canManageTeam()) {
   $user_list = ttTeamHelper::getActiveUsers(array('putSelfFirst'=>true));
@@ -112,6 +168,20 @@ if ($user->canManageTeam()) {
   }
 }
 
+// Create week_durations table.
+$table = new Table('week_durations');
+// $table->setIAScript('markModified'); // TODO: write a script to mark table or particular cells as modified.
+$table->setTableOptions(array('width'=>'100%','cellspacing'=>'1','cellpadding'=>'3','border'=>'0'));
+$table->setRowOptions(array('class'=>'tableHeaderCentered'));
+$table->setData($dataArray);
+// Add columns to table.
+$table->addColumn(new TableColumn('label', '', new LabelCellRenderer(), $dayTotals['label']));
+for ($i = 0; $i < 7; $i++) {
+  $table->addColumn(new TableColumn($dayHeaders[$i], $dayHeaders[$i], new TimeCellRenderer(), $dayTotals[$dayHeaders[$i]]));
+}
+$table->setInteractive(false);
+$form->addInputElement($table);
+
 // Dropdown for clients in MODE_TIME. Use all active clients.
 if (MODE_TIME == $user->tracking_mode && $user->isPluginEnabled('cl')) {
   $active_clients = ttTeamHelper::getActiveClients($user->team_id, true);
@@ -352,24 +422,9 @@ if ($request->isPost()) {
 
 $week_total = ttTimeHelper::getTimeForWeek($user->getActiveUser(), $selected_date);
 
-// Determine selected week start and end dates.
-$weekStartDay = $user->week_start;
-$t_arr = localtime($selected_date->getTimestamp());
-$t_arr[5] = $t_arr[5] + 1900;
-if ($t_arr[6] < $weekStartDay)
-  $startWeekBias = $weekStartDay - 7;
-else
-  $startWeekBias = $weekStartDay;
-$startDate = new DateAndTime();
-$startDate->setTimestamp(mktime(0,0,0,$t_arr[4]+1,$t_arr[3]-$t_arr[6]+$startWeekBias,$t_arr[5]));
-$endDate = new DateAndTime();
-$endDate->setTimestamp(mktime(0,0,0,$t_arr[4]+1,$t_arr[3]-$t_arr[6]+6+$startWeekBias,$t_arr[5]));
-// The above is needed to set date range (timestring) in page title. Consider refactoring, possibly moving into a function.
-
 $smarty->assign('selected_date', $selected_date);
 $smarty->assign('week_total', $week_total);
-$smarty->assign('day_total', ttTimeHelper::getTimeForDay($user->getActiveUser(), $cl_date));
-$smarty->assign('grouped_records', ttTimeHelper::getGroupedRecordsForInterval($user->getActiveUser(), $startDate->toString(DB_DATEFORMAT), $endDate->toString(DB_DATEFORMAT)));
+
 $smarty->assign('client_list', $client_list);
 $smarty->assign('project_list', $project_list);
 $smarty->assign('task_list', $task_list);
@@ -377,21 +432,6 @@ $smarty->assign('forms', array($form->getName()=>$form->toArray()));
 $smarty->assign('onload', 'onLoad="fillDropdowns()"');
 $smarty->assign('timestring', $startDate->toString($user->date_format).' - '.$endDate->toString($user->date_format));
 
-// Prepare and assign date headers. Note how startDate moves to the end of the week, so it no longer holds correct start week value.
-$smarty->assign('day_header_0', $startDate->toString($user->date_format));
-$startDate->incDay();
-$smarty->assign('day_header_1', $startDate->toString($user->date_format));
-$startDate->incDay();
-$smarty->assign('day_header_2', $startDate->toString($user->date_format));
-$startDate->incDay();
-$smarty->assign('day_header_3', $startDate->toString($user->date_format));
-$startDate->incDay();
-$smarty->assign('day_header_4', $startDate->toString($user->date_format));
-$startDate->incDay();
-$smarty->assign('day_header_5', $startDate->toString($user->date_format));
-$startDate->incDay();
-$smarty->assign('day_header_6', $startDate->toString($user->date_format));
-
 $smarty->assign('title', $i18n->getKey('title.time'));
 $smarty->assign('content_page_name', 'week.tpl');
 $smarty->display('index.tpl');