A bit more refactoring in reports.

diff --git a/WEB-INF/lib/ttReportHelper.class.php b/WEB-INF/lib/ttReportHelper.class.php
index 4da47ec07e285f872fa0867fc2385cc8cb282313..e0993525cea5dd3e876bbf70a3bb141abcf62dc1 100644 (file)
--- a/WEB-INF/lib/ttReportHelper.class.php
+++ b/WEB-INF/lib/ttReportHelper.class.php
@@ -37,13 +37,14 @@ require_once(dirname(__FILE__).'/../../plugins/CustomFields.class.php');
 class ttReportHelper {
 
   // getWhere prepares a WHERE clause for a report query.
 class ttReportHelper {
 
   // getWhere prepares a WHERE clause for a report query.

-  static function getWhere($bean) {
+  // Note: $options is a future replacement of $bean, which is work in progress.
+  static function getWhere($bean, $options) {

     global $user;
 
     // Prepare dropdown parts.
     $dropdown_parts = '';
     global $user;
 
     // Prepare dropdown parts.
     $dropdown_parts = '';

-    if ($bean->getAttribute('client'))
-      $dropdown_parts .= ' and l.client_id = '.$bean->getAttribute('client');
+    if ($options['client_id'])
+      $dropdown_parts .= ' and l.client_id = '.$options['client_id'];

     elseif ($user->isClient() && $user->client_id)
       $dropdown_parts .= ' and l.client_id = '.$user->client_id;
     if ($bean->getAttribute('option')) $dropdown_parts .= ' and l.id in(select log_id from tt_custom_field_log where status = 1 and option_id = '.$bean->getAttribute('option').')';
     elseif ($user->isClient() && $user->client_id)
       $dropdown_parts .= ' and l.client_id = '.$user->client_id;
     if ($bean->getAttribute('option')) $dropdown_parts .= ' and l.id in(select log_id from tt_custom_field_log where status = 1 and option_id = '.$bean->getAttribute('option').')';


@@ -135,13 +136,13 @@ class ttReportHelper {
   }
 
   // getExpenseWhere prepares WHERE clause for expenses query in a report.
   }
 
   // getExpenseWhere prepares WHERE clause for expenses query in a report.

-  static function getExpenseWhere($bean) {
+  static function getExpenseWhere($bean, $options) {

     global $user;
 
     // Prepare dropdown parts.
     $dropdown_parts = '';
     global $user;
 
     // Prepare dropdown parts.
     $dropdown_parts = '';

-    if ($bean->getAttribute('client'))
-      $dropdown_parts .= ' and ei.client_id = '.$bean->getAttribute('client');
+    if ($options['client_id'])
+      $dropdown_parts .= ' and l.client_id = '.$options['client_id'];

     elseif ($user->isClient() && $user->client_id)
       $dropdown_parts .= ' and ei.client_id = '.$user->client_id;
     if ($bean->getAttribute('project')) $dropdown_parts .= ' and ei.project_id = '.$bean->getAttribute('project');
     elseif ($user->isClient() && $user->client_id)
       $dropdown_parts .= ' and ei.client_id = '.$user->client_id;
     if ($bean->getAttribute('project')) $dropdown_parts .= ' and ei.project_id = '.$bean->getAttribute('project');


@@ -227,7 +228,7 @@ class ttReportHelper {
   // getItems retrieves all items associated with a report.
   // It combines tt_log and tt_expense_items in one array for presentation in one table using mysql union all.
   // Expense items use the "note" field for item name.
   // getItems retrieves all items associated with a report.
   // It combines tt_log and tt_expense_items in one array for presentation in one table using mysql union all.
   // Expense items use the "note" field for item name.

-  static function getItems($bean) {
+  static function getItems($bean, $options) {

     global $user;
     $mdb2 = getConnection();
 
     global $user;
     $mdb2 = getConnection();
 


@@ -333,7 +334,7 @@ class ttReportHelper {
     if ($includeCost && MODE_TIME != $user->tracking_mode)
       $left_joins .= " left join tt_user_project_binds upb on (l.user_id = upb.user_id and l.project_id = upb.project_id)";
 
     if ($includeCost && MODE_TIME != $user->tracking_mode)
       $left_joins .= " left join tt_user_project_binds upb on (l.user_id = upb.user_id and l.project_id = upb.project_id)";
 

-    $where = ttReportHelper::getWhere($bean);
+    $where = ttReportHelper::getWhere($bean, $options);

 
     // Construct sql query for tt_log items.
     $sql = "select ".join(', ', $fields)." from tt_log l $left_joins $where";
 
     // Construct sql query for tt_log items.
     $sql = "select ".join(', ', $fields)." from tt_log l $left_joins $where";


@@ -401,7 +402,7 @@ class ttReportHelper {
       if (($canViewReports || $isClient) && $bean->getAttribute('chinvoice'))
         $left_joins .= " left join tt_invoices i on (i.id = ei.invoice_id and i.status = 1)";
 
       if (($canViewReports || $isClient) && $bean->getAttribute('chinvoice'))
         $left_joins .= " left join tt_invoices i on (i.id = ei.invoice_id and i.status = 1)";
 

-      $where = ttReportHelper::getExpenseWhere($bean);
+      $where = ttReportHelper::getExpenseWhere($bean, $options);

 
       // Construct sql query for expense items.
       $sql_for_expense_items = "select ".join(', ', $fields)." from tt_expense_items ei $left_joins $where";
 
       // Construct sql query for expense items.
       $sql_for_expense_items = "select ".join(', ', $fields)." from tt_expense_items ei $left_joins $where";


@@ -742,7 +743,7 @@ class ttReportHelper {
   // getSubtotals calculates report items subtotals when a report is grouped by.
   // Without expenses, it's a simple select with group by.
   // With expenses, it becomes a select with group by from a combined set of records obtained with "union all".
   // getSubtotals calculates report items subtotals when a report is grouped by.
   // Without expenses, it's a simple select with group by.
   // With expenses, it becomes a select with group by from a combined set of records obtained with "union all".

-  static function getSubtotals($bean) {
+  static function getSubtotals($bean, $options) {

     global $user;
 
     $group_by_option = $bean->getAttribute('group_by');
     global $user;
 
     $group_by_option = $bean->getAttribute('group_by');


@@ -784,7 +785,7 @@ class ttReportHelper {
         break;
     }
 
         break;
     }
 

-    $where = ttReportHelper::getWhere($bean);
+    $where = ttReportHelper::getWhere($bean, $options);

     if ($bean->getAttribute('chcost')) {
       if (MODE_TIME == $user->tracking_mode) {
         if ($group_by_option != 'user')
     if ($bean->getAttribute('chcost')) {
       if (MODE_TIME == $user->tracking_mode) {
         if ($group_by_option != 'user')


@@ -851,7 +852,7 @@ class ttReportHelper {
           break;
       }
 
           break;
       }
 

-      $where = ttReportHelper::getExpenseWhere($bean);
+      $where = ttReportHelper::getExpenseWhere($bean, $options);

       $sql_for_expenses = "select $group_field as group_field, null as time";
       if ($bean->getAttribute('chunits')) $sql_for_expenses .= ", null as units";
       $sql_for_expenses .= ", sum(ei.cost) as cost, sum(ei.cost) as expenses from tt_expense_items ei $group_join $where";
       $sql_for_expenses = "select $group_field as group_field, null as time";
       if ($bean->getAttribute('chunits')) $sql_for_expenses .= ", null as units";
       $sql_for_expenses .= ", sum(ei.cost) as cost, sum(ei.cost) as expenses from tt_expense_items ei $group_join $where";


@@ -1043,13 +1044,13 @@ class ttReportHelper {
   }
 
   // getTotals calculates total hours and cost for all report items.
   }
 
   // getTotals calculates total hours and cost for all report items.

-  static function getTotals($bean)
+  static function getTotals($bean, $options)

   {
     global $user;
 
     $mdb2 = getConnection();
 
   {
     global $user;
 
     $mdb2 = getConnection();
 

-    $where = ttReportHelper::getWhere($bean);
+    $where = ttReportHelper::getWhere($bean, $options);

 
     // Prepare parts.
     $time_part = "sum(time_to_sec(l.duration)) as time";
 
     // Prepare parts.
     $time_part = "sum(time_to_sec(l.duration)) as time";


@@ -1076,7 +1077,7 @@ class ttReportHelper {
 
     // If we have expenses, query becomes a bit more complex.
     if ($bean->getAttribute('chcost') && $user->isPluginEnabled('ex')) {
 
     // If we have expenses, query becomes a bit more complex.
     if ($bean->getAttribute('chcost') && $user->isPluginEnabled('ex')) {

-      $where = ttReportHelper::getExpenseWhere($bean);
+      $where = ttReportHelper::getExpenseWhere($bean, $options);

       $sql_for_expenses = "select null as time";
       if ($bean->getAttribute('chunits')) $sql_for_expenses .= ", null as units";
       $sql_for_expenses .= ", sum(cost) as cost, sum(cost) as expenses from tt_expense_items ei $where";
       $sql_for_expenses = "select null as time";
       if ($bean->getAttribute('chunits')) $sql_for_expenses .= ", null as units";
       $sql_for_expenses .= ", sum(cost) as cost, sum(cost) as expenses from tt_expense_items ei $where";


@@ -1250,12 +1251,13 @@ class ttReportHelper {
     // Determine these once as they are used in multiple places in this function.
     $canViewReports = $user->can('view_reports');
     $isClient = $user->isClient();
     // Determine these once as they are used in multiple places in this function.
     $canViewReports = $user->can('view_reports');
     $isClient = $user->isClient();

+    $options = ttReportHelper::getReportOptions($bean);

 
 

-    $items = ttReportHelper::getItems($bean);
+    $items = ttReportHelper::getItems($bean, $options);

     $group_by = $bean->getAttribute('group_by');
     if ($group_by && 'no_grouping' != $group_by)
     $group_by = $bean->getAttribute('group_by');
     if ($group_by && 'no_grouping' != $group_by)

-      $subtotals = ttReportHelper::getSubtotals($bean);
-    $totals = ttReportHelper::getTotals($bean);
+      $subtotals = ttReportHelper::getSubtotals($bean, $options);
+    $totals = ttReportHelper::getTotals($bean, $options);

 
     // Use custom fields plugin if it is enabled.
     if ($user->isPluginEnabled('cf'))
 
     // Use custom fields plugin if it is enabled.
     if ($user->isPluginEnabled('cf'))


@@ -1884,4 +1886,56 @@ class ttReportHelper {
 
     return true;
   }
 
     return true;
   }

+
+  // getReportOptions - returns an array of report options constructed from session bean.
+  //
+  // Note: similarly to ttFavReportHelper::getReportOptions, this function is a part of
+  // refactoring to simplify maintenance of report generating functions, as we currently
+  // have 2 sets: normal reporting (from bean), and fav report emailing (from db fields).
+  // Using options obtained from either db or bean shall allow us to use only one set of functions.
+  static function getReportOptions($bean) {
+    global $user;
+
+    // Prepare an array of report options.
+    $options = array();
+
+    // Construct one by one.
+    $options['name'] = null; // No name required.
+    $options['user_id'] = $user->id; // Not sure if we need user_id here. Fav reports use it to recycle $user object in cron.php.
+    $options['client_id'] = $bean->getAttribute('client');
+
+/*
+ * TODO: remaining fields to fill in...
+  `client_id` int(11) default NULL,                      # client id (if selected)
+  `cf_1_option_id` int(11) default NULL,                 # custom field 1 option id (if selected)
+  `project_id` int(11) default NULL,                     # project id (if selected)
+  `task_id` int(11) default NULL,                        # task id (if selected)
+  `billable` tinyint(4) default NULL,                    # whether to include billable, not billable, or all records
+  `invoice` tinyint(4) default NULL,                     # whether to include invoiced, not invoiced, or all records
+  `paid_status` tinyint(4) default NULL,                 # whether to include paid, not paid, or all records
+  `users` text default NULL,                             # Comma-separated list of user ids. Nothing here means "all" users.
+  `period` tinyint(4) default NULL,                      # selected period type for report
+  `period_start` date default NULL,                      # period start
+  `period_end` date default NULL,                        # period end
+  `show_client` tinyint(4) NOT NULL default 0,           # whether to show client column
+  `show_invoice` tinyint(4) NOT NULL default 0,          # whether to show invoice column
+  `show_paid` tinyint(4) NOT NULL default 0,             # whether to show paid column
+  `show_ip` tinyint(4) NOT NULL default 0,               # whether to show ip column
+  `show_project` tinyint(4) NOT NULL default 0,          # whether to show project column
+  `show_start` tinyint(4) NOT NULL default 0,            # whether to show start field
+  `show_duration` tinyint(4) NOT NULL default 0,         # whether to show duration field
+  `show_cost` tinyint(4) NOT NULL default 0,             # whether to show cost field
+  `show_task` tinyint(4) NOT NULL default 0,             # whether to show task column
+  `show_end` tinyint(4) NOT NULL default 0,              # whether to show end field
+  `show_note` tinyint(4) NOT NULL default 0,             # whether to show note column
+  `show_custom_field_1` tinyint(4) NOT NULL default 0,   # whether to show custom field 1
+  `show_work_units` tinyint(4) NOT NULL default 0,       # whether to show work units
+  `show_totals_only` tinyint(4) NOT NULL default 0,      # whether to show totals only
+  `group_by` varchar(20) default NULL,                   # group by field
+  `status` tinyint(4) default 1,                         # favorite report status
+  PRIMARY KEY (`id`)
+);
+     */
+    return $options;
+  }

 }
 }

diff --git a/WEB-INF/templates/footer.tpl b/WEB-INF/templates/footer.tpl
index 5c25eb60a452b4dd3d56728ef4aa72aaf3194e00..bbef7b8d33292edd63dabc7b8aca125e1ab5335a 100644 (file)
--- a/WEB-INF/templates/footer.tpl
+++ b/WEB-INF/templates/footer.tpl
@@ -12,7 +12,7 @@
       <br>
       <table cellspacing="0" cellpadding="4" width="100%" border="0">
         <tr>
       <br>
       <table cellspacing="0" cellpadding="4" width="100%" border="0">
         <tr>

-          <td align="center">&nbsp;Anuko Time Tracker 1.17.93.4287 | Copyright &copy; <a href="https://www.anuko.com/lp/tt_3.htm" target="_blank">Anuko</a> |
+          <td align="center">&nbsp;Anuko Time Tracker 1.17.93.4288 | Copyright &copy; <a href="https://www.anuko.com/lp/tt_3.htm" target="_blank">Anuko</a> |

             <a href="https://www.anuko.com/lp/tt_4.htm" target="_blank">{$i18n.footer.credits}</a> |
             <a href="https://www.anuko.com/lp/tt_5.htm" target="_blank">{$i18n.footer.license}</a> |
             <a href="https://www.anuko.com/lp/tt_7.htm" target="_blank">{$i18n.footer.improve}</a>
             <a href="https://www.anuko.com/lp/tt_4.htm" target="_blank">{$i18n.footer.credits}</a> |
             <a href="https://www.anuko.com/lp/tt_5.htm" target="_blank">{$i18n.footer.license}</a> |
             <a href="https://www.anuko.com/lp/tt_7.htm" target="_blank">{$i18n.footer.improve}</a>

diff --git a/report.php b/report.php
index 3f2074491e64dec85e64864858281048c4f09fdd..61b3587ffed4b362a0ac620cdeba1294079d1a95 100644 (file)
--- a/report.php
+++ b/report.php
@@ -172,14 +172,15 @@ if ($request->isPost()) {
 
 $group_by = $bean->getAttribute('group_by');
 
 
 $group_by = $bean->getAttribute('group_by');
 

-$report_items = ttReportHelper::getItems($bean);
+$options = ttReportHelper::getReportOptions($bean);
+$report_items = ttReportHelper::getItems($bean, $options);

 // Store record ids in session in case user wants to act on records such as marking them all paid.
 if ($request->isGet() && $user->isPluginEnabled('ps'))
   ttReportHelper::putInSession($report_items);
 
 if ('no_grouping' != $group_by)
 // Store record ids in session in case user wants to act on records such as marking them all paid.
 if ($request->isGet() && $user->isPluginEnabled('ps'))
   ttReportHelper::putInSession($report_items);
 
 if ('no_grouping' != $group_by)

-  $subtotals = ttReportHelper::getSubtotals($bean);
-$totals = ttReportHelper::getTotals($bean);
+  $subtotals = ttReportHelper::getSubtotals($bean, $options);
+$totals = ttReportHelper::getTotals($bean, $options);

 
 // Assign variables that are used to print subtotals.
 if ($report_items && 'no_grouping' != $group_by) {
 
 // Assign variables that are used to print subtotals.
 if ($report_items && 'no_grouping' != $group_by) {

diff --git a/tofile.php b/tofile.php
index a06a986677cb48d3a3ee7b1cd8c85efd77c3ddbc..5a190f4bb595e6505706283b8d8ca094db5a9197 100644 (file)
--- a/tofile.php
+++ b/tofile.php
@@ -58,10 +58,11 @@ $type = $request->getParameter('type');
 $totals_only = $bean->getAttribute('chtotalsonly');
 
 // Obtain items.
 $totals_only = $bean->getAttribute('chtotalsonly');
 
 // Obtain items.

+$options = ttReportHelper::getReportOptions($bean);

 if ($totals_only)
 if ($totals_only)

-  $subtotals = ttReportHelper::getSubtotals($bean);
+  $subtotals = ttReportHelper::getSubtotals($bean, $options);

 else
 else

-  $items = ttReportHelper::getItems($bean);
+  $items = ttReportHelper::getItems($bean, $options);

 
 // Build a string to use as filename for the files being downloaded.
 $filename = strtolower($i18n->get('title.report')).'_'.$bean->mValues['start_date'].'_'.$bean->mValues['end_date'];
 
 // Build a string to use as filename for the files being downloaded.
 $filename = strtolower($i18n->get('title.report')).'_'.$bean->mValues['start_date'].'_'.$bean->mValues['end_date'];

diff --git a/topdf.php b/topdf.php
index b7ac19d529ca2c00c7eb7db4e69131d90b4995c1..9d3164af1e458ecc3f939f983bc6a383e741da26 100644 (file)
--- a/topdf.php
+++ b/topdf.php
@@ -74,11 +74,12 @@ if ('no_grouping' != $group_by) {
 }
 
 // Obtain items for report.
 }
 
 // Obtain items for report.

+$options = ttReportHelper::getReportOptions($bean);

 if (!$totals_only)
 if (!$totals_only)

-  $items = ttReportHelper::getItems($bean); // Individual entries.
+  $items = ttReportHelper::getItems($bean, $options); // Individual entries.

 if ($totals_only || 'no_grouping' != $group_by)
 if ($totals_only || 'no_grouping' != $group_by)

-  $subtotals = ttReportHelper::getSubtotals($bean); // Subtotals for groups of items.
-$totals = ttReportHelper::getTotals($bean); // Totals for the entire report.
+  $subtotals = ttReportHelper::getSubtotals($bean, $options); // Subtotals for groups of items.
+$totals = ttReportHelper::getTotals($bean, $options); // Totals for the entire report.

 
 // Assign variables that are used to print subtotals.
 if ($items && 'no_grouping' != $group_by) {
 
 // Assign variables that are used to print subtotals.
 if ($items && 'no_grouping' != $group_by) {