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.
11 // | There are only two ways to violate the license:
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).
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).
21 // | This license applies to this document only, not any other software
22 // | that it may be combined with.
24 // +----------------------------------------------------------------------+
26 // | https://www.anuko.com/time_tracker/credits.htm
27 // +----------------------------------------------------------------------+
29 import('ttTimeHelper');
31 // MontlyQuota class implements handling of work hour quotas.
34 var $db; // Database connection.
35 var $team_id; // Team id.
37 // Old style constructors are DEPRECATED in PHP 7.0, and will be removed in a future version. You should always use __construct() in new code.
38 function __construct() {
39 $this->db = getConnection();
41 $this->team_id = $user->team_id;
44 // update - deletes a quota, then inserts a new one.
45 public function update($year, $month, $quota) {
46 $team_id = $this->team_id;
47 $deleteSql = "DELETE FROM tt_monthly_quotas WHERE year = $year AND month = $month AND team_id = $team_id";
48 $this->db->exec($deleteSql);
50 $float_quota = $this->quotaToFloat($quota);
51 $insertSql = "INSERT INTO tt_monthly_quotas (team_id, year, month, quota) values ($team_id, $year, $month, $float_quota)";
52 $affected = $this->db->exec($insertSql);
53 return (!is_a($affected, 'PEAR_Error'));
58 // get - obtains either a single month quota or an array of quotas for an entire year.
59 // Month starts with 1 for January, not 0.
60 public function get($year, $month = null) {
62 return $this->getMany($year);
64 return $this->getSingle($year, $month);
67 // getSingle - obtains a quota for a single month.
68 private function getSingle($year, $month) {
69 $team_id = $this->team_id;
70 $sql = "SELECT quota FROM tt_monthly_quotas WHERE year = $year AND month = $month AND team_id = $team_id";
71 $reader = $this->db->query($sql);
72 if (is_a($reader, 'PEAR_Error')) {
76 $row = $reader->fetchRow();
80 // If we did not find a record, return a calculated monthly quota.
81 $numWorkdays = $this->getNumWorkdays($month, $year);
83 return $numWorkdays * $user->workday_hours;
86 // getMany - returns an array of quotas for a given year for team.
87 private function getMany($year){
88 $team_id = $this->team_id;
89 $sql = "SELECT month, quota FROM tt_monthly_quotas WHERE year = $year AND team_id = $team_id";
91 $res = $this->db->query($sql);
92 if (is_a($res, 'PEAR_Error')) {
96 while ($val = $res->fetchRow()) {
97 $result[$val['month']] = $val['quota'];
103 // getNumWorkdays returns a number of work days in a given month.
104 private function getNumWorkdays($month, $year) {
106 $daysInMonth = cal_days_in_month(CAL_GREGORIAN, $month, $year); // Number of calendar days in month.
108 $workdaysInMonth = 0;
109 // Iterate through the entire month.
110 for ($i = 1; $i <= $daysInMonth; $i++) {
111 $date = "$year-$month-$i";
112 if (!ttTimeHelper::isWeekend($date) && !ttTimeHelper::isHoliday($date)) {
116 return $workdaysInMonth;
119 // isValidQuota validates a localized value as an hours quota string (in hours and minutes).
120 public function isValidQuota($value) {
122 if (strlen($value) == 0 || !isset($value)) return true;
124 if (preg_match('/^[0-9]{1,3}h?$/', $value )) { // 000 - 999
128 if (preg_match('/^[0-9]{1,3}:[0-5][0-9]$/', $value )) { // 000:00 - 999:59
133 $localizedPattern = '/^([0-9]{1,3})?['.$user->decimal_mark.'][0-9]{1,4}h?$/';
134 if (preg_match($localizedPattern, $value )) { // decimal values like 000.5, 999.25h, ... .. 999.9999h (or with comma)
141 // quotaToFloat converts a valid quota value to a float.
142 private function quotaToFloat($value) {
144 if (preg_match('/^[0-9]{1,3}h?$/', $value )) { // 000 - 999
145 return (float) $value;
148 if (preg_match('/^[0-9]{1,3}:[0-5][0-9]$/', $value )) { // 000:00 - 999:59
149 $minutes = ttTimeHelper::toMinutes($value);
150 return ($minutes / 60.0);
154 $localizedPattern = '/^([0-9]{1,3})?['.$user->decimal_mark.'][0-9]{1,4}h?$/';
155 if (preg_match($localizedPattern, $value )) { // decimal values like 000.5, 999.25h, ... .. 999.9999h (or with comma)
156 // Strip optional h in the end.
157 $value = trim($value, 'h');
158 if ($user->decimal_mark == ',')
159 $value = str_replace(',', '.', $value);
160 return (float) $value;