WEB-INF/lib/ttChartHelper.class.php

   1 <?php
   2 // +----------------------------------------------------------------------+
   3 // | Anuko Time Tracker
   4 // +----------------------------------------------------------------------+
   5 // | Copyright (c) Anuko International Ltd. (https://www.anuko.com)
   6 // +----------------------------------------------------------------------+
   7 // | LIBERAL FREEWARE LICENSE: This source code document may be used
   8 // | by anyone for any purpose, and freely redistributed alone or in
   9 // | combination with other software, provided that the license is obeyed.
  10 // |
  11 // | There are only two ways to violate the license:
  12 // |
  13 // | 1. To redistribute this code in source form, with the copyright
  14 // |    notice or license removed or altered. (Distributing in compiled
  15 // |    forms without embedded copyright notices is permitted).
  16 // |
  17 // | 2. To redistribute modified versions of this code in *any* form
  18 // |    that bears insufficient indications that the modifications are
  19 // |    not the work of the original author(s).
  20 // |
  21 // | This license applies to this document only, not any other software
  22 // | that it may be combined with.
  23 // |
  24 // +----------------------------------------------------------------------+
  25 // | Contributors:
  26 // | https://www.anuko.com/time_tracker/credits.htm
  27 // +----------------------------------------------------------------------+
  28
  29 import('Period');
  30 import('ttTimeHelper');
  31
  32 // Definitions for chart types.
  33 define('CHART_PROJECTS', 1);
  34 define('CHART_TASKS', 2);
  35 define('CHART_CLIENTS', 3);
  36
  37 // Class ttChartHelper is a helper class for charts.
  38 class ttChartHelper {
  39
  40   // getTotals - returns total times by project or task for a given user in a specified period.
  41   static function getTotals($user_id, $chart_type, $selected_date, $interval_type) {
  42
  43     $period = null;
  44     switch ($interval_type) {
  45       case INTERVAL_THIS_DAY:
  46         $period = new Period(INTERVAL_THIS_DAY, new DateAndTime(DB_DATEFORMAT, $selected_date));
  47         break;
  48
  49       case INTERVAL_THIS_WEEK:
  50         $period = new Period(INTERVAL_THIS_WEEK, new DateAndTime(DB_DATEFORMAT, $selected_date));
  51         break;
  52
  53       case INTERVAL_THIS_MONTH:
  54         $period = new Period(INTERVAL_THIS_MONTH, new DateAndTime(DB_DATEFORMAT, $selected_date));
  55         break;
  56
  57       case INTERVAL_THIS_YEAR:
  58         $period = new Period(INTERVAL_THIS_YEAR, new DateAndTime(DB_DATEFORMAT, $selected_date));
  59         break;
  60     }
  61
  62     $result = array();
  63     $mdb2 = getConnection();
  64
  65     $q_period = '';
  66     if ($period != null) {
  67       $q_period = " and date >= '".$period->getStartDate(DB_DATEFORMAT)."' and date <= '".$period->getEndDate(DB_DATEFORMAT)."'";
  68     }
  69     if (CHART_PROJECTS == $chart_type) {
  70       // Data for projects.
  71       $sql = "select p.name as name, sum(time_to_sec(l.duration)) as time from tt_log l
  72         left join tt_projects p on (p.id = l.project_id)
  73         where l.status = 1 and l.duration > 0 and l.user_id = $user_id $q_period group by l.project_id";
  74     } elseif (CHART_TASKS == $chart_type) {
  75       // Data for tasks.
  76       $sql = "select t.name as name, sum(time_to_sec(l.duration)) as time from tt_log l
  77         left join tt_tasks t on (t.id = l.task_id)
  78         where l.status = 1 and l.duration > 0 and l.user_id = $user_id $q_period group by l.task_id";
  79     } elseif (CHART_CLIENTS == $chart_type) {
  80       // Data for clients.
  81       $sql = "select c.name as name, sum(time_to_sec(l.duration)) as time from tt_log l
  82         left join tt_clients c on (c.id = l.client_id)
  83         where l.status = 1 and l.duration > 0 and l.user_id = $user_id $q_period group by l.client_id";
  84     }
  85
  86     $res = $mdb2->query($sql);
  87     if (!is_a($res, 'PEAR_Error')) {
  88       while ($val = $res->fetchRow()) {
  89         $result[] = array('name'=>$val['name'],'time'=>$val['time']); // name  - project name, time - total for project in seconds.
  90       }
  91     }
  92
  93     // Get total time. We'll need it to calculate percentages (for labels to the right of diagram).
  94     $total = 0;
  95     foreach ($result as $one_val) {
  96       $total += $one_val['time'];
  97     }
  98     // Add a string representation of time + percentage to names. Example: "Time Tracker (1:15 - 6%)".
  99     foreach ($result as &$one_val) {
 100       $percent = round(100*$one_val['time']/$total).'%';
 101       $one_val['name'] .= ' ('.ttTimeHelper::minutesToDuration($one_val['time'] / 60).' - '.$percent.')';
 102     }
 103
 104     // Note: the remaining code here is needed to display labels on the side of the diagram.
 105     // We print labels ourselves (not using libchart.php) because quality of libchart labels is not good.
 106
 107     // Note: Optimize this sorting and reversing.
 108     $result = mu_sort($result, 'time');
 109     $result = array_reverse($result); // This is to assign correct colors to labels.
 110
 111     // Add color to array items. This is used in labels on the side of a chart.
 112     $colors = array(
 113       array(2, 78, 0),
 114       array(148, 170, 36),
 115       array(233, 191, 49),
 116       array(240, 127, 41),
 117       array(243, 63, 34),
 118       array(190, 71, 47),
 119       array(135, 81, 60),
 120       array(128, 78, 162),
 121       array(121, 75, 255),
 122       array(142, 165, 250),
 123       array(162, 254, 239),
 124       array(137, 240, 166),
 125       array(104, 221, 71),
 126       array(98, 174, 35),
 127       array(93, 129, 1)
 128     );
 129     for ($i = 0; $i < count($result); $i++) {
 130       $color = $colors[$i%count($colors)];
 131       $result[$i]['color_html'] = sprintf('#%02x%02x%02x', $color[0], $color[1], $color[2]);
 132     }
 133
 134     return $result;
 135   }
 136
 137   // adjustType - adjust chart type to something that is available for a group.
 138   static function adjustType($requested_type) {
 139     global $user;
 140     $tracking_mode = $user->getTrackingMode();
 141     $client_option = $user->isPluginEnabled('cl');
 142
 143     // We have 3 possible options for chart tyep: projects, tasks, or clients.
 144     // Deal with each one individually.
 145
 146     if ($requested_type == CHART_PROJECTS) {
 147       if ($tracking_mode == MODE_PROJECTS || $tracking_mode == MODE_PROJECTS_AND_TASKS)
 148         return CHART_PROJECTS;
 149       else if ($client_option)
 150         return CHART_CLIENTS;
 151     }
 152
 153     if ($requested_type == CHART_TASKS) {
 154       if ($tracking_mode == MODE_PROJECTS_AND_TASKS)
 155         return CHART_TASKS;
 156       if ($tracking_mode == MODE_PROJECTS)
 157         return CHART_PROJECTS;
 158       else if ($client_option)
 159         return CHART_CLIENTS;
 160     }
 161
 162     if ($requested_type == CHART_CLIENTS) {
 163       if ($client_option)
 164         return CHART_CLIENTS;
 165       else if ($tracking_mode == MODE_PROJECTS || ($tracking_mode == MODE_PROJECTS_AND_TASKS))
 166         return CHART_PROJECTS;
 167     }
 168
 169     return  CHART_PROJECTS;
 170   }
 171 }