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 $group_id; // Group id.
36 var $org_id; // Organization id.
38 function __construct() {
39 $this->db = getConnection();
41 $this->group_id = $user->getGroup();
42 $this->org_id = $user->org_id;
45 // update - deletes a quota, then inserts a new one.
46 public function update($year, $month, $minutes) {
47 $deleteSql = "delete from tt_monthly_quotas".
48 " where year = $year and month = $month and group_id = $this->group_id and org_id = $this->org_id";
49 $this->db->exec($deleteSql);
51 $insertSql = "insert into tt_monthly_quotas (group_id, org_id, year, month, minutes)".
52 " values ($this->group_id, $this->org_id, $year, $month, $minutes)";
53 $affected = $this->db->exec($insertSql);
54 return (!is_a($affected, 'PEAR_Error'));
59 // get - obtains either a single month quota or an array of quotas for an entire year.
60 // Month starts with 1 for January, not 0.
61 public function get($year, $month = null) {
63 return $this->getMany($year);
65 return $this->getSingle($year, $month);
68 // getSingle - obtains a quota for a single month.
69 private function getSingle($year, $month) {
70 $sql = "select minutes from tt_monthly_quotas".
71 " where year = $year and month = $month and group_id = $this->group_id and org_id = $this->org_id";
72 $reader = $this->db->query($sql);
73 if (is_a($reader, 'PEAR_Error')) {
77 $row = $reader->fetchRow();
79 return $row['minutes'];
81 // If we did not find a record, return a calculated monthly quota.
82 $numWorkdays = $this->getNumWorkdays($month, $year);
84 return $numWorkdays * $user->getWorkdayMinutes();
87 // getUserQuota - obtains a quota for user for a single month.
88 // This quota is adjusted by quota_percent value for user.
89 public function getUserQuota($year, $month) {
92 $minutes = $this->getSingle($year, $month);
93 $userMinutes = (int) $minutes * $user->getQuotaPercent() / 100;
97 // getUserQuotaFrom1st - obtains a quota for user
98 // from 1st of the month up to and inclusive of $selected_date.
99 public function getUserQuotaFrom1st($selected_date) {
100 // TODO: we may need a better algorithm here. Review.
101 $monthQuotaMinutes = $this->getUserQuota($selected_date->mYear, $selected_date->mMonth);
102 $workdaysInMonth = $this->getNumWorkdays($selected_date->mMonth, $selected_date->mYear);
104 // Iterate from 1st up to selected date.
105 $workdaysFrom1st = 0;
106 for ($i = 1; $i <= $selected_date->mDate; $i++) {
107 $date = ttTimeHelper::dateInDatabaseFormat($selected_date->mYear, $selected_date->mMonth, $i);
108 if (!ttTimeHelper::isWeekend($date) && !ttTimeHelper::isHoliday($date)) {
112 $quotaMinutesFrom1st = (int) ($monthQuotaMinutes * $workdaysFrom1st / $workdaysInMonth);
113 return $quotaMinutesFrom1st;
116 // getMany - returns an array of quotas for a given year for group.
117 private function getMany($year){
118 $sql = "select month, minutes from tt_monthly_quotas".
119 " where year = $year and group_id = $this->group_id and org_id = $this->org_id";
121 $res = $this->db->query($sql);
122 if (is_a($res, 'PEAR_Error')) {
126 while ($val = $res->fetchRow()) {
127 $result[$val['month']] = $val['minutes'];
133 // getNumWorkdays returns a number of work days in a given month.
134 private function getNumWorkdays($month, $year) {
136 $daysInMonth = cal_days_in_month(CAL_GREGORIAN, $month, $year); // Number of calendar days in month.
138 $workdaysInMonth = 0;
139 // Iterate through the entire month.
140 for ($i = 1; $i <= $daysInMonth; $i++) {
141 $date = "$year-$month-$i";
142 $date = ttTimeHelper::dateInDatabaseFormat($year, $month, $i);
143 if (!ttTimeHelper::isWeekend($date) && !ttTimeHelper::isHoliday($date)) {
147 return $workdaysInMonth;
150 // isValidQuota validates a localized value as an hours quota string (in hours and minutes).
151 public function isValidQuota($value) {
153 if (strlen($value) == 0 || !isset($value)) return true;
155 if (preg_match('/^[0-9]{1,3}h?$/', $value )) { // 000 - 999
159 if (preg_match('/^[0-9]{1,3}:[0-5][0-9]$/', $value )) { // 000:00 - 999:59
164 $localizedPattern = '/^([0-9]{1,3})?['.$user->getDecimalMark().'][0-9]{1,4}h?$/';
165 if (preg_match($localizedPattern, $value )) { // decimal values like 000.5, 999.25h, ... .. 999.9999h (or with comma)
172 // quotaToFloat converts a valid quota value to a float.
173 public function quotaToFloat($value) {
175 if (preg_match('/^[0-9]{1,3}h?$/', $value )) { // 000 - 999
176 return (float) $value;
179 if (preg_match('/^[0-9]{1,3}:[0-5][0-9]$/', $value )) { // 000:00 - 999:59
180 $minutes = ttTimeHelper::toMinutes($value);
181 return ($minutes / 60.0);
185 $localizedPattern = '/^([0-9]{1,3})?['.$user->getDecimalMark().'][0-9]{1,4}h?$/';
186 if (preg_match($localizedPattern, $value )) { // decimal values like 000.5, 999.25h, ... .. 999.9999h (or with comma)
187 // Strip optional h in the end.
188 $value = trim($value, 'h');
189 if ($user->getDecimalMark() == ',')
190 $value = str_replace(',', '.', $value);
191 return (float) $value;