ignitercms /application/datamapper/nestedsets.php

Language PHP Lines 1398
MD5 Hash 1a7f7d12d3e6167a93b2cdd3e78c578c Estimated Cost $16,604 (why?)
Repository https://bitbucket.org/alexdeoliveira/ignitercms View Raw File View Project SPDX
   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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
<?php

/**
 * Nested Sets Extension for DataMapper classes.
 *
 * Nested Sets DataMapper model
 *
 * @license 	MIT License
 * @package		DMZ-Included-Extensions
 * @category	DMZ
 * @author  	WanWizard
 * @info		Based on nstrees by Rolf Brugger, edutech
 * 				http://www.edutech.ch/contribution/nstrees
 * @version 	1.0
 */

// --------------------------------------------------------------------------

/**
 * DMZ_Nestedsets Class
 *
 * @package		DMZ-Included-Extensions
 */
class DMZ_Nestedsets {

	/**
	 * name of the tree node left index field
	 *
	 * @var    string
	 * @access private
	 */
	private $_leftindex = 'left_id';

	/**
	 * name of the tree node right index field
	 *
	 * @var    string
	 * @access private
	 */
	private $_rightindex = 'right_id';

	/**
	 * name of the tree root id field. Used when the tree contains multiple roots
	 *
	 * @var    string
	 * @access private
	 */
	private $_rootfield = 'root_id';

	/**
	 * value of the root field we need to filter on
	 *
	 * @var    string
	 * @access private
	 */
	private $_rootindex = NULL;

	/**
	 * name of the tree node symlink index field
	 *
	 * @var    string
	 * @access private
	 */
	private $_symlinkindex = 'symlink_id';

	/**
	 * name of the tree node name field, used to build a path string
	 *
	 * @var    string
	 * @access private
	 */
	private $_nodename = NULL;

	/**
	 * indicates with pointers need to be used
	 *
	 * @var    string
	 * @access private
	 */
	private $use_symlink_pointers = TRUE;

	// -----------------------------------------------------------------

	/**
	 * Class constructor
	 *
	 * @param	mixed	optional, array of load-time options or NULL
	 * @param	object	the DataMapper object
	 * @return	void
	 * @access	public
	 */
	function __construct( $options = array(), $object = NULL )
	{
		// do we have the datamapper object
		if ( ! is_null($object) )
		{
			// update the config
			$this->tree_config($object, $options);
		}
	}

	// -----------------------------------------------------------------

	/**
	 * runtime configuration of this nestedsets tree
	 *
	 * @param	object	the DataMapper object
	 * @param	mixed	optional, array of options or NULL
	 * @return	object	the updated DataMapper object
	 * @access	public
	 */
	function tree_config($object, $options = array() )
	{
		// make sure the load-time options parameter is an array
		if ( ! is_array($options) )
		{
			$options = array();
		}

		// make sure the model options parameter is an array
		if ( ! isset($object->nestedsets) OR ! is_array($object->nestedsets) )
		{
			$object->nestedsets = array();
		}

		// loop through all options
		foreach( array( $object->nestedsets, $options ) as $optarray )
		{
			foreach( $optarray as $key => $value )
			{
				switch ( $key )
				{
					case 'name':
						$this->_nodename = (string) $value;
						break;
					case 'symlink':
						$this->_symlinkindex = (string) $value;
						break;
					case 'left':
						$this->_leftindex = (string) $value;
						break;
					case 'right':
						$this->_rightindex = (string) $value;
						break;
					case 'root':
						$this->_rootfield = (string) $value;
						break;
					case 'value':
						$this->_rootindex = (int) $value;
						break;
					case 'follow':
						$this->use_symlink_pointers = (bool) $value;
						break;
					default:
						break;
				}
			}
		}
	}

	// -----------------------------------------------------------------

	/**
	 * select a specific root if the table contains multiple trees
	 *
	 * @param	object	the DataMapper object
	 * @return	object	the updated DataMapper object
	 * @access	public
	 */
	function select_root($object, $tree = NULL)
	{
		// set the filter value
		$this->_rootindex = $tree;

		// return the object
		return $object;
	}

	// -----------------------------------------------------------------
	// Tree constructors
	// -----------------------------------------------------------------

