A bit of cleanup.
[timetracker.git] / WEB-INF / lib / ttGroup.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('ttConfigHelper');
30 import('ttGroupHelper');
31
32 // ttGroup class is used to store attributes for a single group in Time Tracker.
33 // We use it in ttUser class to have acces to "on behalf" group properties.
34 class ttGroup {
35   var $id = null;               // Group id.
36   var $parent_id = null;        // Paerent group id.
37   var $org_id = null;           // Organization id.
38   var $name = null;             // Group name.
39   var $lang = null;             // Language.
40   var $decimal_mark = null;     // Decimal separator.
41   var $date_format = null;      // Date format.
42   var $time_format = null;      // Time format.
43   var $week_start = 0;          // Week start day.
44   var $show_holidays = 0;       // Whether to show holidays in calendar.
45   var $tracking_mode = 0;       // Tracking mode.
46   var $project_required = 0;    // Whether project selection is required on time entires.
47   var $task_required = 0;       // Whether task selection is required on time entires.
48   var $record_type = 0;         // Record type (duration vs start and finish, or both).
49   var $punch_mode = 0;          // Whether punch mode is enabled for user.
50   var $allow_overlap = 0;       // Whether to allow overlapping time entries.
51   var $future_entries = 0;      // Whether to allow creating future entries.
52   var $bcc_email = null;        // Bcc email.
53   var $allow_ip = null;         // Specification from where user is allowed access.
54   var $password_complexity = null; // Password complexity example.
55   var $currency = null;         // Currency.
56   var $plugins = null;          // Comma-separated list of enabled plugins.
57   var $config = null;           // Comma-separated list of miscellaneous config options.
58   var $custom_logo = 0;         // Whether to use a custom logo for group.
59   var $lock_spec = null;        // Cron specification for record locking.
60   var $workday_minutes = 480;   // Number of work minutes in a regular day.
61
62   var $active_users = 0;        // Count of active users in group.
63                                 // We need a non-zero count to display some menus.
64
65   // Constructor.
66   function __construct($id, $org_id) {
67     $mdb2 = getConnection();
68
69     $sql = "select * from tt_groups where id = $id and org_id = $org_id";
70     $res = $mdb2->query($sql);
71     if (is_a($res, 'PEAR_Error')) {
72       return;
73     }
74
75     $val = $res->fetchRow();
76     if ($val['id'] > 0) {
77       $this->id = $val['id'];
78       $this->parent_id = $val['parent_id'];
79       $this->org_id = $val['org_id'];
80       $this->name = $val['name'];
81       $this->lang = $val['lang'];
82       $this->decimal_mark = $val['decimal_mark'];
83       $this->date_format = $val['date_format'];
84       $this->time_format = $val['time_format'];
85       $this->week_start = $val['week_start'];
86       $this->tracking_mode = $val['tracking_mode'];
87       /* TODO: initialize other things here.
88       $this->project_required = $val['project_required'];
89       $this->task_required = $val['task_required'];
90        */
91       $this->record_type = $val['record_type'];
92       /*
93       $this->bcc_email = $val['bcc_email'];
94       $this->allow_ip = $val['allow_ip'];
95       $this->password_complexity = $val['password_complexity'];
96       $this->group_name = $val['group_name'];
97       */
98       $this->currency = $val['currency'];
99       $this->plugins = $val['plugins'];
100       $this->lock_spec = $val['lock_spec'];
101       $this->workday_minutes = $val['workday_minutes'];
102       /*
103       $this->custom_logo = $val['custom_logo'];
104       */
105       $this->config = $val['config'];
106       $config = new ttConfigHelper($this->config);
107       // Set user config options.
108       $this->show_holidays = $config->getDefinedValue('show_holidays');
109       $this->punch_mode = $config->getDefinedValue('punch_mode');
110       $this->allow_overlap = $config->getDefinedValue('allow_overlap');
111       $this->future_entries = $config->getDefinedValue('future_entries');
112     }
113
114     // Determine active user count in a separate query.
115     // TODO: If performance becomes an issue, investigate combining 2 queries in one.
116     // At this time we only need to know if at least 1 active user exists.
117     $sql = "select count(*) as user_count from tt_users".
118       "  where group_id = $id and org_id = $org_id and status = 1";
119     $res = $mdb2->query($sql);
120     if (is_a($res, 'PEAR_Error')) {
121       return;
122     }
123     $val = $res->fetchRow();
124     $this->active_users = $val['user_count'];
125   }
126 }