-
Notifications
You must be signed in to change notification settings - Fork 8
/
issue.php
1380 lines (1177 loc) · 47.3 KB
/
issue.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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* describe one issue
*
* This overlay is aiming to track status of various kinds of issue:
* - incident - issue has been submitted by an end-user that has a problem
* - maintenance - issue has been reported by the support team, because of a planned interruption
* - patch - issue is actually a suggestion to improve the service, for example, a new piece of software
* - feature - something new has to be created
*
* The overall workflow is the following:
* [snippet]
* on-going:suspect (create_date)
* V
* + qualification --> cancelled:suspect (qualification_date)
* V
* on-going:problem (qualification_date)
* V
* + analysis --> cancelled:problem (analysis_date)
* V
* on-going:issue (analysis_date)
* V
* + resolution --> cancelled:issue (resolution_date)
* V
* on-going:solution (resolution_date)
* V
* + integration --> cancelled:solution (close_date)
* V
* completed:solution (close_date)
* [/snippet]
*
* Transition dates and attributes are recorded the same way in the database. However, labels
* used to describe transitions depend of the type of the issue. Also, not all steps are required
* to all types.
*
* Label, status, progress, and title complement when type is 'feature':
* - on-going:suspect (create_date) - Feature request has been submitted - Submitted - 0%
* - cancelled:suspect (qualification_date) - Immediate solution has been provided - Closed - 100% - Cancelled
* - on-going:problem (qualification_date) - Feature request is valid - On-going - 20% - Validated
* - cancelled:problem (analysis_date) - No technical solution has been found - Closed - 100% - Rejected
* - on-going:issue (analysis_date) - Solution architecture has been documented - On-going - 50% - Analyzed
* - cancelled:issue (resolution_date) - No resource to work on the software - Closed - 100% - Rejected
* - on-going:solution (resolution_date) - A developer is working on this - On-going - 80% - Pending
* - cancelled:solution (close_date) - Software is available separately - Closed - 100% - Released
* - completed:solution (close_date) - Software has been fully integrated - Closed - 100% - Integrated
*
* Label, status, progress, and title complement when type is 'incident':
* - on-going:suspect (create_date) - Problem has been recorded - Opened - 0%
* - cancelled:suspect (qualification_date) - Immediate solution has been provided - Closed - 100% - Solved
* - on-going:problem (qualification_date) - Problem is valid and may be repeated - On-going - 20% - Validated
* - cancelled:problem (analysis_date) - No way to analyze the problem - Closed - 100% - Cancelled
* - on-going:issue (analysis_date) - Issue has been documented and cause has been identified - On-going - 50% - Analyzed
* - cancelled:issue (resolution_date) - No specific solution has been released - Closed - 100% - Solved
* - on-going:solution (resolution_date) - A solution has been made available - On-going - 80% - Solved
* - cancelled:solution (close_date) - Solution is available separately - Closed - 100% - Patched
* - completed:solution (close_date) - Solution has been fully integrated - Closed - 100% - Integrated
*
* Label, status, progress, and title complement when type is 'maintenance':
* - on-going:suspect (create_date) - Change is foreseen - Identified - 0%
* - cancelled:suspect (qualification_date) - Change can be avoided - Closed - 100% - Cancelled
* - on-going:problem (qualification_date) - Change request is valid - On-going - 20% - Confirmed
* - cancelled:problem (analysis_date) - N/A
* - on-going:issue (analysis_date) - N/A
* - cancelled:issue (resolution_date) - Change has been cancelled - Closed - 100% - Cancelled
* - on-going:solution (resolution_date) - Change has been initiated - On-going - 80% - Started
* - cancelled:solution (close_date) - Partial change has been achieved - Closed - 100% - Terminated
* - completed:solution (close_date) - Change has been fully completed - Closed - 100% - Completed
*
* Label, status, progress, and title complement when type is 'patch':
* - on-going:suspect (create_date) - Patch has been submittted - Submitted - 0%
* - cancelled:suspect (qualification_date) - Patch submission is not valid - Closed - 100% - Cancelled
* - on-going:problem (qualification_date) - Patch submission is valid - On-going - 20% - Validated
* - cancelled:problem (analysis_date) - Patch submission has been rejected - Closed - 100% - Rejected
* - on-going:issue (analysis_date) - Patch should be integrated - On-going - 50% - Analyzed
* - cancelled:issue (resolution_date) - No resource to work on the software - Closed - 100% - Rejected
* - on-going:solution (resolution_date) - A developer is working on this - On-going - 80% - Pending
* - cancelled:solution (close_date) - Software is available separately - Closed - 100% - Released
* - completed:solution (close_date) - Software has been fully integrated - Closed - 100% - Integrated
*
* This overlay saves a number of attributes in the side table [code]yacs_issues[/code].
*
* @author Bernard Paques
* @reference
* @license http://www.gnu.org/copyleft/lesser.txt GNU Lesser General Public License
*/
class Issue extends Overlay {
/**
* get radio buttons to change the color
*
* @param string the current color, if any
* @return the HTML to insert in the page
*/
function get_color_as_radio_buttons($color='green') {
global $context;
$text = '<span style="background-color: '.self::get_color_value('green').';"> <input type="radio" name="color" value="green"';
if($color == 'green')
$text .= ' checked="checked"';
$text .= '/> '.i18n::s('Situation is under control').' </span>'
.BR
.'<span style="background-color: '.self::get_color_value('orange').';"> <input type="radio" name="color" value="orange"';
if($color == 'orange')
$text .= ' checked="checked"';
$text .= '/> '.i18n::s('Exceptional effort is required').' </span>'
.BR
.'<span style="background-color: '.self::get_color_value('red').';"> <input type="radio" name="color" value="red"';
if($color == 'red')
$text .= ' checked="checked"';
$text .= '/> '.i18n::s('This is our first priority').' </span>';
return $text;
}
/**
* get a label for a given color
*
* @param string the color
* @return string the label to display
*/
function get_color_label($color) {
global $context;
switch($color) {
case 'green':
default:
return '<span style="background-color: '.self::get_color_value('green').';">'.i18n::s('Situation is under control').'</span>';
case 'orange':
return '<span style="background-color: '.self::get_color_value('orange').';">'.i18n::s('Exceptional effort is required').'</span>';
case 'red':
return '<span style="background-color: '.self::get_color_value('red').';">'.i18n::s('This is our first priority').'</span>';
}
}
/**
* get color value
*
* @param string the color
* @return string the hexadecimal value
*/
function get_color_value($color) {
global $context;
switch($color) {
case 'green':
default:
return '#00FF00';
case 'orange':
return '#FAAC58';
case 'red':
return '#FA5858';
}
}
/**
* streamline the user interface as much as possible
*/
function get_edit_as_simple_value() {
return TRUE;
}
/**
* build the list of fields for one overlay
*
* The current status, and the related status date are proposed
*
* @see overlays/overlay.php
*
* @param the hosting attributes
* @return a list of ($label, $input, $hint)
*/
function get_fields($host) {
global $context;
// form fields
$fields = array();
// capture of initial data
if(!isset($host['id'])) {
$this->attributes['type'] = 'incident';
$label = i18n::s('Workflow');
$input = '<select name="type" id="type">'.self::get_type_options($this->attributes['type']).'</select>';
$fields[] = array($label, $input);
}
// job done
return $fields;
}
/**
* build the history for this issue
*
* @return string an unnumbered list of dates
*/
function get_history() {
global $context;
// sanity check
if(!is_object($this->anchor))
return NULL;
$query = "SELECT * FROM ".SQL::table_name('issues')." AS issues "
." WHERE (issues.anchor LIKE '".SQL::escape($this->anchor->get_reference())."')";
// fetch the first row
if(!$row = SQL::query_first($query))
return NULL;
// text returned
$text = '';
// the creation step
if($row['create_date'] && ($row['create_date'] > NULL_DATE))
$text .= self::get_history_item(i18n::s('Submission'), $row['create_date'], $row['create_name'], $row['create_address'], $row['create_id']);
// all steps
$steps = array('cancelled:suspect', 'on-going:problem', 'cancelled:problem', 'on-going:issue', 'cancelled:issue', 'on-going:solution', 'cancelled:solution', 'completed:solution');
// the qualification step
if(in_array($this->attributes['status'], $steps) && $row['qualification_date'] && ($row['qualification_date'] > NULL_DATE))
$text .= self::get_history_item(i18n::s('Qualification'), $row['qualification_date'], $row['qualification_name'], $row['qualification_address'], $row['qualification_id']);
// remove qualification
array_shift($steps);
array_shift($steps);
// the analysis step
if(in_array($this->attributes['status'], $steps) && $row['analysis_date'] && ($row['analysis_date'] > NULL_DATE))
$text .= self::get_history_item(i18n::s('Analyzis'), $row['analysis_date'], $row['analysis_name'], $row['analysis_address'], $row['analysis_id']);
// remove analysis
array_shift($steps);
array_shift($steps);
// the solution step
if(in_array($this->attributes['status'], $steps) && $row['resolution_date'] && ($row['resolution_date'] > NULL_DATE))
$text .= self::get_history_item(i18n::s('Action'), $row['resolution_date'], $row['resolution_name'], $row['resolution_address'], $row['resolution_id']);
// remove resolution
array_shift($steps);
array_shift($steps);
// the close step
if(in_array($this->attributes['status'], $steps) && $row['close_date'] && ($row['close_date'] > NULL_DATE))
$text .= self::get_history_item(i18n::s('Finalization'), $row['close_date'], $row['close_name'], $row['close_address'], $row['close_id']);
if($text)
return "<ul>".$text."</ul>";
return NULL;
}
/**
* build one history item
*/
function get_history_item($action, $date, $name, $address, $id) {
global $context;
if($name)
$text = sprintf(i18n::s('%s %s by %s'), $action, Skin::build_date($date), Users::get_link($name, $address, $id));
else
$text = sprintf(i18n::s('%s %s'), $action, Skin::build_date($date));
return '<li>'.$text."</li>\n";
}
/**
* get an overlaid label
*
* Accepted action codes:
* - 'edit' the title for the modification of an existing object
* - 'delete' the title for the deleting form
* - 'new' the title for the creation of a new object
* - 'view' the title for a displayed object
*
* @see overlays/overlay.php
*
* @param string the target label
* @param string the on-going action
* @return the title to use
*/
function get_label($name, $action='view') {
global $context;
// the target label
switch($name.':'.$action) {
case 'description:articles':
return i18n::s('Issue description');
case 'edit_command:articles':
return i18n::s('Edit this issue');
case 'new_command:articles':
return i18n::s('Add an issue');
case 'page_title:edit':
return i18n::s('Edit an issue');
case 'page_title:delete':
return i18n::s('Delete an issue');
case 'page_title:new':
return i18n::s('Add an issue');
}
// no match
return NULL;
}
/**
* display a live title
*
* @see overlays/overlay.php
*
* @param array the hosting record
* @return some HTML to be inserted into the resulting page
*/
function &get_live_title($host=NULL) {
global $context;
$text = $host['title'];
// just created
if($this->attributes['status'] == 'on-going:suspect')
return $text;
$text .= ' [';
switch($this->attributes['status']) {
case 'cancelled:suspect':
switch($this->attributes['type']) {
case 'feature':
$text .= i18n::s('Cancelled');
break;
case 'incident':
default:
$text .= i18n::s('Solved');
break;
case 'maintenance':
$text .= i18n::s('Cancelled');
break;
case 'patch':
$text .= i18n::s('Cancelled');
break;
}
break;
case 'on-going:problem':
switch($this->attributes['type']) {
case 'feature':
$text .= i18n::s('Validated');
break;
case 'incident':
default:
$text .= i18n::s('Validated');
break;
case 'maintenance':
$text .= i18n::s('Confirmed');
break;
case 'patch':
$text .= i18n::s('Validated');
break;
}
break;
case 'cancelled:problem':
switch($this->attributes['type']) {
case 'feature':
$text .= i18n::s('Rejected');
break;
case 'incident':
default:
$text .= i18n::s('Cancelled');
break;
case 'maintenance':
$text .= 'N/A';
break;
case 'patch':
$text .= i18n::s('Rejected');
break;
}
break;
case 'on-going:issue':
switch($this->attributes['type']) {
case 'feature':
$text .= i18n::s('Analyzed');
break;
case 'incident':
default:
$text .= i18n::s('Analyzed');
break;
case 'maintenance':
$text .= 'N/A';
break;
case 'patch':
$text .= i18n::s('Analyzed');
break;
}
break;
case 'cancelled:issue':
switch($this->attributes['type']) {
case 'feature':
$text .= i18n::s('Rejected');
break;
case 'incident':
default:
$text .= i18n::s('Solved');
break;
case 'maintenance':
$text .= i18n::s('Cancelled');
break;
case 'patch':
$text .= i18n::s('Rejected');
break;
}
break;
case 'on-going:solution':
switch($this->attributes['type']) {
case 'feature':
$text .= i18n::s('Pending');
break;
case 'incident':
default:
$text .= i18n::s('Solved');
break;
case 'maintenance':
$text .= i18n::s('Started');
break;
case 'patch':
$text .= i18n::s('Pending');
break;
}
break;
case 'cancelled:solution':
switch($this->attributes['type']) {
case 'feature':
$text .= i18n::s('Released');
break;
case 'incident':
default:
$text .= i18n::s('Patched');
break;
case 'maintenance':
$text .= i18n::s('Terminated');
break;
case 'patch':
$text .= i18n::s('Released');
break;
}
break;
case 'completed:solution':
switch($this->attributes['type']) {
case 'feature':
$text .= i18n::s('Integrated');
break;
case 'incident':
default:
$text .= i18n::s('Integrated');
break;
case 'maintenance':
$text .= i18n::s('Completed');
break;
case 'patch':
$text .= i18n::s('Integrated');
break;
}
break;
}
$text .= ']';
// return by reference
return $text;
}
/**
* display the content of one overlay in a list
*
* To be overloaded into derived class
*
* @param array the hosting record, if any
* @return some HTML to be inserted into the resulting page
*/
function &get_list_text($host=NULL) {
// show progress
$text = BR.self::get_progress_value();
return $text;
}
/**
* get status as options of a <SELECT> field
*
* @param string the current status, if any
* @return the HTML to insert in the page
*/
function get_options($status) {
global $context;
$options['on-going:suspect'] = self::get_status_label('on-going:suspect');
$options['cancelled:suspect'] = self::get_status_label('cancelled:suspect');
$options['on-going:problem'] = self::get_status_label('on-going:problem');
$options['cancelled:problem'] = self::get_status_label('cancelled:problem');
$options['on-going:issue'] = self::get_status_label('on-going:issue');
$options['cancelled:issue'] = self::get_status_label('cancelled:issue');
$options['on-going:solution'] = self::get_status_label('on-going:solution');
$options['cancelled:solution'] = self::get_status_label('cancelled:solution');
$options['completed:solution'] = self::get_status_label('completed:issue');
foreach($options as $value => $label) {
$content .= '<option value="'.$value.'"';
if($status == $value)
$content .= ' selected';
$content .='>'.$label."</option>\n";
}
return $content;
}
/**
* provide issue progress
*
* @param mixed default value
* @return string current issue type
*/
function get_progress_value($default=NULL) {
global $context;
// based on status
switch($this->attributes['status']) {
case 'on-going:suspect':
default:
$meter = 0;
break;
case 'cancelled:suspect':
$meter = 100;
break;
case 'on-going:problem':
$meter = 20;
break;
case 'cancelled:problem':
$meter = 100;
break;
case 'on-going:issue':
$meter = 50;
break;
case 'cancelled:issue':
$meter = 100;
break;
case 'on-going:solution':
$meter = 80;
break;
case 'cancelled:solution':
$meter = 100;
break;
case 'completed:solution':
$meter = 100;
break;
}
// abnormal case
if(!isset($this->attributes['color']) || ($meter == 100))
$extra = '';
elseif($this->attributes['color'] == 'orange')
$extra = '-orange';
elseif($this->attributes['color'] == 'red')
$extra = '-red';
else
$extra = '';
// return
return '<img src="'.$context['url_to_root'].'skins/_reference/overlays/percent-'.$meter.$extra.'.png" alt="'.$meter.'%" />';
}
/**
* get a label for a given status code
*
* @param string the status code
* @return string the label to display
*/
function get_status_label($status) {
global $context;
switch($status) {
default:
return '';
case 'on-going:suspect':
switch($this->attributes['type']) {
case 'feature':
return i18n::s('Feature request has been submitted');
case 'incident':
default:
return i18n::s('Problem has been recorded');
case 'maintenance':
return i18n::s('Change is foreseen');
case 'patch':
return i18n::s('Patch has been submitted');
}
case 'cancelled:suspect':
switch($this->attributes['type']) {
case 'feature':
return i18n::s('Immediate solution has been provided');
case 'incident':
default:
return i18n::s('Immediate solution has been provided');
case 'maintenance':
return i18n::s('Change can be avoided');
case 'patch':
return i18n::s('Patch submission is not valid');
}
case 'on-going:problem':
switch($this->attributes['type']) {
case 'feature':
return i18n::s('Feature request is valid');
case 'incident':
default:
return i18n::s('Problem is valid and may be repeated');
case 'maintenance':
return i18n::s('Change request is valid');
case 'patch':
return i18n::s('Patch submission is valid');
}
case 'cancelled:problem':
switch($this->attributes['type']) {
case 'feature':
return i18n::s('No technical solution has been found');
case 'incident':
default:
return i18n::s('No way to analyze the problem');
case 'maintenance':
return 'N/A';
case 'patch':
return i18n::s('Patch submission has been rejected');
}
case 'on-going:issue':
switch($this->attributes['type']) {
case 'feature':
return i18n::s('Solution architecture has been documented');
case 'incident':
default:
return i18n::s('Issue has been documented and cause has been identified');
case 'maintenance':
return 'N/A';
case 'patch':
return i18n::s('Patch should be integrated');
}
case 'cancelled:issue':
switch($this->attributes['type']) {
case 'feature':
return i18n::s('No resource to work on the software');
case 'incident':
default:
return i18n::s('No specific solution has been released');
case 'maintenance':
return i18n::s('Change has been cancelled');
case 'patch':
return i18n::s('No resource to work on the software');
}
case 'on-going:solution':
switch($this->attributes['type']) {
case 'feature':
return i18n::s('A developer is working on this');
case 'incident':
default:
return i18n::s('A solution has been made available');
case 'maintenance':
return i18n::s('Change has been initiated');
case 'patch':
return i18n::s('A developer is working on this');
}
case 'cancelled:solution':
switch($this->attributes['type']) {
case 'feature':
return i18n::s('Software is available separately');
case 'incident':
default:
return i18n::s('Solution is available separately');
case 'maintenance':
return i18n::s('Partial change has been achieved');
case 'patch':
return i18n::s('Software is available separately');
}
case 'completed:solution':
switch($this->attributes['type']) {
case 'feature':
return i18n::s('Software has been fully integrated');
case 'incident':
default:
return i18n::s('Solution has been fully integrated');
case 'maintenance':
return i18n::s('Change has been fully completed');
case 'patch':
return i18n::s('Software has been fully integrated');
}
}
}
/**
* provide status as a string
*
* @see overlays/overlay.php
*
* @param mixed default value
* @return string current issue type
*/
function get_status_value($default=NULL) {
global $context;
switch($this->attributes['status']) {
case 'on-going:suspect':
default:
switch($this->attributes['type']) {
case 'feature':
return i18n::s('Submitted');
case 'incident':
default:
return i18n::s('Opened');
case 'maintenance':
return i18n::s('Identified');
case 'patch':
return i18n::s('Submitted');
}
case 'on-going:problem':
case 'on-going:issue':
case 'on-going:solution':
return i18n::s('On-going');
case 'cancelled:suspect':
case 'cancelled:problem':
case 'cancelled:issue':
case 'cancelled:solution':
case 'completed:solution':
return i18n::s('Closed');
}
}
/**
* add some tabs
*
* Display additional information in panels.
*
* Accepted action codes:
* - 'edit' - embedded into the main form page
*
* @see overlays/overlay.php
*
* @param string the on-going action
* @param array the hosting record
* @return an array of array('tab_id', 'tab_label', 'panel_id', 'panel_content') or NULL
*/
function &get_tabs($variant='view', $host=NULL) {
global $context, $local;
// returned tabs
$tabs = array();
$now = strftime('%Y-%m-%d %H:%M:%S', time() + ((Surfer::get_gmt_offset() - intval($context['gmt_offset'])) * 3600));
// trackings
//
$tracking = '';
// only associates and page owners can change the status
if(($variant == 'edit') && isset($this->anchor) && $this->anchor->is_owned()) {
// a table of fields
$fields = array();
// owner
$label = i18n::s('Owner');
if(isset($host['owner_id']) && ($user = Users::get($host['owner_id'])))
$value = $user['nick_name'];
else
$value = '';
$input = '<input type="text" name="owner" id="owner" value ="'.encode_field($value).'" size="25" maxlength="32" />';
$hint = i18n::s('Type some letters of the name and select in the list');
$fields[] = array($label, $input, $hint);
$tracking .= JS_PREFIX
.'$(function() { Yacs.autocomplete_names("owner",true); });'."\n" // enable owner autocompletion
.JS_SUFFIX;
// priority
$label = i18n::s('Priority');
if(!isset($this->attributes['color']))
$this->attributes['color'] = 'green';
$input = self::get_color_as_radio_buttons($this->attributes['color']);
$fields[] = array($label, $input);
// type
$label = i18n::s('Workflow');
if(!isset($this->attributes['type']))
$this->attributes['type'] = 'incident';
$input = '<select name="type" id="type">'.self::get_type_options($this->attributes['type']).'</select>';
$fields[] = array($label, $input);
// format these fields
$tracking .= Skin::build_form($fields);
$fields = array();
// to represent transitions from one step to the next one
Skin::define_img('NEXT_STEP', 'overlays/next_step.gif', 'V');
// status
if(!isset($this->attributes['status']))
$this->attributes['status'] = 'on-going:suspect';
// create_date
if(!isset($host['create_date']) || !$host['create_date'])
$host['create_date'] = gmstrftime('%Y-%m-%d %H:%M:%S');
$host['create_date'] = Surfer::from_GMT($host['create_date']);
if($this->attributes['type'] == 'feature')
$label = i18n::s('Feature request has been created on %s');
elseif($this->attributes['type'] == 'patch')
$label = i18n::s('Patch has been submitted on %s');
else
$label = i18n::s('Page has been created on %s');
$tracking .= '<div class="bottom" style="margin-bottom: 1em;">'.sprintf($label, Skin::build_input('create_date', $host['create_date'], 'date_time').' <a onclick="$(\'#create_date\').val(\''.$now.'\')" style="cursor: pointer;" class="details">'.i18n::s('now').'</a>').'</div>';
$tracking .= NEXT_STEP;
// qualification_date
if(isset($this->attributes['qualification_date']))
$this->attributes['qualification_date'] = Surfer::from_GMT($this->attributes['qualification_date']);
$tracking .= '<div style="margin-top: 1em">'.sprintf(i18n::s('Qualification has taken place on %s'), Skin::build_input('qualification_date', isset($this->attributes['qualification_date'])?$this->attributes['qualification_date'] : NULL_DATE, 'date_time').' <a onclick="$(\'#qualification_date\').val(\''.$now.'\')" style="cursor: pointer;" class="details">'.i18n::s('now').'</a>').'<p>';
$checked = '';
if(isset($this->attributes['status']) && ($this->attributes['status'] == 'on-going:problem'))
$checked = 'checked="checked"';
$tracking .= '<input type="radio" name="status" value ="on-going:problem" '.$checked.' /> '.$this->get_status_label('on-going:problem');
$checked = '';
if(isset($this->attributes['status']) && ($this->attributes['status'] == 'cancelled:suspect'))
$checked = 'checked="checked"';
$tracking .= BR.'<input type="radio" name="status" value ="cancelled:suspect" '.$checked.' /> '.$this->get_status_label('cancelled:suspect').'</p></div>';
$tracking .= NEXT_STEP;
// analysis_date, except for maintenance cases
if($this->attributes['type'] != 'maintenance') {
if(isset($this->attributes['analysis_date']))
$this->attributes['analysis_date'] = Surfer::from_GMT($this->attributes['analysis_date']);
$tracking .= '<div style="margin-top: 1em">'.sprintf(i18n::s('Analysis has ended on %s'), Skin::build_input('analysis_date', isset($this->attributes['analysis_date'])?$this->attributes['analysis_date'] : NULL_DATE, 'date_time').' <a onclick="$(\'#analysis_date\').val(\''.$now.'\')" style="cursor: pointer;" class="details">'.i18n::s('now').'</a>').'<p>';
$checked = '';
if(isset($this->attributes['status']) && ($this->attributes['status'] == 'on-going:issue'))
$checked = 'checked="checked"';
$tracking .= '<input type="radio" name="status" value ="on-going:issue" '.$checked.' /> '.$this->get_status_label('on-going:issue');
$checked = '';
if(isset($this->attributes['status']) && ($this->attributes['status'] == 'cancelled:problem'))
$checked = 'checked="checked"';
$tracking .= BR.'<input type="radio" name="status" value ="cancelled:problem" '.$checked.' /> '.$this->get_status_label('cancelled:problem').'</p></div>';
$tracking .= NEXT_STEP;
}
// resolution_date
if(isset($this->attributes['resolution_date']))
$this->attributes['resolution_date'] = Surfer::from_GMT($this->attributes['resolution_date']);
if($this->attributes['type'] == 'feature')
$label = i18n::s('Assignment has been finalized on %s');
elseif($this->attributes['type'] == 'maintenance')
$label = i18n::s('Change has been finalized on %s');
elseif($this->attributes['type'] == 'patch')
$label = i18n::s('Assignment has been finalized on %s');
else
$label = i18n::s('Resolution has been finalized on %s');
$tracking .= '<div style="margin-top: 1em">'.sprintf($label, Skin::build_input('resolution_date', isset($this->attributes['resolution_date'])?$this->attributes['resolution_date'] : NULL_DATE, 'date_time').' <a onclick="$(\'#resolution_date\').val(\''.$now.'\')" style="cursor: pointer;" class="details">'.i18n::s('now').'</a>').'<p>';
$checked = '';
if(isset($this->attributes['status']) && ($this->attributes['status'] == 'on-going:solution'))
$checked = 'checked="checked"';
$tracking .= '<input type="radio" name="status" value ="on-going:solution" '.$checked.' /> '.$this->get_status_label('on-going:solution');
$checked = '';
if(isset($this->attributes['status']) && ($this->attributes['status'] == 'cancelled:issue'))
$checked = 'checked="checked"';
$tracking .= BR.'<input type="radio" name="status" value ="cancelled:issue" '.$checked.' /> '.$this->get_status_label('cancelled:issue').'</p></div>';
$tracking .= NEXT_STEP;
// close_date
if(isset($this->attributes['close_date']))
$this->attributes['close_date'] = Surfer::from_GMT($this->attributes['close_date']);
$tracking .= '<div style="margin-top: 1em">'.sprintf(i18n::s('Case has been closed on %s'), Skin::build_input('close_date', isset($this->attributes['close_date'])?$this->attributes['close_date'] : NULL_DATE, 'date_time').' <a onclick="$(\'#close_date\').val(\''.$now.'\')" style="cursor: pointer;" class="details">'.i18n::s('now').'</a>').'<p>';
$checked = '';
if(isset($this->attributes['status']) && ($this->attributes['status'] == 'completed:solution'))
$checked = 'checked="checked"';
$tracking .= '<input type="radio" name="status" value ="completed:solution" '.$checked.' /> '.$this->get_status_label('completed:solution');
$checked = '';
if(isset($this->attributes['status']) && ($this->attributes['status'] == 'cancelled:solution'))
$checked = 'checked="checked"';
$tracking .= BR.'<input type="radio" name="status" value ="cancelled:solution" '.$checked.' /> '.$this->get_status_label('cancelled:solution').'</p></div>';
}
// finalize this tab
if($tracking)
$tabs[] = array('tracking', i18n::s('Tracking'), 'tracking_panel', $tracking);
// add these tabs
return $tabs;
}
/**
* provide type as a string
*
* @param string type to describe
* @return string current issue type
*/
function get_type_label($type='incident') {
global $context;
switch($type) {
case 'feature':
return i18n::s('Feature request');
default:
case 'incident':
return i18n::s('Support request');
case 'maintenance':
return i18n::s('Planned change');
case 'patch':
return i18n::s('Patch submission');
}
}
/**
* get type as options of a <SELECT> field
*
* @param string the current type, if any
* @return the HTML to insert in the page
*/
function get_type_options($type) {
global $context;
$options = array();
$options['incident'] = self::get_type_label('incident');
$options['feature'] = self::get_type_label('feature');
$options['patch'] = self::get_type_label('patch');
$options['maintenance'] = self::get_type_label('maintenance');
$content = '';
foreach($options as $value => $label) {
$content .= '<option value="'.$value.'"';
if($type == $value)
$content .= ' selected="selected"';
$content .='>'.$label."</option>\n";
}
return $content;
}
/**
* provide type as a string
*
* @see overlays/overlay.php
*