	/**
	 * create a new tree root
	 *
	 * @param	object	the DataMapper object
	 * @return	object	the updated DataMapper object
	 * @access	public
	 */
	function new_root($object)
	{
		// set the pointers for the root object
		$object->id = NULL;
		$object->{$this->_leftindex} = 1;
		$object->{$this->_rightindex} = 2;

		// add a root index if needed
		if ( in_array($this->_rootfield, $object->fields) && ! is_null($this->_rootindex) )
		{
			$object->{$this->_rootfield} = $this->_rootindex;
		}

		// create the new tree root, and return the updated object
		return $this->_insertNew($object);
	}

	// -----------------------------------------------------------------

	/**
	 * creates a new first child of 'node'
	 *
	 * @param	object	the DataMapper object
	 * @param	object	the parent node
	 * @return	object	the updated DataMapper object
	 * @access	public
	 */
	function new_first_child($object, $node = NULL)
	{
		// a node passed?
		if ( is_null($node) )
		{
			// no, use the object itself
			$node = $object->get_clone();
		}

		// we need a valid node for this to work
		if ( ! $node->exists() )
		{
			return $node;
		}

		// set the pointers for the root object
		$object->id = NULL;
		$object->{$this->_leftindex} = $node->{$this->_leftindex} + 1;
		$object->{$this->_rightindex} = $node->{$this->_leftindex} + 2;

		// add a root index if needed
		if ( in_array($this->_rootfield, $object->fields) && ! is_null($this->_rootindex) )
		{
			$object->{$this->_rootfield} = $this->_rootindex;
		}

		// shift nodes to make room for the new child
		$this->_shiftRLValues($node, $object->{$this->_leftindex}, 2);

		// create the new tree node, and return the updated object
		return $this->_insertNew($object);
	}

	// -----------------------------------------------------------------

	/**
	 * creates a new last child of 'node'
	 *
	 * @param	object	the DataMapper object
	 * @param	object	the parent node
	 * @return	object	the updated DataMapper object
	 * @access	public
	 */
	function new_last_child($object, $node = NULL)
	{
		// a node passed?
		if ( is_null($node) )
		{
			// no, use the object itself
			$node = $object->get_clone();
		}

		// we need a valid node for this to work
		if ( ! $node->exists() )
		{
			return $node;
		}

		// set the pointers for the root object
		$object->id = NULL;
		$object->{$this->_leftindex} = $node->{$this->_rightindex};
		$object->{$this->_rightindex} = $node->{$this->_rightindex} + 1;

		// add a root index if needed
		if ( in_array($this->_rootfield, $object->fields) && ! is_null($this->_rootindex) )
		{
			$object->{$this->_rootfield} = $this->_rootindex;
		}

		// shift nodes to make room for the new child
		$this->_shiftRLValues($node, $object->{$this->_leftindex}, 2);

		// create the new tree node, and return the updated object
		return $this->_insertNew($object);
	}

	// -----------------------------------------------------------------

	/**
	 * creates a new sibling before 'node'
	 *
	 * @param	object	the DataMapper object
	 * @param	object	the sibling node
	 * @return	object	the updated DataMapper object
	 * @access	public
	 */
	function new_previous_sibling($object, $node = NULL)
	{
		// a node passed?
		if ( is_null($node) )
		{
			// no, use the object itself
			$node = $object->get_clone();
		}

		// we need a valid node for this to work
		if ( ! $node->exists() )
		{
			return $node;
		}

		// set the pointers for the root object
		$object->id = NULL;
		$object->{$this->_leftindex} = $node->{$this->_leftindex};
		$object->{$this->_rightindex} = $node->{$this->_leftindex} + 1;

		// add a root index if needed
		if ( in_array($this->_rootfield, $object->fields) && ! is_null($this->_rootindex) )
		{
			$object->{$this->_rootfield} = $this->_rootindex;
		}

		// shift nodes to make room for the new sibling
		$this->_shiftRLValues($node, $object->{$this->_leftindex}, 2);

		// create the new tree node, and return the updated object
		return $this->_insertNew($object);
	}

	// -----------------------------------------------------------------

	/**
	 * creates a new sibling after 'node'
	 *
	 * @param	object	the DataMapper object
	 * @param	object	the sibling node
	 * @return	object	the updated DataMapper object
	 * @access	public
	 */
	function new_next_sibling($object, $node = NULL)
	{
		// a node passed?
		if ( is_null($node) )
		{
			// no, use the object itself
			$node = $object->get_clone();
		}

		// we need a valid node for this to work
		if ( ! $node->exists() )
		{
			return $node;
		}

		// set the pointers for the root object
		$object->id = NULL;
		$object->{$this->_leftindex} = $node->{$this->_rightindex} + 1;
		$object->{$this->_rightindex} = $node->{$this->_rightindex} + 2;

		// add a root index if needed
		if ( in_array($this->_rootfield, $object->fields) && ! is_null($this->_rootindex) )
		{
			$object->{$this->_rootfield} = $this->_rootindex;
		}

		// shift nodes to make room for the new sibling
		$this->_shiftRLValues($node, $object->{$this->_leftindex}, 2);

		// create the new tree node, and return the updated object
		return $this->_insertNew($object);
	}

	// -----------------------------------------------------------------
	// Tree queries
	// -----------------------------------------------------------------


	/**
	 * returns the root of the (selected) tree
	 *
	 * @param	object	the DataMapper object
	 * @return	object	the updated DataMapper object
	 * @access	public
	 */
	function get_root($object)
	{
		// add a root index if needed
		if ( in_array($this->_rootfield, $object->fields) && ! is_null($this->_rootindex) )
		{
			$object->db->where($this->_rootfield, $this->_rootindex);
		}

		// get the tree's root node
		return $object->where($this->_leftindex, 1)->get();
	}

	// -----------------------------------------------------------------

	/**
	 * returns the parent of the child 'node'
	 *
	 * @param	object	the DataMapper object
	 * @param	object	the child node
	 * @return	object	the updated DataMapper object
	 * @access	public
	 */
	function get_parent($object, $node = NULL)
	{
		// a node passed?
		if ( is_null($node) )
		{
			// no, use the object itself
			$node =& $object;
		}

		// we need a valid node for this to work
		if ( ! $node->exists() )
		{
			return $node;
		}

		// add a root index if needed
		if ( in_array($this->_rootfield, $object->fields) && ! is_null($this->_rootindex) )
		{
			$object->db->where($this->_rootfield, $this->_rootindex);
		}

		// get the node's parent node
		$object->where($this->_leftindex . ' <', $node->{$this->_leftindex});
		$object->where($this->_rightindex . ' >', $node->{$this->_rightindex});
		return $object->order_by($this->_rightindex, 'asc')->limit(1)->get();
	}

	// -----------------------------------------------------------------

	/**
	 * returns the node with the requested left index pointer
	 *
	 * @param	object	the DataMapper object
	 * @param	integer	a node's left index value
	 * @return	object	the updated DataMapper object
	 * @access	public
	 */
	function get_node_where_left($object, $left_id)
	{
		// add a root index if needed
		if ( in_array($this->_rootfield, $object->fields) && ! is_null($this->_rootindex) )
		{
			$object->db->where($this->_rootfield, $this->_rootindex);
		}

		// get the node's parent node
		$object->where($this->_leftindex, $left_id);
		return $object->get();
	}

	// -----------------------------------------------------------------

	/**
	 * returns the node with the requested right index pointer
	 *
	 * @param	object	the DataMapper object
	 * @param	integer	a node's right index value
	 * @return	object	the updated DataMapper object
	 * @access	public
	 */
	function get_node_where_right($object, $right_id)
	{
		// add a root index if needed
		if ( in_array($this->_rootfield, $object->fields) && ! is_null($this->_rootindex) )
		{
			$object->db->where($this->_rootfield, $this->_rootindex);
		}

		// get the node's parent node
		$object->where($this->_rightindex, $right_id);
		return $object->get();
	}

	// -----------------------------------------------------------------

	/**
	 * returns the first child of the given node
	 *
	 * @param	object	the DataMapper object
	 * @param	object	the parent node
	 * @return	object	the updated DataMapper object
	 * @access	public
	 */
	function get_first_child($object, $node = NULL)
	{
		// a node passed?
		if ( is_null($node) )
		{
			// no, use the object itself
			$node =& $object;
		}

		// we need a valid node for this to work
		if ( ! $node->exists() )
		{
			return $node;
		}

		// add a root index if needed
		if ( in_array($this->_rootfield, $object->fields) && ! is_null($this->_rootindex) )
		{
			$object->db->where($this->_rootfield, $this->_rootindex);
		}

		// get the node's first child node
		$object->where($this->_leftindex, $node->{$this->_leftindex}+1);
		return $object->get();
	}

	// -----------------------------------------------------------------

	/**
	 * returns the last child of the given node
	 *
	 * @param	object	the DataMapper object
	 * @param	object	the parent node
	 * @return	object	the updated DataMapper object
	 * @access	public
	 */
	function get_last_child($object, $node = NULL)
	{
		// a node passed?
		if ( is_null($node) )
		{
			// no, use the object itself
			$node =& $object;
		}

		// we need a valid node for this to work
		if ( ! $node->exists() )
		{
			return $node;
		}

		// add a root index if needed
		if ( in_array($this->_rootfield, $object->fields) && ! is_null($this->_rootindex) )
		{
			$object->db->where($this->_rootfield, $this->_rootindex);
		}

		// get the node's last child node
		$object->where($this->_rightindex, $node->{$this->_rightindex}-1);
		return $object->get();
	}

	// -----------------------------------------------------------------

	/**
	 * returns the previous sibling of the given node
	 *
	 * @param	object	the DataMapper object
	 * @param	object	the sibling node
	 * @return	object	the updated DataMapper object
	 * @access	public
	 */
	function get_previous_sibling($object, $node = NULL)
	{
		// a node passed?
		if ( is_null($node) )
		{
			// no, use the object itself
			$node =& $object;
		}

		// we need a valid node for this to work
		if ( ! $node->exists() )
		{
			return $node;
		}

		// add a root index if needed
		if ( in_array($this->_rootfield, $object->fields) && ! is_null($this->_rootindex) )
		{
			$object->db->where($this->_rootfield, $this->_rootindex);
		}

		// get the node's previous sibling node
		$object->where($this->_rightindex, $node->{$this->_leftindex}-1);
		return $object->get();
	}

	// -----------------------------------------------------------------

	/**
	 * returns the next sibling of the given node
	 *
	 * @param	object	the DataMapper object
	 * @param	object	the sibling node
	 * @return	object	the updated DataMapper object
	 * @access	public
	 */
	function get_next_sibling($object, $node = NULL)
	{
		// a node passed?
		if ( is_null($node) )
		{
			// no, use the object itself
			$node =& $object;
		}

		// we need a valid node for this to work
		if ( ! $node->exists() )
		{
			return $node;
		}

		// add a root index if needed
		if ( in_array($this->_rootfield, $object->fields) && ! is_null($this->_rootindex) )
		{
			$object->db->where($this->_rootfield, $this->_rootindex);
		}

		// get the node's next sibling node
		$object->where($this->_leftindex, $node->{$this->_rightindex}+1);
		return $object->get();
	}

	// -----------------------------------------------------------------
	// Boolean tree functions
	// -----------------------------------------------------------------

	/**
	 * check if the object is a valid tree node
	 *
	 * @param	object	the DataMapper object
	 * @return	boolean
	 * @access	public
	 */
	function is_valid_node($object)
	{
		if ( ! $object->exists() )
		{
			return FALSE;
		}
		elseif ( ! isset($object->{$this->_leftindex}) OR ! is_numeric($object->{$this->_leftindex}) OR $object->{$this->_leftindex} <=0 )
		{
			return FALSE;
		}
		elseif ( ! isset($object->{$this->_rightindex}) OR ! is_numeric($object->{$this->_rightindex}) OR $object->{$this->_rightindex} <=0  )
		{
			return FALSE;
		}
		elseif ( $object->{$this->_leftindex} >= $object->{$this->_rightindex} )
		{
			return FALSE;
		}
		elseif ( ! empty($this->_rootfield) && ! in_array($this->_rootfield, $object->fields) )
		{
			return FALSE;
		}
		elseif ( ! empty($this->_rootfield) && ( ! is_numeric($object->{$this->_rootfield}) OR $object->{$this->_rootfield} <=0  ) )
		{
			return FALSE;
		}

		// all looks well...
		return TRUE;
	}

	// -----------------------------------------------------------------

	/**
	 * check if the object is a tree root
	 *
	 * @param	object	the DataMapper object
	 * @return	boolean
	 * @access	public
	 */
	function is_root($object)
	{
		return ( $object->exists() && $this->is_valid_node($object) && $object->{$this->_leftindex} == 1 );
	}

	// -----------------------------------------------------------------

	/**
	 * check if the object is a tree leaf (node with no children)
	 *
	 * @param	object	the DataMapper object
	 * @return	boolean
	 * @access	public
	 */
	function is_leaf($object)
	{
		return ( $object->exists() && $this->is_valid_node($object) && $object->{$this->_rightindex} - $object->{$this->_leftindex} == 1 );
	}

	// -----------------------------------------------------------------

	/**
	 * check if the object is a child node
	 *
	 * @param	object	the DataMapper object
	 * @return	boolean
	 * @access	public
	 */
	function is_child($object)
	{
		return ( $object->exists() && $this->is_valid_node($object) && $object->{$this->_leftindex} > 1 );
	}

	// -----------------------------------------------------------------

	/**
	 * check if the object is a child of node
	 *
	 * @param	object	the DataMapper object
	 * @param	object	the parent node
	 * @return	boolean
	 * @access	public
	 */
	function is_child_of($object, $node = NULL)
	{
		// validate the objects
		if ( ! $this->is_valid_node($object) OR ! $this->is_valid_node($node) )		{
			return FALSE;
		}

		return ( $object->{$this->_leftindex} > $node->{$this->_leftindex} && $object->{$this->_rightindex} < $node->{$this->_rightindex} );
	}

	// -----------------------------------------------------------------

	/**
	 * check if the object is the parent of node
	 *
	 * @param	object	the DataMapper object
	 * @param	object	the parent node
	 * @return	boolean
	 * @access	public
	 */
	function is_parent_of($object, $node = NULL)
	{
		// validate the objects
		if ( ! $this->is_valid_node($object) OR ! $this->is_valid_node($node) )
		{
			return FALSE;
		}

		// fetch the parent of our child node
		$parent = $node->get_clone()->get_parent();

		return ( $parent->id === $object->id );
	}

	// -----------------------------------------------------------------

	/**
	 * check if the object has a parent
	 *
	 * Note: this is an alias for is_child()
	 *
	 * @param	object	the DataMapper object
	 * @return	boolean
	 * @access	public
	 */
	function has_parent($object)
	{
		return $this->is_child($object);
	}

	// -----------------------------------------------------------------

	/**
	 * check if the object has children
	 *
	 * Note: this is an alias for ! is_leaf()
	 *
	 * @param	object	the DataMapper object
	 * @return	boolean
	 * @access	public
	 */
	function has_children($object)
	{
		return $this->is_leaf($object) ? FALSE : TRUE;
	}

	// -----------------------------------------------------------------

	/**
	 * check if the object has a previous silbling
	 *
	 * @param	object	the DataMapper object
	 * @return	boolean
	 * @access	public
	 */
	function has_previous_sibling($object)
	{
		// fetch the result using a clone
		$node = $object->get_clone();
		return $this->is_valid_node($node->get_previous_sibling($object));
	}

	// -----------------------------------------------------------------

	/**
	 * check if the object has a next silbling
	 *
	 * @param	object	the DataMapper object
	 * @return	boolean
	 * @access	public
	 */
	function has_next_sibling($object)
	{
		// fetch the result using a clone
		$node = $object->get_clone();
		return $this->is_valid_node($node->get_next_sibling($object));
	}

	// -----------------------------------------------------------------
	// Integer tree functions
	// -----------------------------------------------------------------

	/**
	 * return the count of the objects children
	 *
	 * @param	object	the DataMapper object
	 * @return	integer
	 * @access	public
	 */
	function count_children($object)
	{
		return ( $object->exists() ? (($object->{$this->_rightindex} - $object->{$this->_leftindex} - 1) / 2) : FALSE );
	}

	// -----------------------------------------------------------------

	/**
	 * return the node level, where the root = 0
	 *
	 * @param	object	the DataMapper object
	 * @return	mixed	integer, of FALSE in case no valid object was passed
	 * @access	public
	 */
	function level($object)
	{
		if ( $object->exists() )
		{
			// add a root index if needed
			if ( in_array($this->_rootfield, $object->fields) && ! is_null($this->_rootindex) )
			{
				$object->db->where($this->_rootfield, $this->_rootindex);
			}

			$object->where($this->_leftindex.' <', $object->{$this->_leftindex});
			$object->where($this->_rightindex.' >', $object->{$this->_rightindex});
			return $object->count();
		}
		else
		{
			return FALSE;
		}
	}

	// -----------------------------------------------------------------
	// Tree reorganisation
	// -----------------------------------------------------------------

	/**
	 * move the object as next sibling of 'node'
	 *
	 * @param	object	the DataMapper object
	 * @param	object	the sibling node
	 * @return	object	the updated DataMapper object
	 * @access	public
	 */
	function make_next_sibling_of($object, $node)
	{
		if ( ! $this->is_root($node) )
		{
			return $this->_moveSubtree($object, $node, $node->{$this->_rightindex}+1);
		}
		else
		{
			return FALSE;
		}
	}

	// -----------------------------------------------------------------

	/**
	 * move the object as previous sibling of 'node'
	 *
	 * @param	object	the DataMapper object
	 * @param	object	the sibling node
	 * @return	object	the updated DataMapper object
	 * @access	public
	 */
	function make_previous_sibling_of($object, $node)
	{
		if ( ! $this->is_root($node) )
		{
			return $this->_moveSubtree($object, $node, $node->{$this->_leftindex});
		}
		else
		{
			return FALSE;
		}
	}

	// -----------------------------------------------------------------

	/**
	 * move the object as first child of 'node'
	 *
	 * @param	object	the DataMapper object
	 * @param	object	the sibling node
	 * @return	object	the updated DataMapper object
	 * @access	public
	 */
	function make_first_child_of($object, $node)
	{
		return $this->_moveSubtree($object, $node, $node->{$this->_leftindex}+1);
	}

	// -----------------------------------------------------------------

	/**
	 * move the object as last child of 'node'
	 *
	 * @param	object	the DataMapper object
	 * @param	object	the sibling node
	 * @return	object	the updated DataMapper object
	 * @access	public
	 */
	function make_last_child_of($object, $node)
	{
		return $this->_moveSubtree($object, $node, $node->{$this->_rightindex});
	}

	// -----------------------------------------------------------------
	// Tree destructors
	// -----------------------------------------------------------------

	/**
	 * deletes the entire tree structure including all records
	 *
	 * @param	object	the DataMapper object
	 * @param	mixed	optional, id of the tree to delete
	 * @return	object	the updated DataMapper object
	 * @access	public
	 */
	function remove_tree($object, $tree_id = NULL)
	{
		// if we have multiple roots
		if ( in_array($this->_rootfield, $object->fields) )
		{
			// was a tree id passed?
			if ( ! is_null($tree_id) )
			{
				// only delete the selected one
				$object->db->where($this->_rootfield, $tree_id)->delete($object->table);
			}
			elseif ( ! is_null($this->_rootindex) )
			{
				// only delete the selected one
				$object->db->where($this->_rootfield, $this->_rootindex)->delete($object->table);
			}
			else
			{
				// delete them all
				$object->db->truncate($object->table);
			}
		}
		else
		{
			// delete them all
			$object->db->truncate($object->table);
		}

		// return the cleared object
		return $object->clear();
	}

	// -----------------------------------------------------------------

	/**
	 * deletes the current object, and all childeren
	 *
	 * @param	object	the DataMapper object
	 * @return	object	the updated DataMapper object
	 * @access	public
	 */
	function remove_node($object)
	{
		// we need a valid node to do this
		if ( $object->exists() )
		{
			// if we have multiple roots
			if ( in_array($this->_rootfield, $object->fields) && ! is_null($this->_rootindex) )
			{
				// only delete the selected one
				$object->db->where($this->_rootfield, $this->_rootindex);
			}

			// clone the object, we need to it shift later
			$clone = $object->get_clone();

			// select the node and all children
			$object->db->where($this->_leftindex . ' >=', $object->{$this->_leftindex});
			$object->db->where($this->_rightindex . ' <=', $object->{$this->_rightindex});

			// delete them all
			$object->db->delete($object->table);

			// re-index the tree
			$this->_shiftRLValues($clone, $object->{$this->_rightindex} + 1, $clone->{$this->_leftindex} - $object->{$this->_rightindex} -1);
		}

		// return the cleared object
		return $object->clear();
	}

	// -----------------------------------------------------------------
	// dump methods
	// -----------------------------------------------------------------

	/**
	 * returns the tree in a key-value format suitable for html dropdowns
	 *
	 * @param	object	the DataMapper object
	 * @param	string	optional, name of the column to use
	 * @param	boolean	if true, the object itself (root of the dump) will not be included
	 * @return	array
	 * @access	public
	 */
	public function dump_dropdown($object, $field = FALSE, $skip_root = TRUE)
	{
		// check if a specific field has been requested
		if ( empty($field) OR ! in_array($field, $object->fields) )
		{
			// no field given, check if a generic name is defined
			if ( ! empty($this->_nodename) )
			{
				// yes, so use it
				$field = $this->_nodename;
			}
			else
			{
				// can't continue without a name
				return FALSE;
			}
		}

		// fetch the tree as an array
		$tree = $this->dump_tree($object, NULL, 'array', $skip_root);

		// storage for the result
		$result = array();

		if ( $tree )
		{
			// loop trough the tree
			foreach ( $tree as $key => $value )
			{
				$result[$value['__id']] = str_repeat('&nbsp;', ($value['__level']) * 3) . ($value['__level'] ? '&raquo; ' : '') . $value[$field];
			}
		}

		// return the result
		return $result;
	}

	// -----------------------------------------------------------------

	/**
	 * dumps the entire tree in HTML or TAB formatted output
	 *
	 * @param	object	the DataMapper object
	 * @param	array	list of columns to include in the dump
	 * @param	string	type of output requested, possible values 'html', 'tab', 'csv', 'array' ('array' = default)
	 * @param	boolean	if true, the object itself (root of the dump) will not be included
	 * @return	mixed
	 * @access	public
	 */
	public function dump_tree($object, $attributes = NULL, $type = 'array', $skip_root = TRUE)
	{
		if ( $this->is_valid_node($object) )
		{
			// do we need a sub-selection of attributes?
			if ( is_array($attributes) )
			{
				// make sure required fields are present
				$fields = array_merge($attributes, array('id', $this->_leftindex, $this->_rightindex));
				if ( ! empty($this->_nodename) && ! isset($fields[$this->_nodename] ) )
				{
					$fields[] = $this->_nodename;
				}
				// add a select
				$object->db->select($fields);
			}

			// create the where clause for this query
			if ( $skip_root === TRUE )
			{
				// select only all children
				$object->db->where($this->_leftindex . ' >', $object->{$this->_leftindex});
				$object->db->where($this->_rightindex . ' <', $object->{$this->_rightindex});
				$level = -1;
			}
			else
			{
				// select the node and all children
				$object->db->where($this->_leftindex . ' >=', $object->{$this->_leftindex});
				$object->db->where($this->_rightindex . ' <=', $object->{$this->_rightindex});
				$level = -2;
			}

			// if we have multiple roots
			if ( in_array($this->_rootfield, $object->fields) && ! is_null($this->_rootindex) )
			{
				// only delete the selected one
				$object->db->where($this->_rootfield, $this->_rootindex);
			}

			// fetch the result
			$result = $object->db->order_by($this->_leftindex)->get($object->table)->result_array();

			// store the last left pointer
			$last_left = $object->{$this->_leftindex};

			// create the path
			if ( ! empty($this->_nodename) )
			{
				$path = array( $object->{$this->_nodename} );
			}
			else
			{
				$path = array();
			}

			// add level and path to the result
			foreach ( $result as $key => $value )
			{
				// for now, just store the ID
				$result[$key]['__id'] = $value['id'];

				// calculate the nest level of this node
				$level += $last_left - $value[$this->_leftindex] + 2;
				$last_left = $value[$this->_leftindex];
				$result[$key]['__level'] = $level;

				// create the relative path to this node
				$result[$key]['__path'] = '';
				if ( ! empty($this->_nodename) )
				{
					$path[$level] = $value[$this->_nodename];
					for ( $i = 0; $i <= $level; $i++ )
					{
						$result[$key]['__path'] .= '/' . $path[$i];
					}
				}
			}

			// convert the result to output
			if ( in_array($type, array('tab', 'csv', 'html')) )
			{
				// storage for the result
				$convert = '';

				// loop through the elements
				foreach ( $result as $key => $value )
				{
					// prefix based on requested type
					switch ($type)
					{
						case 'tab';
							$convert .= str_repeat("\t", $value['__level'] * 4 );
							break;
						case 'csv';
							break;
						case 'html';
							$convert .= str_repeat("&nbsp;", $value['__level'] * 4 );
							break;
					}

					// print the attributes requested
					if ( ! is_null($attributes) )
					{
						$att = reset($attributes);
						while($att){
							if ( is_numeric($value[$att]) )
							{
								$convert .= $value[$att];
							}
							else
							{
								$convert .= '"'.$value[$att].'"';
							}
							$att = next($attributes);
							if ($att)
							{
								$convert .= ($type == 'csv' ? "," : " ");
							}
						}
					}

					// postfix based on requested type
					switch ($type)
					{
						case 'tab';
							$convert .= "\n";
							break;
						case 'csv';
							$convert .= "\n";
							break;
						case 'html';
							$convert .= "<br />";
							break;
					}
				}
				return $convert;
			}
			else
			{
				return $result;
			}
		}

		return FALSE;
	}

	// -----------------------------------------------------------------
	// internal methods
	// -----------------------------------------------------------------

	/**
	 * makes room for a new node (or nodes) by shifting the left and right
	 * id's of nodes with larger values than our object by $delta
	 *
	 * note that $delta can also be negative!
	 *
	 * @param	object	the DataMapper object
	 * @param	integer	left value of the start node
	 * @param	integer	number of positions to shift
	 * @return	object	the updated DataMapper object
	 * @access	private
	 */
	private function _shiftRLValues($object, $first, $delta)
	{
		// we need a valid object
		if ( $object->exists() )
		{
			// if we have multiple roots
			if ( in_array($this->_rootfield, $object->fields) && ! is_null($this->_rootindex) )
			{
				// select the correct one
				$object->where($this->_rootfield, $this->_rootindex);
			}

			// set the delta
			$delta = $delta >= 0 ? (' + '.$delta) : (' - '.(abs($delta)));

			// select the range
			$object->where($this->_leftindex.' >=', $first);
			$object->update(array($this->_leftindex => $this->_leftindex.$delta), FALSE);

			// if we have multiple roots
			if ( in_array($this->_rootfield, $object->fields) && ! is_null($this->_rootindex) )
			{
				// select the correct one
				$object->where($this->_rootfield, $this->_rootindex);
			}

			// select the range
			$object->where($this->_rightindex.' >=', $first);

			$object->update(array($this->_rightindex => $this->_rightindex.$delta), FALSE);
		}

		// return the object
		return $object;
	}

	// -----------------------------------------------------------------

	/**
	 * shifts a range of nodes up or down the left and right index by $delta
	 *
	 * note that $delta can also be negative!
	 *
	 * @param	object	the DataMapper object
	 * @param	integer	left value of the start node
	 * @param	integer	right value of the end node
	 * @param	integer	number of positions to shift
	 * @return	object	the updated DataMapper object
	 * @access	private
	 */
	private function _shiftRLRange($object, $first, $last, $delta)
	{
		// we need a valid object
		if ( $object->exists() )
		{
			// if we have multiple roots
			if ( in_array($this->_rootfield, $object->fields) && ! is_null($this->_rootindex) )
			{
				// select the correct one
				$object->where($this->_rootfield, $this->_rootindex);
			}

			// select the range
			$object->where($this->_leftindex.' >=', $first);
			$object->where($this->_rightindex.' <=', $last);

			// set the delta
			$delta = $delta >= 0 ? (' + '.$delta) : (' - '.(abs($delta)));

			$object->update(array($this->_leftindex => $this->_leftindex.$delta, $this->_rightindex => $this->_rightindex.$delta), FALSE);
		}

		// return the object
		return $object;
	}

	// -----------------------------------------------------------------

	/**
	 * inserts a new record into the tree
	 *
	 * @param	object	the DataMapper object
	 * @return	object	the updated DataMapper object
	 * @access	private
	 */
	private function _insertNew($object)
	{
		// for now, just save the object
		$object->save();

		// return the object
		return $object;
	}

	// -----------------------------------------------------------------

	/**
	 * move a section of the tree to another location within the tree
	 *
	 * @param	object	the DataMapper object we're going to move
	 * @param	integer	the destination node's left id value
	 * @return	object	the updated DataMapper object
	 * @access	private
	 */
	private function _moveSubtree($object, $node, $destination_id)
	{
		// if we have multiple roots
		if ( in_array($this->_rootfield, $object->fields) )
		{
			// make sure both nodes are part of the same tree
			if ( $object->{$this->_rootfield} != $node->{$this->_rootfield} )
			{
				return FALSE;
			}
		}

		// determine the size of the tree to move
		$treesize = $object->{$this->_rightindex} - $object->{$this->_leftindex} + 1;

		// get the objects left- and right pointers
		$left_id = $object->{$this->_leftindex};
		$right_id = $object->{$this->_rightindex};

		// shift to make some space
		$this->_shiftRLValues($node, $destination_id, $treesize);

		// correct pointers if there were shifted to
		if ($object->{$this->_leftindex} >= $destination_id)
		{
			$left_id += $treesize;
			$right_id += $treesize;
		}

		// enough room now, start the move
		$this->_shiftRLRange($node, $left_id, $right_id, $destination_id - $left_id);

		// and correct index values after the source
		$this->_shiftRLValues($object, $right_id + 1, -$treesize);

		// return the object
		return $object->get_by_id($object->id);
	}

}

/* End of file nestedsets.php */
/* Location: ./application/datamapper/nestedsets.php */
Back to Top