forked from Furgas/php-api-library
-
Notifications
You must be signed in to change notification settings - Fork 0
/
kyTicketPriority.php
226 lines (199 loc) · 4.86 KB
/
kyTicketPriority.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
<?php
/**
* Kayako TicketPriority object.
*
* @author Tomasz Sawicki (https://github.com/Furgas)
* @link http://wiki.kayako.com/display/DEV/REST+-+TicketPriority
* @since Kayako version 4.01.240
* @package Object\Ticket
*/
class kyTicketPriority extends kyObjectBase {
const TYPE_PUBLIC = 'public';
const TYPE_PRIVATE = 'private';
static protected $controller = '/Tickets/TicketPriority';
static protected $object_xml_name = 'ticketpriority';
protected $read_only = true;
/**
* Ticket priority identifier.
* @apiField
* @var int
*/
protected $id;
/**
* Ticket priority title.
* @apiField
* @var string
*/
protected $title;
/**
* Ticket priority display order.
* @apiField
* @var string
*/
protected $display_order;
/**
* Foreground (font) color of this priority in GUI.
* @apiField getter=getForegroundColor
* @var string
*/
protected $fr_color_code;
/**
* Background color of this priority in GUI.
* @apiField getter=getBackgroundColor
* @var string
*/
protected $bg_color_code;
/**
* Path to icon displayed in GUI for this ticket priority.
* @apiField
* @var string
*/
protected $display_icon;
/**
* Type of this ticket priority.
*
* @see kyTicketPriority::TYPE constants.
*
* @apiField
* @var string
*/
protected $type;
/**
* If this ticket priority is visible to specific user groups only.
* @apiField
* @var bool
*/
protected $user_visibility_custom;
/**
* Identifiers of user group this ticket priority is visible to.
* @apiField name=usergroupid
* @var string
*/
protected $user_group_ids = array();
/**
* User groups this ticket priority is visible to.
* @var kyUserGroup[]
*/
private $user_groups = null;
protected function parseData($data) {
$this->id = intval($data['id']);
$this->title = $data['title'];
$this->display_order = intval($data['displayorder']);
$this->fr_color_code = $data['frcolorcode'];
$this->bg_color_code = $data['bgcolorcode'];
$this->type = $data['type'];
$this->user_visibility_custom = ky_assure_bool($data['uservisibilitycustom']);
if ($this->user_visibility_custom && is_array($data['usergroupid'])) {
foreach ($data['usergroupid'] as $user_group_id) {
$this->user_group_ids[] = intval($user_group_id);
}
}
}
public function toString() {
return sprintf("%s (type: %s)", $this->getTitle(), $this->getType());
}
public function getId($complete = false) {
return $complete ? array($this->id) : $this->id;
}
/**
* Returns title of this ticket priority.
*
* @return string
* @filterBy
* @orderBy
*/
public function getTitle() {
return $this->title;
}
/**
* Returns display order of this ticket priority.
*
* @return int
* @filterBy
* @orderBy
*/
public function getDisplayOrder() {
return $this->display_order;
}
/**
* Returns foreground (font) color of this priority in GUI.
*
* @return string
* @filterBy
*/
public function getForegroundColor() {
return $this->fr_color_code;
}
/**
* Returns background color of this priority in GUI.
*
* @return string
* @filterBy
*/
public function getBackgroundColor() {
return $this->bg_color_code;
}
/**
* Returns type of this ticket priority.
*
* @see kyTicketPriority::TYPE constants.
*
* @return string
* @filterBy
* @orderBy
*/
public function getType() {
return $this->type;
}
/**
* Returns whether this ticket priority is visible to specific user groups only.
*
* @return bool
* @filterBy
*/
public function getUserVisibilityCustom() {
return $this->user_visibility_custom;
}
/**
* Returns identifiers of user groups that this ticket priority is visible to.
*
* @return int[]
* @filterBy name=UserGroupId
*/
public function getUserGroupIds() {
return $this->user_group_ids;
}
/**
* Returns user groups that this ticket priority is visible to.
*
* @param bool $reload True to reload data from server. False to use the cached value (if present).
* @return kyResultSet
*/
public function getUserGroups($reload = false) {
foreach ($this->user_group_ids as $user_group_id) {
if (!is_array($this->user_groups) || !array_key_exists($user_group_id, $this->user_groups) || $reload) {
$this->user_groups[$user_group_id] = kyUserGroup::get($user_group_id);
}
}
return new kyResultSet(array_values($this->user_groups));
}
/**
* Returns whether this ticket type is visible to specified user group.
*
* @param kyUserGroup|int $user_group User group or its identifier.
* @return bool
* @filterBy
*/
public function isVisibleToUserGroup($user_group) {
if ($this->type !== self::TYPE_PUBLIC)
return false;
if ($this->user_visibility_custom === false)
return true;
if ($user_group instanceof kyUserGroup) {
$user_group_id = $user_group->getId();
} else {
$user_group_id = intval($user_group);
}
return in_array($user_group_id, $this->user_group_ids);
}
}