-
Notifications
You must be signed in to change notification settings - Fork 575
/
tree.class.php
1710 lines (1431 loc) · 59 KB
/
tree.class.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
/**
* TestLink Open Source Project - http://testlink.sourceforge.net/
* This script is distributed under the GNU General Public License 2 or later.
*
* @filesource tree.class.php
* @package TestLink
* @author Francisco Mancardi
* @copyright 2005-2020, TestLink community
* @link http://www.testlink.org/
*
*/
/**
* @package TestLink
*/
class tree extends tlObject
{
// ORDER IS CRITIC
// configurable values - pseudoconstants
// VERBOSE description do not map 100% contents of node_types table
// Now contains also PSEUDO NODES => build
var $node_types = array( 1 => 'testproject','testsuite',
'testcase','tcversion','testplan',
'requirement_spec','requirement','req_version',
'testcase_step','req_revision','requirement_spec_revision',
'build');
// key: node type id, value: class name
var $class_name = array( 1 => 'testproject','testsuite',
'testcase',null,'testplan',
'requirement_spec_mgr','requirement_mgr',null,
null,null,null,null);
var $nodeWithoutClass = null;
var $node_descr_id = array();
// Order here means NOTHING
var $node_tables_by = array('id' => array(),
'name' =>
array('testproject' => 'testprojects',
'testsuite' => 'testsuites',
'testplan' => 'testplans',
'testcase' => 'testcases',
'tcversion' => 'tcversions',
'requirement_spec' =>'req_specs',
'requirement' => 'requirements',
'req_version' => 'req_versions',
'req_revision' => 'req_versions',
'requirement_spec_revision' => 'req_specs_revisions'));
var $node_tables;
var $ROOT_NODE_TYPE_ID = 1;
var $ROOT_NODE_PARENT_ID = NULL;
/** @var resource database handler */
var $db;
/**
* Class costructor
* @param resource &$db reference to database handler
*/
function __construct(&$db)
{
if( !is_object($db) )
{
$msg = __METHOD__ . ' :: FATAL Error $db IS NOT AN Object';
throw new Exception($msg);
}
parent::__construct();
$this->db = &$db;
$this->object_table = $this->tables['nodes_hierarchy'];
$this->node_tables = $this->node_tables_by['name'];
$this->node_descr_id = array_flip($this->node_types);
foreach($this->node_tables_by['name'] as $key => $tbl)
{
$this->node_tables_by['id'][$this->node_descr_id[$key]] = $tbl;
}
$nodeCodeId = array_flip($this->node_types);
$this->nodeWithoutClass[$nodeCodeId['requirement_spec_revision']] = 'deleted when reqspec is deleted';
}
/**
* get info from node_types table, regarding node types that can be used in a tree.
*
* @return array map
* key: description: single human friendly string describing node type
* value: numeric code used to identify a node type
*
*/
function get_available_node_types() {
static $nodeTypes;
if( !$nodeTypes ) {
$sql = " SELECT * FROM {$this->tables['node_types']} ";
$nodeTypes = $this->db->fetchColumnsIntoMap($sql,'description','id');
}
return $nodeTypes;
}
/**
* creates a new root node in the hierarchy table.
* root node is tree starting point.
*
* @param string $name node name; default=''
* @return integer node ID
*/
function new_root_node($name = '')
{
$this->new_node(null,$this->ROOT_NODE_TYPE_ID,$name,1);
return $this->db->insert_id($this->object_table);
}
/*
function: new_node
creates a new node in the hierarchy table.
root node is tree starting point.
args : parent_id: node id of new node parent
node_type_id: node type
[name]: node name. default=''
[node_order]= order on tree structure. default=0
[node_id]= id to assign to new node, if you don't want
id bein created automatically.
default=0 -> id must be created automatically.
returns: node_id of the new node created
*/
function new_node($parent_id,$node_type_id,$name='',$node_order=0,$node_id=0)
{
$sql = "INSERT INTO {$this->object_table} " .
"(name,node_type_id,node_order";
$values=" VALUES('" . $this->db->prepare_string($name). "'," .
" {$node_type_id}," . intval($node_order);
if ($node_id)
{
$sql .= ",id";
$values .= ",{$node_id}";
}
if(is_null($parent_id))
{
$sql .= ") {$values} )";
}
else
{
$sql .= ",parent_id) {$values},{$parent_id})";
}
$this->db->exec_query($sql);
return ($this->db->insert_id($this->object_table));
}
/*
get all node hierarchy info from hierarchy table
returns: node_id of the new node created
*/
/*
function: get_node_hierarchy_info
returns the row from nodes_hierarchy table that has
node_id as id.
get all node hierarchy info from hierarchy table
args : node_id: node id
can be an array
[parent_id]
returns:
*/
function get_node_hierarchy_info($node_id,$parent_id = null,$options=null)
{
$debugMsg = 'Class:' . __CLASS__ . ' - Method: ' . __FUNCTION__;
$opt = array('nodeTypeID' => null, 'nodeType' => null,
'fields' => 'id,name,parent_id,node_type_id,node_order');
$opt = array_merge($opt, (array)$options);
$sql = "SELECT {$opt['fields']} " .
"FROM {$this->object_table} WHERE id";
$result=null;
if( is_array($node_id) )
{
$sql .= " IN (" . implode(",",$node_id) . ") ";
$result=$this->db->fetchRowsIntoMap($sql,'id');
}
else
{
$sql .= "= " . intval($node_id);
if( !is_null($parent_id) )
{
$sql .= " AND parent_id=" . intval($parent_id);
}
if( !is_null($opt['nodeTypeID']) )
{
$sql .= " AND node_type_id=" . intval($opt['nodeTypeID']);
}
if( !is_null($opt['nodeType']) )
{
$sql .= " AND node_type_id=" . intval($this->node_descr_id[$opt['nodeType']]);
}
$rs = $this->db->get_recordset($sql);
$result = !is_null($rs) ? $rs[0] : null;
}
return $result;
}
/*
function: get_subtree_list()
get a string representing a list, where elements are separated
by comma, with all nodes in tree starting on node_id.
node is can be considered as root of subtree.
args : node_id: root of subtree
node_type_id: null => no filter
if present ONLY NODES OF this type will be ANALIZED and traversed
Example:
TREE
|__ TSUITE_1
|
|__TSUITE_2
| |__TC_XZ
|
|__TC1
|__TC2
node_type_id = TC and ROOT=Tree => output=NULL
node_type_id = TC and ROOT=TSUITE_1 => output=TC1,TC2
output: null => list, not null => array
returns: output=null => list (string with nodes_id, using ',' as list separator).
output != null => array
*/
function get_subtree_list($node_id,$node_type_id=null,$output=null) {
$nodes = array();
$this->_get_subtree_list($node_id,$nodes,$node_type_id);
$node_list = is_null($output) ? implode(',',$nodes) : $nodes;
return($node_list);
}
/*
function: _get_subtree_list()
private function (name start with _), that using recursion
get an array with all nodes in tree starting on node_id.
node is can be considered as root of subtree.
args : node_id: root of subtree
returns: array with nodes_id
*/
function _get_subtree_list($node_id,&$node_list,$node_type_id=null)
{
$sql = "SELECT id from {$this->object_table} WHERE parent_id = {$node_id}";
if( !is_null($node_type_id) )
{
$sql .= " AND node_type_id = {$node_type_id} ";
}
$result = $this->db->exec_query($sql);
if (!$result || !$this->db->num_rows($result))
{
return;
}
while($row = $this->db->fetch_array($result))
{
$node_list[] = $row['id'];
$this->_get_subtree_list($row['id'],$node_list,$node_type_id);
}
}
/*
function: delete_subtree
delete all element on tree structure that forms a subtree
that has as root or starting point node_id.
args : node_id: root of subtree
returns: array with nodes_id
*/
function delete_subtree($node_id)
{
$debugMsg = 'Class:' . __CLASS__ . ' - Method: ' . __FUNCTION__;
$children = $this->get_subtree_list($node_id);
$id2del = $node_id;
if($children != "")
{
$id2del .= ",{$children}";
}
$sql = "/* $debugMsg */ DELETE FROM {$this->object_table} WHERE id IN ({$id2del})";
$result = $this->db->exec_query($sql);
}
/*
function: get_path
get list of nodes to traverse when you want to move
from node A (node at level N) to node B (node at level M),
where MUST BE ALLWAYS M < N, and remembering that level for root node is the minimun.
This means path on tree backwards (to the upper levels).
An array is used to represent list.
Last array element contains data regarding Node A, first element (element with index 0)
is data regarding child of node B.
What data is returned depends on value of optional argument 'format'.
Attention:
1 - destination node (node B) will be NOT INCLUDED in result.
2 - This is refactoring of original get_path method.
args : node_id: start of path
[to_node_id]: destination node. default null -> path to tree root.
[format]: default 'full'
defines type of elements of result array.
format='full'
Element is a map with following keys:
id
parent_id
node_type_id
node_order
node_table
name
Example
Is tree is :
null
\
id=1 <--- Tree Root
|
+ ------+
/ \ \
id=9 id=2 id=8
\
id=3
\
id=4
get_path(4), returns:
(
[0] => Array([id] => 2
[parent_id] => 1
[node_type_id] => 2
[node_order] => 1
[node_table] => testsuites
[name] => TS1)
[1] => Array([id] => 3
[parent_id] => 2
[node_type_id] => 2
[node_order] => 1
[node_table] => testsuites
[name] => TS2)
[2] => Array([id] => 4
[parent_id] => 3
[node_type_id] => 3
[node_order] => 0
[node_table] => testcases
[name] => TC1)
)
format='simple'
every element is a number=PARENT ID, array index = value
For the above example result will be:
(
[1] => 1
[2] => 2
[3] => 3
)
returns: array
*/
function get_path($node_id,$to_node_id = null,$format = 'full') {
$the_path = array();
$this->_get_path($node_id,$the_path,$to_node_id,$format);
if( !is_null($the_path) && count($the_path) > 0 ) {
$the_path = array_reverse($the_path);
}
return $the_path;
}
/**
*
*/
function get_path_new($node_id,$to_node_id = null,$format = 'full') {
$the_path = array();
$trip='';
$matrioska = array();
$this->_get_path($node_id,$the_path,$to_node_id,$format);
if( !is_null($the_path) && ($loop2do=count($the_path)) > 0 ) {
$the_path=array_reverse($the_path);
$matrioska = $the_path[0];
$matrioska['childNodes']=array();
$target = &$matrioska['childNodes'];
$trip = '';
for($idx=0; $idx < ($loop2do-1); $idx++)
{
$trip[] = $the_path[$idx]['id']; // . "({$idx})";
$target[0] = $the_path[$idx+1];
if($the_path[$idx+1]['node_table'] != 'testcases')
{
$target = &$target[0]['childNodes'];
}
}
}
return array($trip,$the_path);
}
/*
function: _get_path
This is refactoring of original get_path method.
Attention:
returns node in inverse order, that was done for original get_path
args : node_id: start of path
node_list: passed by reference, to build the result.
[to_node_id]: destination node. default null -> path to tree root.
[format]: default 'full'
returns: array
*/
function _get_path($node_id,&$node_list,$to_node_id=null,$format='full')
{
$debugMsg = 'Class:' . __CLASS__ . ' - Method: ' . __FUNCTION__;
// look up the parent of this node
$sql = "/* $debugMsg */ " .
" SELECT id,name,parent_id,node_type_id,node_order " .
" FROM {$this->object_table} WHERE id = " . intval($node_id);
$result = $this->db->exec_query($sql);
if( $this->db->num_rows($result) == 0 ) {
$node_list=null;
return;
}
while ( $row = $this->db->fetch_array($result) ) {
// check & abort
if ($row['parent_id'] == $row['id']) {
throw new Exception("id = parent_id = " . $row['id'], 1);
}
// only continue if this $node isn't the root node
// (that's the node with no parent)
if ($row['parent_id'] != '' && $row['id'] != $to_node_id) {
// the last part of the path to $node, is the name
// of the parent of $node
switch($format) {
case 'full':
$row['node_table'] = $this->node_tables_by['id'][$row['node_type_id']];
$node_list[] = $row;
break;
case 'simple':
// Warning: starting node is NOT INCLUDED in node_list
$node_list[$row['parent_id']] = $row['parent_id'];
break;
case 'points':
$node_list[] = $row['id'];
break;
case 'simple_me':
if( is_null($node_list) ) {
$node_list[$row['id']] = $row['id'];
} else {
$node_list[$row['parent_id']] = $row['parent_id'];
}
break;
case 'name':
$node_list[] = $row['name'];
break;
}
// we should add the path to the parent of this node to the path
$this->_get_path($row['parent_id'],$node_list,$to_node_id,$format);
}
}
}
/*
function: change_parent
change node parent, using this method you implement move operation.
args : node_id: node/nodes that need(s) to changed.
mixed type: single id or array containing set of id.
parent_id: new parent
returns: 1 -> operation OK
*/
function change_parent($node_id, $parent_id)
{
$debugMsg='Class:' .__CLASS__ . ' - Method:' . __FUNCTION__ . ' :: ';
if( is_array($node_id) )
{
$id_list = implode(",",$node_id);
$where_clause = " WHERE id IN ($id_list) ";
}
else
{
$where_clause=" WHERE id = {$node_id}";
}
$sql = "/* $debugMsg */ UPDATE {$this->object_table} " .
" SET parent_id = " . $this->db->prepare_int($parent_id) . " {$where_clause}";
$result = $this->db->exec_query($sql);
return $result ? 1 : 0;
}
/*
function: get_children
get nodes that have id as parent node.
Children can be filtering according to node type.
args : id: node
[exclude_node_types]: map
key: verbose description of node type to exclude.
see get_available_node_types.
value: anything is ok
returns: array of maps that contain children nodes.
map structure:
id
name
parent_id
node_type_id
node_order
node_table
*/
function get_children($id,$exclude_node_types=null,$opt=null) {
$debugMsg = 'Class:' . __CLASS__ . ' - Method: ' . __FUNCTION__;
$my['opt'] = array('accessKey' => null);
$my['opt'] = array_merge($my['opt'], (array)$opt);
$sql = "/* $debugMsg */ " .
" SELECT id,name,parent_id,node_type_id,node_order FROM {$this->object_table} " .
" WHERE parent_id = " . $this->db->prepare_int($id) . " ORDER BY node_order,id";
$node_list=array();
$result = $this->db->exec_query($sql);
if( $this->db->num_rows($result) == 0 )
{
return(null);
}
$xdx = 0;
while ( $row = $this->db->fetch_array($result) )
{
if( !isset($exclude_node_types[$this->node_types[$row['node_type_id']]]))
{
$node_table = $this->node_tables_by['id'][$row['node_type_id']];
$ak = is_null($my['opt']['accessKey']) ? $xdx : $row[$my['opt']['accessKey']];
$node_list[$ak] = array('id' => $row['id'], 'parent_id' => $row['parent_id'],
'node_type_id' => $row['node_type_id'],
'node_order' => $row['node_order'],
'node_table' => $node_table,'name' => $row['name']);
$xdx++;
}
}
return $node_list;
}
/*
function: change_order_bulk
change order for all nodes is present in nodes array.
Order of node in tree, is set to position node has in nodes array.
args :
nodes: array where value is node_id. Node order = node position on array
returns: -
*/
function change_order_bulk($nodes)
{
foreach($nodes as $order => $node_id)
{
$order = abs(intval($order));
$node_id = intval($node_id);
$sql = "UPDATE {$this->object_table} SET node_order = {$order} WHERE id = {$node_id}";
$result = $this->db->exec_query($sql);
}
}
/*
function: change_child_order
will change order of children of parent id, to position
choosen node on top or bottom of children.
args:
parent_id: node used as root of a tree.
node_id: node which we want to reposition
$top_bottom: possible values 'top', 'bottom'
[exclude_node_types]: map
key: verbose description of node type to exclude.
see get_available_node_types.
value: anything is ok
returns: -
*/
function change_child_order($parent_id,$node_id,$top_bottom,$exclude_node_types=null)
{
$node_type_filter='';
if( !is_null($exclude_node_types) )
{
$types=implode("','",array_keys($exclude_node_types));
$node_type_filter=" AND NT.description NOT IN ('{$types}') ";
}
$sql = " SELECT NH.id, NH.node_order, NH.name " .
" FROM {$this->object_table} NH, {$this->tables['node_types']} NT " .
" WHERE NH.node_type_id=NT.id " .
" AND NH.parent_id = {$parent_id} AND NH.id <> {$node_id} " .
$node_type_filter .
" ORDER BY NH.node_order,NH.id";
$children=$this->db->get_recordset($sql);
switch ($top_bottom)
{
case 'top':
$no[]=$node_id;
if( !is_null($children) )
{
foreach($children as $key => $value)
{
$no[]=$value['id'];
}
}
break;
case 'bottom':
$new_order=$this->getBottomOrder($parent_id)+1;
$no[$new_order]=$node_id;
break;
}
$this->change_order_bulk($no);
}
/*
function: getBottomOrder
given a node id to be used as parent, returns the max(node_order) from the children nodes.
We consider this bottom order.
args: parentID:
returns: order
*/
function getBottomOrder($parentID,$opt=null) {
$debugMsg='Class:' .__CLASS__ . ' - Method:' . __FUNCTION__ . ' :: ';
$my['opt'] = array();
$my['opt'] = array_merge(array('node_type' => null),(array)$opt);
$sql = "SELECT MAX(node_order) AS max_order" .
" FROM {$this->object_table} " .
" WHERE parent_id={$parentID} ";
if(!is_null($my['opt']['node_type'])) {
$sql .= " AND node_type_id = " . $this->node_descr_id[$my['opt']['node_type']];
}
$sql .= " GROUP BY parent_id ";
$rs=$this->db->get_recordset($sql);
return $rs[0]['max_order'];
}
/*
function: get_subtree
Giving a node_id, get the nodes that forma s subtree that
has node_id as root or starting point.
Is possible to exclude:
branches that has as staring node, node of certain types.
children of some node types.
full branches.
args :
[filters] map with following keys
[exclude_node_types]: map/hash.
default: null -> no exclusion filter will be applied.
Branches starting with nodes of type detailed, will not be
visited => no information will be returned.
key: verbose description of node type to exclude.
(see get_available_node_types).
value: can be any value, because is not used,anyway is suggested
to use 'exclude_me' as value.
Example:
array('testplan' => 'exclude_me')
Node of type tesplan, will be excluded.
[exclude_children_of]: map/hash
default: null -> no exclusion filter will be applied.
When traversing tree if the type of a node child, of node under analisys,
is contained in this map, traversing of branch starting with this child node
will not be done.
key: verbose description of node type to exclude.
(see get_available_node_types).
value: can be any value, because is not used,anyway is suggested
to use 'exclude_my_children' as value.
Example:
array('testcase' => 'exclude_my_children')
Children of testcase nodes, (tcversion nodes) will be EXCLUDED.
[exclude_branches]: map/hash.
default: null -> no exclusion filter will be applied.
key: node id.
value: anything is ok.
When traversing tree branches that have these node is, will
not be visited => no information will be retrieved.
[additionalWhereClause]: sql filter to include in sql sentence used to retrieve nodes.
default: null -> no action taken.
[family]: used to include guide the tree traversal.
map where key = node_id TO INCLUDE ON traversal
value = map where each key is a CHILD that HAS TO BE INCLUDED in return set.
[options]: map with following keys
[recursive]: changes structure of returned structure.
default: false -> a flat array will be generated
true -> a map with recursive structure will be generated.
false returns array, every element is a map with following keys:
id
parent_id
node_type_id
node_order
node_table
name
true returns a map, with only one element
key: childNodes.
value: array, that represents a tree branch.
Array elements are maps with following keys:
id
parent_id
node_type_id
node_order
node_table
name
childNodes -> (array)
returns: array or map
*/
function get_subtree($node_id,$filters=null,$options=null) {
$my['filters'] = array('exclude_node_types' => null, 'exclude_children_of' => null,
'exclude_branches' => null,'additionalWhereClause' => '', 'family' => null);
$my['options'] = array('recursive' => false, 'order_cfg' => array("type" =>'spec_order'),
'output' => 'essential', 'key_type' => 'std', 'addJoin' => '', 'addFields' => '');
// Cast to array to handle $options = null
$my['filters'] = array_merge($my['filters'], (array)$filters);
$my['options'] = array_merge($my['options'], (array)$options);
$the_subtree = array();
// Generate NOT IN CLAUSE to exclude some node types
// $not_in_clause = $my['filters']['additionalWhereClause'];
if(!is_null($my['filters']['exclude_node_types']))
{
$exclude = array();
foreach($my['filters']['exclude_node_types'] as $the_key => $elem)
{
$exclude[] = $this->node_descr_id[$the_key];
}
$my['filters']['additionalWhereClause'] .= " AND node_type_id NOT IN (" . implode(",",$exclude) . ")";
}
$method2call = $my['options']['recursive'] ? '_get_subtree_rec' : '_get_subtree';
$qnum = $this->$method2call($node_id,$the_subtree,$my['filters'],$my['options']);
return $the_subtree;
}
/**
*
*/
function _get_subtree($node_id,&$node_list,$filters = null, $options = null)
{
static $my;
if(!$my)
{
$my['filters'] = array('exclude_children_of' => null,'exclude_branches' => null,
'additionalWhereClause' => '', 'family' => null);
$my['options'] = array('order_cfg' => array("type" =>'spec_order'),
'output' => 'full', 'key_type' => 'std',
'addJoin' => '', 'addFields' => '');
}
$my['filters'] = array_merge($my['filters'], (array)$filters);
$my['options'] = array_merge($my['options'], (array)$options);
switch($my['options']['order_cfg']['type'])
{
case 'spec_order':
$sql = " SELECT id,name,parent_id,node_type_id,node_order " .
$my['options']['addFields'] .
" FROM {$this->object_table} {$my['options']['addJoin']} " .
" WHERE parent_id = {$node_id} " .
" {$my['filters']['additionalWhereClause']}" .
" ORDER BY node_order,id";
break;
case 'rspec':
$sql = " SELECT OBT.id,name,parent_id,node_type_id,node_order," .
" RSPEC.doc_id " .
" FROM {$this->object_table} AS OBT " .
" JOIN {$this->tables['req_specs']} AS RSPEC " .
" ON RSPEC.id = OBT.id " .
" WHERE parent_id = {$node_id} " .
" {$my['filters']['additionalWhereClause']}" .
" ORDER BY node_order,OBT.id";
break;
case 'exec_order':
// REMEMBER THAT DISTINCT IS NOT NEEDED when you does UNION WITHOUT ALL
//
// First query get Nodes that ARE NOT test case => test suites
// Second query get the TEST CASES
//
$sql = "SELECT * FROM ( SELECT NH.node_order AS spec_order," .
" NH.node_order AS node_order, NH.id, NH.parent_id," .
" NH.name, NH.node_type_id, 0 AS tcversion_id" .
" FROM {$this->object_table} NH, {$this->tables['node_types']} NT" .
" WHERE parent_id = {$node_id}" .
" AND NH.node_type_id=NT.id" .
" AND NT.description <> 'testcase' {$my['filters']['additionalWhereClause']}" .
" UNION" .
" SELECT NHA.node_order AS spec_order, " .
" T.node_order AS node_order, NHA.id, NHA.parent_id, " .
" NHA.name, NHA.node_type_id, T.tcversion_id" .
" FROM {$this->object_table} NHA, {$this->object_table} NHB," .
" {$this->tables['testplan_tcversions']} T,{$this->tables['node_types']} NT" .
" WHERE NHA.id=NHB.parent_id " .
" AND NHA.node_type_id=NT.id" .
" AND NHB.id=T.tcversion_id " .
" AND NT.description = 'testcase'" .
" AND NHA.parent_id = {$node_id}" .
" AND T.testplan_id = {$my['options']['order_cfg']['tplan_id']}) AC" .
" ORDER BY node_order,spec_order,id";
break;
case 'req_order':
$sql = " SELECT NH_TC.id,NH_TC.name,NH_TC.parent_id," .
" NH_TC.node_type_id,NH_TC.node_order " .
" {$my['options']['addFields']}" .
" FROM {$this->object_table} AS NH_TC " .
" {$my['options']['addJoin']} " .
" JOIN {$this->tables['req_coverage']} RC " .
" ON RC.testcase_id = NH_TC.id " .
" WHERE RC.req_id = {$node_id} " .
" {$my['filters']['additionalWhereClause']}" .
" ORDER BY NH_TC.node_order,NH_TC.id";
break;
}
$result = $this->db->exec_query($sql);
if( $this->db->num_rows($result) == 0 )
{
return;
}
while ( $row = $this->db->fetch_array($result) )
{
if( !isset($my['filters']['exclude_branches'][$row['id']]) )
{
$node_table = $this->node_tables[$this->node_types[$row['node_type_id']]];
switch($my['options']['output'])
{
case 'id':
$node_list[] = $row['id'];
break;
case 'essential':
$node_list[] = array('id' => $row['id'],
'parent_id' => $row['parent_id'],
'node_type_id' => $row['node_type_id'],
'node_order' => $row['node_order'],
'node_table' => $node_table,
'name' => $row['name']);
break;
case 'rspec':
$node_list[] = array('id' => $row['id'],
'parent_id' => $row['parent_id'],
'doc_id' => $row['doc_id'],
'node_type_id' => $row['node_type_id'],
'node_order' => $row['node_order'],
'node_table' => $node_table,
'name' => $row['name']);
break;
case 'full':
default:
// this choice
// 'tcversion_id' => (isset($row['parent_id']) ? $row['parent_id'] : -1),
// need to be documented and REVIEWED, because can generate confusion
$node_list[] = array('id' => $row['id'],
'parent_id' => $row['parent_id'],
'tcversion_id' => (isset($row['parent_id']) ? $row['parent_id'] : -1),
'node_type_id' => $row['node_type_id'],
'node_order' => $row['node_order'],
'node_table' => $node_table,
'name' => $row['name']);
break;
}
// Basically we use this because:
// 1. Sometimes we don't want the children if the parent is a testcase,
// due to the version management
//
// 2. Sometime we want to exclude all descendants (branch) of a node.
//
// [franciscom]: