-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
TreeBehavior.php
988 lines (873 loc) · 33.7 KB
/
TreeBehavior.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
<?php
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @since 3.0.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\ORM\Behavior;
use Cake\Database\Expression\IdentifierExpression;
use Cake\Datasource\EntityInterface;
use Cake\Datasource\Exception\RecordNotFoundException;
use Cake\Event\Event;
use Cake\ORM\Behavior;
use Cake\ORM\Query;
use InvalidArgumentException;
use RuntimeException;
/**
* Makes the table to which this is attached to behave like a nested set and
* provides methods for managing and retrieving information out of the derived
* hierarchical structure.
*
* Tables attaching this behavior are required to have a column referencing the
* parent row, and two other numeric columns (lft and rght) where the implicit
* order will be cached.
*
* For more information on what is a nested set and a how it works refer to
* http://www.sitepoint.com/hierarchical-data-database-2/
*/
class TreeBehavior extends Behavior
{
/**
* Cached copy of the first column in a table's primary key.
*
* @var string
*/
protected $_primaryKey;
/**
* Default config
*
* These are merged with user-provided configuration when the behavior is used.
*
* @var array
*/
protected $_defaultConfig = [
'implementedFinders' => [
'path' => 'findPath',
'children' => 'findChildren',
'treeList' => 'findTreeList'
],
'implementedMethods' => [
'childCount' => 'childCount',
'moveUp' => 'moveUp',
'moveDown' => 'moveDown',
'recover' => 'recover',
'removeFromTree' => 'removeFromTree',
'getLevel' => 'getLevel',
'formatTreeList' => 'formatTreeList'
],
'parent' => 'parent_id',
'left' => 'lft',
'right' => 'rght',
'scope' => null,
'level' => null,
'recoverOrder' => null
];
/**
* {@inheritDoc}
*/
public function initialize(array $config)
{
$this->_config['leftField'] = new IdentifierExpression($this->_config['left']);
$this->_config['rightField'] = new IdentifierExpression($this->_config['right']);
}
/**
* Before save listener.
* Transparently manages setting the lft and rght fields if the parent field is
* included in the parameters to be saved.
*
* @param \Cake\Event\Event $event The beforeSave event that was fired
* @param \Cake\Datasource\EntityInterface $entity the entity that is going to be saved
* @return void
* @throws \RuntimeException if the parent to set for the node is invalid
*/
public function beforeSave(Event $event, EntityInterface $entity)
{
$isNew = $entity->isNew();
$config = $this->config();
$parent = $entity->get($config['parent']);
$primaryKey = $this->_getPrimaryKey();
$dirty = $entity->dirty($config['parent']);
$level = $config['level'];
if ($isNew && $parent) {
if ($entity->get($primaryKey[0]) == $parent) {
throw new RuntimeException("Cannot set a node's parent as itself");
}
$parentNode = $this->_getNode($parent);
$edge = $parentNode->get($config['right']);
$entity->set($config['left'], $edge);
$entity->set($config['right'], $edge + 1);
$this->_sync(2, '+', ">= {$edge}");
if ($level) {
$entity->set($level, $parentNode[$level] + 1);
}
return;
}
if ($isNew && !$parent) {
$edge = $this->_getMax();
$entity->set($config['left'], $edge + 1);
$entity->set($config['right'], $edge + 2);
if ($level) {
$entity->set($level, 0);
}
return;
}
if (!$isNew && $dirty && $parent) {
$this->_setParent($entity, $parent);
if ($level) {
$parentNode = $this->_getNode($parent);
$entity->set($level, $parentNode[$level] + 1);
}
return;
}
if (!$isNew && $dirty && !$parent) {
$this->_setAsRoot($entity);
if ($level) {
$entity->set($level, 0);
}
}
}
/**
* After save listener.
*
* Manages updating level of descendents of currently saved entity.
*
* @param \Cake\Event\Event $event The beforeSave event that was fired
* @param \Cake\Datasource\EntityInterface $entity the entity that is going to be saved
* @return void
*/
public function afterSave(Event $event, EntityInterface $entity)
{
if (!$this->_config['level'] || $entity->isNew()) {
return;
}
$this->_setChildrenLevel($entity);
}
/**
* Set level for descendents.
*
* @param \Cake\Datasource\EntityInterface $entity The entity whose descendents need to be updated.
* @return void
*/
protected function _setChildrenLevel($entity)
{
$config = $this->config();
if ($entity->get($config['left']) + 1 === $entity->get($config['right'])) {
return;
}
$primaryKey = $this->_getPrimaryKey();
$primaryKeyValue = $entity->get($primaryKey);
$depths = [$primaryKeyValue => $entity->get($config['level'])];
$children = $this->_table->find('children', [
'for' => $primaryKeyValue,
'fields' => [$this->_getPrimaryKey(), $config['parent'], $config['level']],
'order' => $config['left']
]);
foreach ($children as $node) {
$parentIdValue = $node->get($config['parent']);
$depth = $depths[$parentIdValue] + 1;
$depths[$node->get($primaryKey)] = $depth;
$this->_table->updateAll(
[$config['level'] => $depth],
[$primaryKey => $node->get($primaryKey)]
);
}
}
/**
* Also deletes the nodes in the subtree of the entity to be delete
*
* @param \Cake\Event\Event $event The beforeDelete event that was fired
* @param \Cake\Datasource\EntityInterface $entity The entity that is going to be saved
* @return void
*/
public function beforeDelete(Event $event, EntityInterface $entity)
{
$config = $this->config();
$this->_ensureFields($entity);
$left = $entity->get($config['left']);
$right = $entity->get($config['right']);
$diff = $right - $left + 1;
if ($diff > 2) {
$this->_table->deleteAll(function ($exp) use ($config, $left, $right) {
return $exp
->gte($config['leftField'], $left + 1)
->lte($config['leftField'], $right - 1);
});
}
$this->_sync($diff, '-', "> {$right}");
}
/**
* Sets the correct left and right values for the passed entity so it can be
* updated to a new parent. It also makes the hole in the tree so the node
* move can be done without corrupting the structure.
*
* @param \Cake\Datasource\EntityInterface $entity The entity to re-parent
* @param mixed $parent the id of the parent to set
* @return void
* @throws \RuntimeException if the parent to set to the entity is not valid
*/
protected function _setParent($entity, $parent)
{
$config = $this->config();
$parentNode = $this->_getNode($parent);
$this->_ensureFields($entity);
$parentLeft = $parentNode->get($config['left']);
$parentRight = $parentNode->get($config['right']);
$right = $entity->get($config['right']);
$left = $entity->get($config['left']);
if ($parentLeft > $left && $parentLeft < $right) {
throw new RuntimeException(sprintf(
'Cannot use node "%s" as parent for entity "%s"',
$parent,
$entity->get($this->_getPrimaryKey())
));
}
// Values for moving to the left
$diff = $right - $left + 1;
$targetLeft = $parentRight;
$targetRight = $diff + $parentRight - 1;
$min = $parentRight;
$max = $left - 1;
if ($left < $targetLeft) {
// Moving to the right
$targetLeft = $parentRight - $diff;
$targetRight = $parentRight - 1;
$min = $right + 1;
$max = $parentRight - 1;
$diff *= -1;
}
if ($right - $left > 1) {
// Correcting internal subtree
$internalLeft = $left + 1;
$internalRight = $right - 1;
$this->_sync($targetLeft - $left, '+', "BETWEEN {$internalLeft} AND {$internalRight}", true);
}
$this->_sync($diff, '+', "BETWEEN {$min} AND {$max}");
if ($right - $left > 1) {
$this->_unmarkInternalTree();
}
// Allocating new position
$entity->set($config['left'], $targetLeft);
$entity->set($config['right'], $targetRight);
}
/**
* Updates the left and right column for the passed entity so it can be set as
* a new root in the tree. It also modifies the ordering in the rest of the tree
* so the structure remains valid
*
* @param \Cake\Datasource\EntityInterface $entity The entity to set as a new root
* @return void
*/
protected function _setAsRoot($entity)
{
$config = $this->config();
$edge = $this->_getMax();
$this->_ensureFields($entity);
$right = $entity->get($config['right']);
$left = $entity->get($config['left']);
$diff = $right - $left;
if ($right - $left > 1) {
//Correcting internal subtree
$internalLeft = $left + 1;
$internalRight = $right - 1;
$this->_sync($edge - $diff - $left, '+', "BETWEEN {$internalLeft} AND {$internalRight}", true);
}
$this->_sync($diff + 1, '-', "BETWEEN {$right} AND {$edge}");
if ($right - $left > 1) {
$this->_unmarkInternalTree();
}
$entity->set($config['left'], $edge - $diff);
$entity->set($config['right'], $edge);
}
/**
* Helper method used to invert the sign of the left and right columns that are
* less than 0. They were set to negative values before so their absolute value
* wouldn't change while performing other tree transformations.
*
* @return void
*/
protected function _unmarkInternalTree()
{
$config = $this->config();
$this->_table->updateAll(
function ($exp) use ($config) {
$leftInverse = clone $exp;
$leftInverse->type('*')->add('-1');
$rightInverse = clone $leftInverse;
return $exp
->eq($config['leftField'], $leftInverse->add($config['leftField']))
->eq($config['rightField'], $rightInverse->add($config['rightField']));
},
function ($exp) use ($config) {
return $exp->lt($config['leftField'], 0);
}
);
}
/**
* Custom finder method which can be used to return the list of nodes from the root
* to a specific node in the tree. This custom finder requires that the key 'for'
* is passed in the options containing the id of the node to get its path for.
*
* @param \Cake\ORM\Query $query The constructed query to modify
* @param array $options the list of options for the query
* @return \Cake\ORM\Query
* @throws \InvalidArgumentException If the 'for' key is missing in options
*/
public function findPath(Query $query, array $options)
{
if (empty($options['for'])) {
throw new InvalidArgumentException("The 'for' key is required for find('path')");
}
$config = $this->config();
list($left, $right) = array_map(
function ($field) {
return $this->_table->aliasField($field);
},
[$config['left'], $config['right']]
);
$node = $this->_table->get($options['for'], ['fields' => [$left, $right]]);
return $this->_scope($query)
->where([
"$left <=" => $node->get($config['left']),
"$right >=" => $node->get($config['right'])
])
->order([$left => 'ASC']);
}
/**
* Get the number of children nodes.
*
* @param \Cake\Datasource\EntityInterface $node The entity to count children for
* @param bool $direct whether to count all nodes in the subtree or just
* direct children
* @return int Number of children nodes.
*/
public function childCount(EntityInterface $node, $direct = false)
{
$config = $this->config();
$parent = $this->_table->aliasField($config['parent']);
if ($direct) {
return $this->_scope($this->_table->find())
->where([$parent => $node->get($this->_getPrimaryKey())])
->count();
}
$this->_ensureFields($node);
return ($node->get($config['right']) - $node->get($config['left']) - 1) / 2;
}
/**
* Get the children nodes of the current model
*
* Available options are:
*
* - for: The id of the record to read.
* - direct: Boolean, whether to return only the direct (true), or all (false) children,
* defaults to false (all children).
*
* If the direct option is set to true, only the direct children are returned (based upon the parent_id field)
*
* @param \Cake\ORM\Query $query Query.
* @param array $options Array of options as described above
* @return \Cake\ORM\Query
* @throws \InvalidArgumentException When the 'for' key is not passed in $options
*/
public function findChildren(Query $query, array $options)
{
$config = $this->config();
$options += ['for' => null, 'direct' => false];
list($parent, $left, $right) = array_map(
function ($field) {
return $this->_table->aliasField($field);
},
[$config['parent'], $config['left'], $config['right']]
);
list($for, $direct) = [$options['for'], $options['direct']];
if (empty($for)) {
throw new InvalidArgumentException("The 'for' key is required for find('children')");
}
if ($query->clause('order') === null) {
$query->order([$left => 'ASC']);
}
if ($direct) {
return $this->_scope($query)->where([$parent => $for]);
}
$node = $this->_getNode($for);
return $this->_scope($query)
->where([
"{$right} <" => $node->get($config['right']),
"{$left} >" => $node->get($config['left'])
]);
}
/**
* Gets a representation of the elements in the tree as a flat list where the keys are
* the primary key for the table and the values are the display field for the table.
* Values are prefixed to visually indicate relative depth in the tree.
*
* ### Options
*
* - keyPath: A dot separated path to fetch the field to use for the array key, or a closure to
* return the key out of the provided row.
* - valuePath: A dot separated path to fetch the field to use for the array value, or a closure to
* return the value out of the provided row.
* - spacer: A string to be used as prefix for denoting the depth in the tree for each item
*
* @param \Cake\ORM\Query $query Query.
* @param array $options Array of options as described above.
* @return \Cake\ORM\Query
*/
public function findTreeList(Query $query, array $options)
{
$results = $this->_scope($query)
->find('threaded', [
'parentField' => $this->config('parent'),
'order' => [$this->config('left') => 'ASC']
]);
return $this->formatTreeList($results, $options);
}
/**
* Formats query as a flat list where the keys are the primary key for the table
* and the values are the display field for the table. Values are prefixed to visually
* indicate relative depth in the tree.
*
* ### Options
*
* - keyPath: A dot separated path to the field that will be the result array key, or a closure to
* return the key from the provided row.
* - valuePath: A dot separated path to the field that is the array's value, or a closure to
* return the value from the provided row.
* - spacer: A string to be used as prefix for denoting the depth in the tree for each item.
*
* @param \Cake\ORM\Query $query The query object to format.
* @param array $options Array of options as described above.
* @return \Cake\ORM\Query Augmented query.
*/
public function formatTreeList(Query $query, array $options = [])
{
return $query->formatResults(function ($results) use ($options) {
$options += [
'keyPath' => $this->_getPrimaryKey(),
'valuePath' => $this->_table->displayField(),
'spacer' => '_'
];
return $results
->listNested()
->printer($options['valuePath'], $options['keyPath'], $options['spacer']);
});
}
/**
* Removes the current node from the tree, by positioning it as a new root
* and re-parents all children up one level.
*
* Note that the node will not be deleted just moved away from its current position
* without moving its children with it.
*
* @param \Cake\Datasource\EntityInterface $node The node to remove from the tree
* @return \Cake\ORM\Entity|false the node after being removed from the tree or
* false on error
*/
public function removeFromTree(EntityInterface $node)
{
return $this->_table->connection()->transactional(function () use ($node) {
$this->_ensureFields($node);
return $this->_removeFromTree($node);
});
}
/**
* Helper function containing the actual code for removeFromTree
*
* @param \Cake\Datasource\EntityInterface $node The node to remove from the tree
* @return \Cake\ORM\Entity|false the node after being removed from the tree or
* false on error
*/
protected function _removeFromTree($node)
{
$config = $this->config();
$left = $node->get($config['left']);
$right = $node->get($config['right']);
$parent = $node->get($config['parent']);
$node->set($config['parent'], null);
if ($right - $left == 1) {
return $this->_table->save($node);
}
$primary = $this->_getPrimaryKey();
$this->_table->updateAll(
[$config['parent'] => $parent],
[$config['parent'] => $node->get($primary)]
);
$this->_sync(1, '-', 'BETWEEN ' . ($left + 1) . ' AND ' . ($right - 1));
$this->_sync(2, '-', "> {$right}");
$edge = $this->_getMax();
$node->set($config['left'], $edge + 1);
$node->set($config['right'], $edge + 2);
$fields = [$config['parent'], $config['left'], $config['right']];
$this->_table->updateAll($node->extract($fields), [$primary => $node->get($primary)]);
foreach ($fields as $field) {
$node->dirty($field, false);
}
return $node;
}
/**
* Reorders the node without changing its parent.
*
* If the node is the first child, or is a top level node with no previous node
* this method will return false
*
* @param \Cake\Datasource\EntityInterface $node The node to move
* @param int|bool $number How many places to move the node, or true to move to first position
* @throws \Cake\Datasource\Exception\RecordNotFoundException When node was not found
* @return \Cake\ORM\Entity|bool $node The node after being moved or false on failure
*/
public function moveUp(EntityInterface $node, $number = 1)
{
if ($number < 1) {
return false;
}
return $this->_table->connection()->transactional(function () use ($node, $number) {
$this->_ensureFields($node);
return $this->_moveUp($node, $number);
});
}
/**
* Helper function used with the actual code for moveUp
*
* @param \Cake\Datasource\EntityInterface $node The node to move
* @param int|bool $number How many places to move the node, or true to move to first position
* @throws \Cake\Datasource\Exception\RecordNotFoundException When node was not found
* @return \Cake\ORM\Entity|bool $node The node after being moved or false on failure
*/
protected function _moveUp($node, $number)
{
$config = $this->config();
list($parent, $left, $right) = [$config['parent'], $config['left'], $config['right']];
list($nodeParent, $nodeLeft, $nodeRight) = array_values($node->extract([$parent, $left, $right]));
$targetNode = null;
if ($number !== true) {
$targetNode = $this->_scope($this->_table->find())
->select([$left, $right])
->where(["$parent IS" => $nodeParent])
->where(function ($exp) use ($config, $nodeLeft) {
return $exp->lt($config['rightField'], $nodeLeft);
})
->orderDesc($config['leftField'])
->offset($number - 1)
->limit(1)
->first();
}
if (!$targetNode) {
$targetNode = $this->_scope($this->_table->find())
->select([$left, $right])
->where(["$parent IS" => $nodeParent])
->where(function ($exp) use ($config, $nodeLeft) {
return $exp->lt($config['rightField'], $nodeLeft);
})
->orderAsc($config['leftField'])
->limit(1)
->first();
if (!$targetNode) {
return $node;
}
}
list($targetLeft) = array_values($targetNode->extract([$left, $right]));
$edge = $this->_getMax();
$leftBoundary = $targetLeft;
$rightBoundary = $nodeLeft - 1;
$nodeToEdge = $edge - $nodeLeft + 1;
$shift = $nodeRight - $nodeLeft + 1;
$nodeToHole = $edge - $leftBoundary + 1;
$this->_sync($nodeToEdge, '+', "BETWEEN {$nodeLeft} AND {$nodeRight}");
$this->_sync($shift, '+', "BETWEEN {$leftBoundary} AND {$rightBoundary}");
$this->_sync($nodeToHole, '-', "> {$edge}");
$node->set($left, $targetLeft);
$node->set($right, $targetLeft + ($nodeRight - $nodeLeft));
$node->dirty($left, false);
$node->dirty($right, false);
return $node;
}
/**
* Reorders the node without changing the parent.
*
* If the node is the last child, or is a top level node with no subsequent node
* this method will return false
*
* @param \Cake\Datasource\EntityInterface $node The node to move
* @param int|bool $number How many places to move the node or true to move to last position
* @throws \Cake\Datasource\Exception\RecordNotFoundException When node was not found
* @return \Cake\ORM\Entity|bool the entity after being moved or false on failure
*/
public function moveDown(EntityInterface $node, $number = 1)
{
if ($number < 1) {
return false;
}
return $this->_table->connection()->transactional(function () use ($node, $number) {
$this->_ensureFields($node);
return $this->_moveDown($node, $number);
});
}
/**
* Helper function used with the actual code for moveDown
*
* @param \Cake\Datasource\EntityInterface $node The node to move
* @param int|bool $number How many places to move the node, or true to move to last position
* @throws \Cake\Datasource\Exception\RecordNotFoundException When node was not found
* @return \Cake\ORM\Entity|bool $node The node after being moved or false on failure
*/
protected function _moveDown($node, $number)
{
$config = $this->config();
list($parent, $left, $right) = [$config['parent'], $config['left'], $config['right']];
list($nodeParent, $nodeLeft, $nodeRight) = array_values($node->extract([$parent, $left, $right]));
$targetNode = null;
if ($number !== true) {
$targetNode = $this->_scope($this->_table->find())
->select([$left, $right])
->where(["$parent IS" => $nodeParent])
->where(function ($exp) use ($config, $nodeRight) {
return $exp->gt($config['leftField'], $nodeRight);
})
->orderAsc($config['leftField'])
->offset($number - 1)
->limit(1)
->first();
}
if (!$targetNode) {
$targetNode = $this->_scope($this->_table->find())
->select([$left, $right])
->where(["$parent IS" => $nodeParent])
->where(function ($exp) use ($config, $nodeRight) {
return $exp->gt($config['leftField'], $nodeRight);
})
->orderDesc($config['leftField'])
->limit(1)
->first();
if (!$targetNode) {
return $node;
}
}
list(, $targetRight) = array_values($targetNode->extract([$left, $right]));
$edge = $this->_getMax();
$leftBoundary = $nodeRight + 1;
$rightBoundary = $targetRight;
$nodeToEdge = $edge - $nodeLeft + 1;
$shift = $nodeRight - $nodeLeft + 1;
$nodeToHole = $edge - $rightBoundary + $shift;
$this->_sync($nodeToEdge, '+', "BETWEEN {$nodeLeft} AND {$nodeRight}");
$this->_sync($shift, '-', "BETWEEN {$leftBoundary} AND {$rightBoundary}");
$this->_sync($nodeToHole, '-', "> {$edge}");
$node->set($left, $targetRight - ($nodeRight - $nodeLeft));
$node->set($right, $targetRight);
$node->dirty($left, false);
$node->dirty($right, false);
return $node;
}
/**
* Returns a single node from the tree from its primary key
*
* @param mixed $id Record id.
* @return \Cake\ORM\Entity
* @throws \Cake\Datasource\Exception\RecordNotFoundException When node was not found
*/
protected function _getNode($id)
{
$config = $this->config();
list($parent, $left, $right) = [$config['parent'], $config['left'], $config['right']];
$primaryKey = $this->_getPrimaryKey();
$fields = [$parent, $left, $right];
if ($config['level']) {
$fields[] = $config['level'];
}
$node = $this->_scope($this->_table->find())
->select($fields)
->where([$this->_table->aliasField($primaryKey) => $id])
->first();
if (!$node) {
throw new RecordNotFoundException("Node \"{$id}\" was not found in the tree.");
}
return $node;
}
/**
* Recovers the lft and right column values out of the hierarchy defined by the
* parent column.
*
* @return void
*/
public function recover()
{
$this->_table->connection()->transactional(function () {
$this->_recoverTree();
});
}
/**
* Recursive method used to recover a single level of the tree
*
* @param int $counter The Last left column value that was assigned
* @param mixed $parentId the parent id of the level to be recovered
* @param int $level Node level
* @return int The next value to use for the left column
*/
protected function _recoverTree($counter = 0, $parentId = null, $level = -1)
{
$config = $this->config();
list($parent, $left, $right) = [$config['parent'], $config['left'], $config['right']];
$primaryKey = $this->_getPrimaryKey();
$aliasedPrimaryKey = $this->_table->aliasField($primaryKey);
$order = $config['recoverOrder'] ?: $aliasedPrimaryKey;
$query = $this->_scope($this->_table->query())
->select([$aliasedPrimaryKey])
->where([$this->_table->aliasField($parent) . ' IS' => $parentId])
->order($order)
->hydrate(false);
$leftCounter = $counter;
$nextLevel = $level + 1;
foreach ($query as $row) {
$counter++;
$counter = $this->_recoverTree($counter, $row[$primaryKey], $nextLevel);
}
if ($parentId === null) {
return $counter;
}
$fields = [$left => $leftCounter, $right => $counter + 1];
if ($config['level']) {
$fields[$config['level']] = $level;
}
$this->_table->updateAll(
$fields,
[$primaryKey => $parentId]
);
return $counter + 1;
}
/**
* Returns the maximum index value in the table.
*
* @return int
*/
protected function _getMax()
{
$field = $this->_config['right'];
$rightField = $this->_config['rightField'];
$edge = $this->_scope($this->_table->find())
->select([$field])
->orderDesc($rightField)
->first();
if (empty($edge->{$field})) {
return 0;
}
return $edge->{$field};
}
/**
* Auxiliary function used to automatically alter the value of both the left and
* right columns by a certain amount that match the passed conditions
*
* @param int $shift the value to use for operating the left and right columns
* @param string $dir The operator to use for shifting the value (+/-)
* @param string $conditions a SQL snipped to be used for comparing left or right
* against it.
* @param bool $mark whether to mark the updated values so that they can not be
* modified by future calls to this function.
* @return void
*/
protected function _sync($shift, $dir, $conditions, $mark = false)
{
$config = $this->_config;
foreach ([$config['leftField'], $config['rightField']] as $field) {
$query = $this->_scope($this->_table->query());
$exp = $query->newExpr();
$movement = clone $exp;
$movement->add($field)->add("$shift")->tieWith($dir);
$inverse = clone $exp;
$movement = $mark ?
$inverse->add($movement)->tieWith('*')->add('-1'):
$movement;
$where = clone $exp;
$where->add($field)->add($conditions)->tieWith('');
$query->update()
->set($exp->eq($field, $movement))
->where($where);
$query->execute()->closeCursor();
}
}
/**
* Alters the passed query so that it only returns scoped records as defined
* in the tree configuration.
*
* @param \Cake\ORM\Query $query the Query to modify
* @return \Cake\ORM\Query
*/
protected function _scope($query)
{
$config = $this->config();
if (is_array($config['scope'])) {
return $query->where($config['scope']);
}
if (is_callable($config['scope'])) {
return $config['scope']($query);
}
return $query;
}
/**
* Ensures that the provided entity contains non-empty values for the left and
* right fields
*
* @param \Cake\Datasource\EntityInterface $entity The entity to ensure fields for
* @return void
*/
protected function _ensureFields($entity)
{
$config = $this->config();
$fields = [$config['left'], $config['right']];
$values = array_filter($entity->extract($fields));
if (count($values) === count($fields)) {
return;
}
$fresh = $this->_table->get($entity->get($this->_getPrimaryKey()), $fields);
$entity->set($fresh->extract($fields), ['guard' => false]);
foreach ($fields as $field) {
$entity->dirty($field, false);
}
}
/**
* Returns a single string value representing the primary key of the attached table
*
* @return string
*/
protected function _getPrimaryKey()
{
if (!$this->_primaryKey) {
$this->_primaryKey = (array)$this->_table->primaryKey();
$this->_primaryKey = $this->_primaryKey[0];
}
return $this->_primaryKey;
}
/**
* Returns the depth level of a node in the tree.
*
* @param int|string|\Cake\Datasource\EntityInterface $entity The entity or primary key get the level of.
* @return int|bool Integer of the level or false if the node does not exist.
*/
public function getLevel($entity)
{
$primaryKey = $this->_getPrimaryKey();
$id = $entity;
if ($entity instanceof EntityInterface) {
$id = $entity->get($primaryKey);
}
$config = $this->config();
$entity = $this->_table->find('all')
->select([$config['left'], $config['right']])
->where([$primaryKey => $id])
->first();
if ($entity === null) {
return false;
}
$query = $this->_table->find('all')->where([
$config['left'] . ' <' => $entity[$config['left']],
$config['right'] . ' >' => $entity[$config['right']]
]);
return $this->_scope($query)->count();
}
}