Subversion Repositories SmartDukaan

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
13532 anikendra 1
<?php
2
/**
3
 * Tree behavior class.
4
 *
5
 * Enables a model object to act as a node-based tree.
6
 *
7
 * CakePHP :  Rapid Development Framework (http://cakephp.org)
8
 * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
9
 *
10
 * Licensed under The MIT License
11
 * For full copyright and license information, please see the LICENSE.txt
12
 * Redistributions of files must retain the above copyright notice.
13
 *
14
 * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
15
 * @link          http://cakephp.org CakePHP Project
16
 * @package       Cake.Model.Behavior
17
 * @since         CakePHP v 1.2.0.4487
18
 * @license       http://www.opensource.org/licenses/mit-license.php MIT License
19
 */
20
 
21
App::uses('ModelBehavior', 'Model');
22
 
23
/**
24
 * Tree Behavior.
25
 *
26
 * Enables a model object to act as a node-based tree. Using Modified Preorder Tree Traversal
27
 *
28
 * @see http://en.wikipedia.org/wiki/Tree_traversal
29
 * @package       Cake.Model.Behavior
30
 * @link http://book.cakephp.org/2.0/en/core-libraries/behaviors/tree.html
31
 */
32
class TreeBehavior extends ModelBehavior {
33
 
34
/**
35
 * Errors
36
 *
37
 * @var array
38
 */
39
	public $errors = array();
40
 
41
/**
42
 * Defaults
43
 *
44
 * @var array
45
 */
46
	protected $_defaults = array(
47
		'parent' => 'parent_id', 'left' => 'lft', 'right' => 'rght',
48
		'scope' => '1 = 1', 'type' => 'nested', '__parentChange' => false, 'recursive' => -1
49
	);
50
 
51
/**
52
 * Used to preserve state between delete callbacks.
53
 *
54
 * @var array
55
 */
56
	protected $_deletedRow = array();
57
 
58
/**
59
 * Initiate Tree behavior
60
 *
61
 * @param Model $Model instance of model
62
 * @param array $config array of configuration settings.
63
 * @return void
64
 */
65
	public function setup(Model $Model, $config = array()) {
66
		if (isset($config[0])) {
67
			$config['type'] = $config[0];
68
			unset($config[0]);
69
		}
70
		$settings = array_merge($this->_defaults, $config);
71
 
72
		if (in_array($settings['scope'], $Model->getAssociated('belongsTo'))) {
73
			$data = $Model->getAssociated($settings['scope']);
74
			$Parent = $Model->{$settings['scope']};
75
			$settings['scope'] = $Model->escapeField($data['foreignKey']) . ' = ' . $Parent->escapeField();
76
			$settings['recursive'] = 0;
77
		}
78
		$this->settings[$Model->alias] = $settings;
79
	}
80
 
81
/**
82
 * After save method. Called after all saves
83
 *
84
 * Overridden to transparently manage setting the lft and rght fields if and only if the parent field is included in the
85
 * parameters to be saved.
86
 *
87
 * @param Model $Model Model instance.
88
 * @param boolean $created indicates whether the node just saved was created or updated
89
 * @param array $options Options passed from Model::save().
90
 * @return boolean true on success, false on failure
91
 */
92
	public function afterSave(Model $Model, $created, $options = array()) {
93
		extract($this->settings[$Model->alias]);
94
		if ($created) {
95
			if ((isset($Model->data[$Model->alias][$parent])) && $Model->data[$Model->alias][$parent]) {
96
				return $this->_setParent($Model, $Model->data[$Model->alias][$parent], $created);
97
			}
98
		} elseif ($this->settings[$Model->alias]['__parentChange']) {
99
			$this->settings[$Model->alias]['__parentChange'] = false;
100
			return $this->_setParent($Model, $Model->data[$Model->alias][$parent]);
101
		}
102
	}
103
 
104
/**
105
 * Runs before a find() operation
106
 *
107
 * @param Model $Model Model using the behavior
108
 * @param array $query Query parameters as set by cake
109
 * @return array
110
 */
111
	public function beforeFind(Model $Model, $query) {
112
		if ($Model->findQueryType === 'threaded' && !isset($query['parent'])) {
113
			$query['parent'] = $this->settings[$Model->alias]['parent'];
114
		}
115
		return $query;
116
	}
117
 
118
/**
119
 * Stores the record about to be deleted.
120
 *
121
 * This is used to delete child nodes in the afterDelete.
122
 *
123
 * @param Model $Model Model instance
124
 * @param boolean $cascade
125
 * @return boolean
126
 */
127
	public function beforeDelete(Model $Model, $cascade = true) {
128
		extract($this->settings[$Model->alias]);
129
		$data = $Model->find('first', array(
130
			'conditions' => array($Model->escapeField($Model->primaryKey) => $Model->id),
131
			'fields' => array($Model->escapeField($left), $Model->escapeField($right)),
132
			'recursive' => -1));
133
		if ($data) {
134
			$this->_deletedRow[$Model->alias] = current($data);
135
		}
136
		return true;
137
	}
138
 
139
/**
140
 * After delete method.
141
 *
142
 * Will delete the current node and all children using the deleteAll method and sync the table
143
 *
144
 * @param Model $Model Model instance
145
 * @return boolean true to continue, false to abort the delete
146
 */
147
	public function afterDelete(Model $Model) {
148
		extract($this->settings[$Model->alias]);
149
		$data = $this->_deletedRow[$Model->alias];
150
		$this->_deletedRow[$Model->alias] = null;
151
 
152
		if (!$data[$right] || !$data[$left]) {
153
			return true;
154
		}
155
		$diff = $data[$right] - $data[$left] + 1;
156
 
157
		if ($diff > 2) {
158
			if (is_string($scope)) {
159
				$scope = array($scope);
160
			}
161
			$scope[][$Model->escapeField($left) . " BETWEEN ? AND ?"] = array($data[$left] + 1, $data[$right] - 1);
162
			$Model->deleteAll($scope);
163
		}
164
		$this->_sync($Model, $diff, '-', '> ' . $data[$right]);
165
		return true;
166
	}
167
 
168
/**
169
 * Before save method. Called before all saves
170
 *
171
 * Overridden to transparently manage setting the lft and rght fields if and only if the parent field is included in the
172
 * parameters to be saved. For newly created nodes with NO parent the left and right field values are set directly by
173
 * this method bypassing the setParent logic.
174
 *
175
 * @since         1.2
176
 * @param Model $Model Model instance
177
 * @param array $options Options passed from Model::save().
178
 * @return boolean true to continue, false to abort the save
179
 * @see Model::save()
180
 */
181
	public function beforeSave(Model $Model, $options = array()) {
182
		extract($this->settings[$Model->alias]);
183
 
184
		$this->_addToWhitelist($Model, array($left, $right));
185
		if (!$Model->id || !$Model->exists()) {
186
			if (array_key_exists($parent, $Model->data[$Model->alias]) && $Model->data[$Model->alias][$parent]) {
187
				$parentNode = $Model->find('first', array(
188
					'conditions' => array($scope, $Model->escapeField() => $Model->data[$Model->alias][$parent]),
189
					'fields' => array($Model->primaryKey, $right), 'recursive' => $recursive
190
				));
191
				if (!$parentNode) {
192
					return false;
193
				}
194
				list($parentNode) = array_values($parentNode);
195
				$Model->data[$Model->alias][$left] = 0;
196
				$Model->data[$Model->alias][$right] = 0;
197
			} else {
198
				$edge = $this->_getMax($Model, $scope, $right, $recursive);
199
				$Model->data[$Model->alias][$left] = $edge + 1;
200
				$Model->data[$Model->alias][$right] = $edge + 2;
201
			}
202
		} elseif (array_key_exists($parent, $Model->data[$Model->alias])) {
203
			if ($Model->data[$Model->alias][$parent] != $Model->field($parent)) {
204
				$this->settings[$Model->alias]['__parentChange'] = true;
205
			}
206
			if (!$Model->data[$Model->alias][$parent]) {
207
				$Model->data[$Model->alias][$parent] = null;
208
				$this->_addToWhitelist($Model, $parent);
209
			} else {
210
				$values = $Model->find('first', array(
211
					'conditions' => array($scope, $Model->escapeField() => $Model->id),
212
					'fields' => array($Model->primaryKey, $parent, $left, $right), 'recursive' => $recursive)
213
				);
214
 
215
				if ($values === false) {
216
					return false;
217
				}
218
				list($node) = array_values($values);
219
 
220
				$parentNode = $Model->find('first', array(
221
					'conditions' => array($scope, $Model->escapeField() => $Model->data[$Model->alias][$parent]),
222
					'fields' => array($Model->primaryKey, $left, $right), 'recursive' => $recursive
223
				));
224
				if (!$parentNode) {
225
					return false;
226
				}
227
				list($parentNode) = array_values($parentNode);
228
 
229
				if (($node[$left] < $parentNode[$left]) && ($parentNode[$right] < $node[$right])) {
230
					return false;
231
				} elseif ($node[$Model->primaryKey] == $parentNode[$Model->primaryKey]) {
232
					return false;
233
				}
234
			}
235
		}
236
		return true;
237
	}
238
 
239
/**
240
 * Get the number of child nodes
241
 *
242
 * If the direct parameter is set to true, only the direct children are counted (based upon the parent_id field)
243
 * If false is passed for the id parameter, all top level nodes are counted, or all nodes are counted.
244
 *
245
 * @param Model $Model Model instance
246
 * @param integer|string|boolean $id The ID of the record to read or false to read all top level nodes
247
 * @param boolean $direct whether to count direct, or all, children
248
 * @return integer number of child nodes
249
 * @link http://book.cakephp.org/2.0/en/core-libraries/behaviors/tree.html#TreeBehavior::childCount
250
 */
251
	public function childCount(Model $Model, $id = null, $direct = false) {
252
		if (is_array($id)) {
253
			extract(array_merge(array('id' => null), $id));
254
		}
255
		if ($id === null && $Model->id) {
256
			$id = $Model->id;
257
		} elseif (!$id) {
258
			$id = null;
259
		}
260
		extract($this->settings[$Model->alias]);
261
 
262
		if ($direct) {
263
			return $Model->find('count', array('conditions' => array($scope, $Model->escapeField($parent) => $id)));
264
		}
265
 
266
		if ($id === null) {
267
			return $Model->find('count', array('conditions' => $scope));
268
		} elseif ($Model->id === $id && isset($Model->data[$Model->alias][$left]) && isset($Model->data[$Model->alias][$right])) {
269
			$data = $Model->data[$Model->alias];
270
		} else {
271
			$data = $Model->find('first', array('conditions' => array($scope, $Model->escapeField() => $id), 'recursive' => $recursive));
272
			if (!$data) {
273
				return 0;
274
			}
275
			$data = $data[$Model->alias];
276
		}
277
		return ($data[$right] - $data[$left] - 1) / 2;
278
	}
279
 
280
/**
281
 * Get the child nodes of the current model
282
 *
283
 * If the direct parameter is set to true, only the direct children are returned (based upon the parent_id field)
284
 * If false is passed for the id parameter, top level, or all (depending on direct parameter appropriate) are counted.
285
 *
286
 * @param Model $Model Model instance
287
 * @param integer|string $id The ID of the record to read
288
 * @param boolean $direct whether to return only the direct, or all, children
289
 * @param string|array $fields Either a single string of a field name, or an array of field names
290
 * @param string $order SQL ORDER BY conditions (e.g. "price DESC" or "name ASC") defaults to the tree order
291
 * @param integer $limit SQL LIMIT clause, for calculating items per page.
292
 * @param integer $page Page number, for accessing paged data
293
 * @param integer $recursive The number of levels deep to fetch associated records
294
 * @return array Array of child nodes
295
 * @link http://book.cakephp.org/2.0/en/core-libraries/behaviors/tree.html#TreeBehavior::children
296
 */
297
	public function children(Model $Model, $id = null, $direct = false, $fields = null, $order = null, $limit = null, $page = 1, $recursive = null) {
298
		if (is_array($id)) {
299
			extract(array_merge(array('id' => null), $id));
300
		}
301
		$overrideRecursive = $recursive;
302
 
303
		if ($id === null && $Model->id) {
304
			$id = $Model->id;
305
		} elseif (!$id) {
306
			$id = null;
307
		}
308
 
309
		extract($this->settings[$Model->alias]);
310
 
311
		if ($overrideRecursive !== null) {
312
			$recursive = $overrideRecursive;
313
		}
314
		if (!$order) {
315
			$order = $Model->escapeField($left) . " asc";
316
		}
317
		if ($direct) {
318
			$conditions = array($scope, $Model->escapeField($parent) => $id);
319
			return $Model->find('all', compact('conditions', 'fields', 'order', 'limit', 'page', 'recursive'));
320
		}
321
 
322
		if (!$id) {
323
			$conditions = $scope;
324
		} else {
325
			$result = array_values((array)$Model->find('first', array(
326
				'conditions' => array($scope, $Model->escapeField() => $id),
327
				'fields' => array($left, $right),
328
				'recursive' => $recursive
329
			)));
330
 
331
			if (empty($result) || !isset($result[0])) {
332
				return array();
333
			}
334
			$conditions = array($scope,
335
				$Model->escapeField($right) . ' <' => $result[0][$right],
336
				$Model->escapeField($left) . ' >' => $result[0][$left]
337
			);
338
		}
339
		return $Model->find('all', compact('conditions', 'fields', 'order', 'limit', 'page', 'recursive'));
340
	}
341
 
342
/**
343
 * A convenience method for returning a hierarchical array used for HTML select boxes
344
 *
345
 * @param Model $Model Model instance
346
 * @param string|array $conditions SQL conditions as a string or as an array('field' =>'value',...)
347
 * @param string $keyPath A string path to the key, i.e. "{n}.Post.id"
348
 * @param string $valuePath A string path to the value, i.e. "{n}.Post.title"
349
 * @param string $spacer The character or characters which will be repeated
350
 * @param integer $recursive The number of levels deep to fetch associated records
351
 * @return array An associative array of records, where the id is the key, and the display field is the value
352
 * @link http://book.cakephp.org/2.0/en/core-libraries/behaviors/tree.html#TreeBehavior::generateTreeList
353
 */
354
	public function generateTreeList(Model $Model, $conditions = null, $keyPath = null, $valuePath = null, $spacer = '_', $recursive = null) {
355
		$overrideRecursive = $recursive;
356
		extract($this->settings[$Model->alias]);
357
		if ($overrideRecursive !== null) {
358
			$recursive = $overrideRecursive;
359
		}
360
 
361
		$fields = null;
362
		if (!$keyPath && !$valuePath && $Model->hasField($Model->displayField)) {
363
			$fields = array($Model->primaryKey, $Model->displayField, $left, $right);
364
		}
365
 
366
		if (!$keyPath) {
367
			$keyPath = '{n}.' . $Model->alias . '.' . $Model->primaryKey;
368
		}
369
 
370
		if (!$valuePath) {
371
			$valuePath = array('%s%s', '{n}.tree_prefix', '{n}.' . $Model->alias . '.' . $Model->displayField);
372
 
373
		} elseif (is_string($valuePath)) {
374
			$valuePath = array('%s%s', '{n}.tree_prefix', $valuePath);
375
 
376
		} else {
377
			array_unshift($valuePath, '%s' . $valuePath[0], '{n}.tree_prefix');
378
		}
379
 
380
		$conditions = (array)$conditions;
381
		if ($scope) {
382
			$conditions[] = $scope;
383
		}
384
 
385
		$order = $Model->escapeField($left) . " asc";
386
		$results = $Model->find('all', compact('conditions', 'fields', 'order', 'recursive'));
387
		$stack = array();
388
 
389
		foreach ($results as $i => $result) {
390
			$count = count($stack);
391
			while ($stack && ($stack[$count - 1] < $result[$Model->alias][$right])) {
392
				array_pop($stack);
393
				$count--;
394
			}
395
			$results[$i]['tree_prefix'] = str_repeat($spacer, $count);
396
			$stack[] = $result[$Model->alias][$right];
397
		}
398
		if (empty($results)) {
399
			return array();
400
		}
401
		return Hash::combine($results, $keyPath, $valuePath);
402
	}
403
 
404
/**
405
 * Get the parent node
406
 *
407
 * reads the parent id and returns this node
408
 *
409
 * @param Model $Model Model instance
410
 * @param integer|string $id The ID of the record to read
411
 * @param string|array $fields
412
 * @param integer $recursive The number of levels deep to fetch associated records
413
 * @return array|boolean Array of data for the parent node
414
 * @link http://book.cakephp.org/2.0/en/core-libraries/behaviors/tree.html#TreeBehavior::getParentNode
415
 */
416
	public function getParentNode(Model $Model, $id = null, $fields = null, $recursive = null) {
417
		if (is_array($id)) {
418
			extract(array_merge(array('id' => null), $id));
419
		}
420
		$overrideRecursive = $recursive;
421
		if (empty($id)) {
422
			$id = $Model->id;
423
		}
424
		extract($this->settings[$Model->alias]);
425
		if ($overrideRecursive !== null) {
426
			$recursive = $overrideRecursive;
427
		}
428
		$parentId = $Model->find('first', array('conditions' => array($Model->primaryKey => $id), 'fields' => array($parent), 'recursive' => -1));
429
 
430
		if ($parentId) {
431
			$parentId = $parentId[$Model->alias][$parent];
432
			$parent = $Model->find('first', array('conditions' => array($Model->escapeField() => $parentId), 'fields' => $fields, 'recursive' => $recursive));
433
 
434
			return $parent;
435
		}
436
		return false;
437
	}
438
 
439
/**
440
 * Get the path to the given node
441
 *
442
 * @param Model $Model Model instance
443
 * @param integer|string $id The ID of the record to read
444
 * @param string|array $fields Either a single string of a field name, or an array of field names
445
 * @param integer $recursive The number of levels deep to fetch associated records
446
 * @return array Array of nodes from top most parent to current node
447
 * @link http://book.cakephp.org/2.0/en/core-libraries/behaviors/tree.html#TreeBehavior::getPath
448
 */
449
	public function getPath(Model $Model, $id = null, $fields = null, $recursive = null) {
450
		if (is_array($id)) {
451
			extract(array_merge(array('id' => null), $id));
452
		}
453
		$overrideRecursive = $recursive;
454
		if (empty($id)) {
455
			$id = $Model->id;
456
		}
457
		extract($this->settings[$Model->alias]);
458
		if ($overrideRecursive !== null) {
459
			$recursive = $overrideRecursive;
460
		}
461
		$result = $Model->find('first', array('conditions' => array($Model->escapeField() => $id), 'fields' => array($left, $right), 'recursive' => $recursive));
462
		if ($result) {
463
			$result = array_values($result);
464
		} else {
465
			return null;
466
		}
467
		$item = $result[0];
468
		$results = $Model->find('all', array(
469
			'conditions' => array($scope, $Model->escapeField($left) . ' <=' => $item[$left], $Model->escapeField($right) . ' >=' => $item[$right]),
470
			'fields' => $fields, 'order' => array($Model->escapeField($left) => 'asc'), 'recursive' => $recursive
471
		));
472
		return $results;
473
	}
474
 
475
/**
476
 * Reorder the node without changing the parent.
477
 *
478
 * If the node is the last child, or is a top level node with no subsequent node this method will return false
479
 *
480
 * @param Model $Model Model instance
481
 * @param integer|string $id The ID of the record to move
482
 * @param integer|boolean $number how many places to move the node or true to move to last position
483
 * @return boolean true on success, false on failure
484
 * @link http://book.cakephp.org/2.0/en/core-libraries/behaviors/tree.html#TreeBehavior::moveDown
485
 */
486
	public function moveDown(Model $Model, $id = null, $number = 1) {
487
		if (is_array($id)) {
488
			extract(array_merge(array('id' => null), $id));
489
		}
490
		if (!$number) {
491
			return false;
492
		}
493
		if (empty($id)) {
494
			$id = $Model->id;
495
		}
496
		extract($this->settings[$Model->alias]);
497
		list($node) = array_values($Model->find('first', array(
498
			'conditions' => array($scope, $Model->escapeField() => $id),
499
			'fields' => array($Model->primaryKey, $left, $right, $parent), 'recursive' => $recursive
500
		)));
501
		if ($node[$parent]) {
502
			list($parentNode) = array_values($Model->find('first', array(
503
				'conditions' => array($scope, $Model->escapeField() => $node[$parent]),
504
				'fields' => array($Model->primaryKey, $left, $right), 'recursive' => $recursive
505
			)));
506
			if (($node[$right] + 1) == $parentNode[$right]) {
507
				return false;
508
			}
509
		}
510
		$nextNode = $Model->find('first', array(
511
			'conditions' => array($scope, $Model->escapeField($left) => ($node[$right] + 1)),
512
			'fields' => array($Model->primaryKey, $left, $right), 'recursive' => $recursive)
513
		);
514
		if ($nextNode) {
515
			list($nextNode) = array_values($nextNode);
516
		} else {
517
			return false;
518
		}
519
		$edge = $this->_getMax($Model, $scope, $right, $recursive);
520
		$this->_sync($Model, $edge - $node[$left] + 1, '+', 'BETWEEN ' . $node[$left] . ' AND ' . $node[$right]);
521
		$this->_sync($Model, $nextNode[$left] - $node[$left], '-', 'BETWEEN ' . $nextNode[$left] . ' AND ' . $nextNode[$right]);
522
		$this->_sync($Model, $edge - $node[$left] - ($nextNode[$right] - $nextNode[$left]), '-', '> ' . $edge);
523
 
524
		if (is_int($number)) {
525
			$number--;
526
		}
527
		if ($number) {
528
			$this->moveDown($Model, $id, $number);
529
		}
530
		return true;
531
	}
532
 
533
/**
534
 * Reorder the node without changing the parent.
535
 *
536
 * If the node is the first child, or is a top level node with no previous node this method will return false
537
 *
538
 * @param Model $Model Model instance
539
 * @param integer|string $id The ID of the record to move
540
 * @param integer|boolean $number how many places to move the node, or true to move to first position
541
 * @return boolean true on success, false on failure
542
 * @link http://book.cakephp.org/2.0/en/core-libraries/behaviors/tree.html#TreeBehavior::moveUp
543
 */
544
	public function moveUp(Model $Model, $id = null, $number = 1) {
545
		if (is_array($id)) {
546
			extract(array_merge(array('id' => null), $id));
547
		}
548
		if (!$number) {
549
			return false;
550
		}
551
		if (empty($id)) {
552
			$id = $Model->id;
553
		}
554
		extract($this->settings[$Model->alias]);
555
		list($node) = array_values($Model->find('first', array(
556
			'conditions' => array($scope, $Model->escapeField() => $id),
557
			'fields' => array($Model->primaryKey, $left, $right, $parent), 'recursive' => $recursive
558
		)));
559
		if ($node[$parent]) {
560
			list($parentNode) = array_values($Model->find('first', array(
561
				'conditions' => array($scope, $Model->escapeField() => $node[$parent]),
562
				'fields' => array($Model->primaryKey, $left, $right), 'recursive' => $recursive
563
			)));
564
			if (($node[$left] - 1) == $parentNode[$left]) {
565
				return false;
566
			}
567
		}
568
		$previousNode = $Model->find('first', array(
569
			'conditions' => array($scope, $Model->escapeField($right) => ($node[$left] - 1)),
570
			'fields' => array($Model->primaryKey, $left, $right),
571
			'recursive' => $recursive
572
		));
573
 
574
		if ($previousNode) {
575
			list($previousNode) = array_values($previousNode);
576
		} else {
577
			return false;
578
		}
579
		$edge = $this->_getMax($Model, $scope, $right, $recursive);
580
		$this->_sync($Model, $edge - $previousNode[$left] + 1, '+', 'BETWEEN ' . $previousNode[$left] . ' AND ' . $previousNode[$right]);
581
		$this->_sync($Model, $node[$left] - $previousNode[$left], '-', 'BETWEEN ' . $node[$left] . ' AND ' . $node[$right]);
582
		$this->_sync($Model, $edge - $previousNode[$left] - ($node[$right] - $node[$left]), '-', '> ' . $edge);
583
		if (is_int($number)) {
584
			$number--;
585
		}
586
		if ($number) {
587
			$this->moveUp($Model, $id, $number);
588
		}
589
		return true;
590
	}
591
 
592
/**
593
 * Recover a corrupted tree
594
 *
595
 * The mode parameter is used to specify the source of info that is valid/correct. The opposite source of data
596
 * will be populated based upon that source of info. E.g. if the MPTT fields are corrupt or empty, with the $mode
597
 * 'parent' the values of the parent_id field will be used to populate the left and right fields. The missingParentAction
598
 * parameter only applies to "parent" mode and determines what to do if the parent field contains an id that is not present.
599
 *
600
 * @param Model $Model Model instance
601
 * @param string $mode parent or tree
602
 * @param string|integer $missingParentAction 'return' to do nothing and return, 'delete' to
603
 * delete, or the id of the parent to set as the parent_id
604
 * @return boolean true on success, false on failure
605
 * @link http://book.cakephp.org/2.0/en/core-libraries/behaviors/tree.html#TreeBehavior::recover
606
 */
607
	public function recover(Model $Model, $mode = 'parent', $missingParentAction = null) {
608
		if (is_array($mode)) {
609
			extract(array_merge(array('mode' => 'parent'), $mode));
610
		}
611
		extract($this->settings[$Model->alias]);
612
		$Model->recursive = $recursive;
613
		if ($mode === 'parent') {
614
			$Model->bindModel(array('belongsTo' => array('VerifyParent' => array(
615
				'className' => $Model->name,
616
				'foreignKey' => $parent,
617
				'fields' => array($Model->primaryKey, $left, $right, $parent),
618
			))));
619
			$missingParents = $Model->find('list', array(
620
				'recursive' => 0,
621
				'conditions' => array($scope, array(
622
					'NOT' => array($Model->escapeField($parent) => null), $Model->VerifyParent->escapeField() => null
623
				))
624
			));
625
			$Model->unbindModel(array('belongsTo' => array('VerifyParent')));
626
			if ($missingParents) {
627
				if ($missingParentAction === 'return') {
628
					foreach ($missingParents as $id => $display) {
629
						$this->errors[] = 'cannot find the parent for ' . $Model->alias . ' with id ' . $id . '(' . $display . ')';
630
					}
631
					return false;
632
				} elseif ($missingParentAction === 'delete') {
633
					$Model->deleteAll(array($Model->escapeField($Model->primaryKey) => array_flip($missingParents)), false);
634
				} else {
635
					$Model->updateAll(array($Model->escapeField($parent) => $missingParentAction), array($Model->escapeField($Model->primaryKey) => array_flip($missingParents)));
636
				}
637
			}
638
 
639
			$this->_recoverByParentId($Model);
640
		} else {
641
			$db = ConnectionManager::getDataSource($Model->useDbConfig);
642
			foreach ($Model->find('all', array('conditions' => $scope, 'fields' => array($Model->primaryKey, $parent), 'order' => $left)) as $array) {
643
				$path = $this->getPath($Model, $array[$Model->alias][$Model->primaryKey]);
644
				$parentId = null;
645
				if (count($path) > 1) {
646
					$parentId = $path[count($path) - 2][$Model->alias][$Model->primaryKey];
647
				}
648
				$Model->updateAll(array($parent => $db->value($parentId, $parent)), array($Model->escapeField() => $array[$Model->alias][$Model->primaryKey]));
649
			}
650
		}
651
		return true;
652
	}
653
 
654
/**
655
 * _recoverByParentId
656
 *
657
 * Recursive helper function used by recover
658
 *
659
 * @param Model $Model
660
 * @param integer $counter
661
 * @param mixed $parentId
662
 * @return integer $counter
663
 */
664
	protected function _recoverByParentId(Model $Model, $counter = 1, $parentId = null) {
665
		$params = array(
666
			'conditions' => array(
667
				$this->settings[$Model->alias]['parent'] => $parentId
668
			),
669
			'fields' => array($Model->primaryKey),
670
			'page' => 1,
671
			'limit' => 100,
672
			'order' => array($Model->primaryKey)
673
		);
674
 
675
		$scope = $this->settings[$Model->alias]['scope'];
676
		if ($scope && ($scope !== '1 = 1' && $scope !== true)) {
677
			$params['conditions'][] = $scope;
678
		}
679
 
680
		$children = $Model->find('all', $params);
681
		$hasChildren = (bool)$children;
682
 
683
		if ($parentId !== null) {
684
			if ($hasChildren) {
685
				$Model->updateAll(
686
					array($this->settings[$Model->alias]['left'] => $counter),
687
					array($Model->escapeField() => $parentId)
688
				);
689
				$counter++;
690
			} else {
691
				$Model->updateAll(
692
					array(
693
						$this->settings[$Model->alias]['left'] => $counter,
694
						$this->settings[$Model->alias]['right'] => $counter + 1
695
					),
696
					array($Model->escapeField() => $parentId)
697
				);
698
				$counter += 2;
699
			}
700
		}
701
 
702
		while ($children) {
703
			foreach ($children as $row) {
704
				$counter = $this->_recoverByParentId($Model, $counter, $row[$Model->alias][$Model->primaryKey]);
705
			}
706
 
707
			if (count($children) !== $params['limit']) {
708
				break;
709
			}
710
			$params['page']++;
711
			$children = $Model->find('all', $params);
712
		}
713
 
714
		if ($parentId !== null && $hasChildren) {
715
			$Model->updateAll(
716
				array($this->settings[$Model->alias]['right'] => $counter),
717
				array($Model->escapeField() => $parentId)
718
			);
719
			$counter++;
720
		}
721
 
722
		return $counter;
723
	}
724
 
725
/**
726
 * Reorder method.
727
 *
728
 * Reorders the nodes (and child nodes) of the tree according to the field and direction specified in the parameters.
729
 * This method does not change the parent of any node.
730
 *
731
 * Requires a valid tree, by default it verifies the tree before beginning.
732
 *
733
 * Options:
734
 *
735
 * - 'id' id of record to use as top node for reordering
736
 * - 'field' Which field to use in reordering defaults to displayField
737
 * - 'order' Direction to order either DESC or ASC (defaults to ASC)
738
 * - 'verify' Whether or not to verify the tree before reorder. defaults to true.
739
 *
740
 * @param Model $Model Model instance
741
 * @param array $options array of options to use in reordering.
742
 * @return boolean true on success, false on failure
743
 * @link http://book.cakephp.org/2.0/en/core-libraries/behaviors/tree.html#TreeBehavior::reorder
744
 */
745
	public function reorder(Model $Model, $options = array()) {
746
		$options = array_merge(array('id' => null, 'field' => $Model->displayField, 'order' => 'ASC', 'verify' => true), $options);
747
		extract($options);
748
		if ($verify && !$this->verify($Model)) {
749
			return false;
750
		}
751
		$verify = false;
752
		extract($this->settings[$Model->alias]);
753
		$fields = array($Model->primaryKey, $field, $left, $right);
754
		$sort = $field . ' ' . $order;
755
		$nodes = $this->children($Model, $id, true, $fields, $sort, null, null, $recursive);
756
 
757
		$cacheQueries = $Model->cacheQueries;
758
		$Model->cacheQueries = false;
759
		if ($nodes) {
760
			foreach ($nodes as $node) {
761
				$id = $node[$Model->alias][$Model->primaryKey];
762
				$this->moveDown($Model, $id, true);
763
				if ($node[$Model->alias][$left] != $node[$Model->alias][$right] - 1) {
764
					$this->reorder($Model, compact('id', 'field', 'order', 'verify'));
765
				}
766
			}
767
		}
768
		$Model->cacheQueries = $cacheQueries;
769
		return true;
770
	}
771
 
772
/**
773
 * Remove the current node from the tree, and reparent all children up one level.
774
 *
775
 * If the parameter delete is false, the node will become a new top level node. Otherwise the node will be deleted
776
 * after the children are reparented.
777
 *
778
 * @param Model $Model Model instance
779
 * @param integer|string $id The ID of the record to remove
780
 * @param boolean $delete whether to delete the node after reparenting children (if any)
781
 * @return boolean true on success, false on failure
782
 * @link http://book.cakephp.org/2.0/en/core-libraries/behaviors/tree.html#TreeBehavior::removeFromTree
783
 */
784
	public function removeFromTree(Model $Model, $id = null, $delete = false) {
785
		if (is_array($id)) {
786
			extract(array_merge(array('id' => null), $id));
787
		}
788
		extract($this->settings[$Model->alias]);
789
 
790
		list($node) = array_values($Model->find('first', array(
791
			'conditions' => array($scope, $Model->escapeField() => $id),
792
			'fields' => array($Model->primaryKey, $left, $right, $parent),
793
			'recursive' => $recursive
794
		)));
795
 
796
		if ($node[$right] == $node[$left] + 1) {
797
			if ($delete) {
798
				return $Model->delete($id);
799
			}
800
			$Model->id = $id;
801
			return $Model->saveField($parent, null);
802
		} elseif ($node[$parent]) {
803
			list($parentNode) = array_values($Model->find('first', array(
804
				'conditions' => array($scope, $Model->escapeField() => $node[$parent]),
805
				'fields' => array($Model->primaryKey, $left, $right),
806
				'recursive' => $recursive
807
			)));
808
		} else {
809
			$parentNode[$right] = $node[$right] + 1;
810
		}
811
 
812
		$db = ConnectionManager::getDataSource($Model->useDbConfig);
813
		$Model->updateAll(
814
			array($parent => $db->value($node[$parent], $parent)),
815
			array($Model->escapeField($parent) => $node[$Model->primaryKey])
816
		);
817
		$this->_sync($Model, 1, '-', 'BETWEEN ' . ($node[$left] + 1) . ' AND ' . ($node[$right] - 1));
818
		$this->_sync($Model, 2, '-', '> ' . ($node[$right]));
819
		$Model->id = $id;
820
 
821
		if ($delete) {
822
			$Model->updateAll(
823
				array(
824
					$Model->escapeField($left) => 0,
825
					$Model->escapeField($right) => 0,
826
					$Model->escapeField($parent) => null
827
				),
828
				array($Model->escapeField() => $id)
829
			);
830
			return $Model->delete($id);
831
		}
832
		$edge = $this->_getMax($Model, $scope, $right, $recursive);
833
		if ($node[$right] == $edge) {
834
			$edge = $edge - 2;
835
		}
836
		$Model->id = $id;
837
		return $Model->save(
838
			array($left => $edge + 1, $right => $edge + 2, $parent => null),
839
			array('callbacks' => false, 'validate' => false)
840
		);
841
	}
842
 
843
/**
844
 * Check if the current tree is valid.
845
 *
846
 * Returns true if the tree is valid otherwise an array of (type, incorrect left/right index, message)
847
 *
848
 * @param Model $Model Model instance
849
 * @return mixed true if the tree is valid or empty, otherwise an array of (error type [index, node],
850
 *  [incorrect left/right index,node id], message)
851
 * @link http://book.cakephp.org/2.0/en/core-libraries/behaviors/tree.html#TreeBehavior::verify
852
 */
853
	public function verify(Model $Model) {
854
		extract($this->settings[$Model->alias]);
855
		if (!$Model->find('count', array('conditions' => $scope))) {
856
			return true;
857
		}
858
		$min = $this->_getMin($Model, $scope, $left, $recursive);
859
		$edge = $this->_getMax($Model, $scope, $right, $recursive);
860
		$errors = array();
861
 
862
		for ($i = $min; $i <= $edge; $i++) {
863
			$count = $Model->find('count', array('conditions' => array(
864
				$scope, 'OR' => array($Model->escapeField($left) => $i, $Model->escapeField($right) => $i)
865
			)));
866
			if ($count != 1) {
867
				if (!$count) {
868
					$errors[] = array('index', $i, 'missing');
869
				} else {
870
					$errors[] = array('index', $i, 'duplicate');
871
				}
872
			}
873
		}
874
		$node = $Model->find('first', array('conditions' => array($scope, $Model->escapeField($right) . '< ' . $Model->escapeField($left)), 'recursive' => 0));
875
		if ($node) {
876
			$errors[] = array('node', $node[$Model->alias][$Model->primaryKey], 'left greater than right.');
877
		}
878
 
879
		$Model->bindModel(array('belongsTo' => array('VerifyParent' => array(
880
			'className' => $Model->name,
881
			'foreignKey' => $parent,
882
			'fields' => array($Model->primaryKey, $left, $right, $parent)
883
		))));
884
 
885
		foreach ($Model->find('all', array('conditions' => $scope, 'recursive' => 0)) as $instance) {
886
			if ($instance[$Model->alias][$left] === null || $instance[$Model->alias][$right] === null) {
887
				$errors[] = array('node', $instance[$Model->alias][$Model->primaryKey],
888
					'has invalid left or right values');
889
			} elseif ($instance[$Model->alias][$left] == $instance[$Model->alias][$right]) {
890
				$errors[] = array('node', $instance[$Model->alias][$Model->primaryKey],
891
					'left and right values identical');
892
			} elseif ($instance[$Model->alias][$parent]) {
893
				if (!$instance['VerifyParent'][$Model->primaryKey]) {
894
					$errors[] = array('node', $instance[$Model->alias][$Model->primaryKey],
895
						'The parent node ' . $instance[$Model->alias][$parent] . ' doesn\'t exist');
896
				} elseif ($instance[$Model->alias][$left] < $instance['VerifyParent'][$left]) {
897
					$errors[] = array('node', $instance[$Model->alias][$Model->primaryKey],
898
						'left less than parent (node ' . $instance['VerifyParent'][$Model->primaryKey] . ').');
899
				} elseif ($instance[$Model->alias][$right] > $instance['VerifyParent'][$right]) {
900
					$errors[] = array('node', $instance[$Model->alias][$Model->primaryKey],
901
						'right greater than parent (node ' . $instance['VerifyParent'][$Model->primaryKey] . ').');
902
				}
903
			} elseif ($Model->find('count', array('conditions' => array($scope, $Model->escapeField($left) . ' <' => $instance[$Model->alias][$left], $Model->escapeField($right) . ' >' => $instance[$Model->alias][$right]), 'recursive' => 0))) {
904
				$errors[] = array('node', $instance[$Model->alias][$Model->primaryKey], 'The parent field is blank, but has a parent');
905
			}
906
		}
907
		if ($errors) {
908
			return $errors;
909
		}
910
		return true;
911
	}
912
 
913
/**
914
 * Sets the parent of the given node
915
 *
916
 * The force parameter is used to override the "don't change the parent to the current parent" logic in the event
917
 * of recovering a corrupted table, or creating new nodes. Otherwise it should always be false. In reality this
918
 * method could be private, since calling save with parent_id set also calls setParent
919
 *
920
 * @param Model $Model Model instance
921
 * @param integer|string $parentId
922
 * @param boolean $created
923
 * @return boolean true on success, false on failure
924
 */
925
	protected function _setParent(Model $Model, $parentId = null, $created = false) {
926
		extract($this->settings[$Model->alias]);
927
		list($node) = array_values($Model->find('first', array(
928
			'conditions' => array($scope, $Model->escapeField() => $Model->id),
929
			'fields' => array($Model->primaryKey, $parent, $left, $right),
930
			'recursive' => $recursive
931
		)));
932
		$edge = $this->_getMax($Model, $scope, $right, $recursive, $created);
933
 
934
		if (empty($parentId)) {
935
			$this->_sync($Model, $edge - $node[$left] + 1, '+', 'BETWEEN ' . $node[$left] . ' AND ' . $node[$right], $created);
936
			$this->_sync($Model, $node[$right] - $node[$left] + 1, '-', '> ' . $node[$left], $created);
937
		} else {
938
			$values = $Model->find('first', array(
939
				'conditions' => array($scope, $Model->escapeField() => $parentId),
940
				'fields' => array($Model->primaryKey, $left, $right),
941
				'recursive' => $recursive
942
			));
943
 
944
			if ($values === false) {
945
				return false;
946
			}
947
			$parentNode = array_values($values);
948
 
949
			if (empty($parentNode) || empty($parentNode[0])) {
950
				return false;
951
			}
952
			$parentNode = $parentNode[0];
953
 
954
			if (($Model->id == $parentId)) {
955
				return false;
956
			} elseif (($node[$left] < $parentNode[$left]) && ($parentNode[$right] < $node[$right])) {
957
				return false;
958
			}
959
			if (empty($node[$left]) && empty($node[$right])) {
960
				$this->_sync($Model, 2, '+', '>= ' . $parentNode[$right], $created);
961
				$result = $Model->save(
962
					array($left => $parentNode[$right], $right => $parentNode[$right] + 1, $parent => $parentId),
963
					array('validate' => false, 'callbacks' => false)
964
				);
965
				$Model->data = $result;
966
			} else {
967
				$this->_sync($Model, $edge - $node[$left] + 1, '+', 'BETWEEN ' . $node[$left] . ' AND ' . $node[$right], $created);
968
				$diff = $node[$right] - $node[$left] + 1;
969
 
970
				if ($node[$left] > $parentNode[$left]) {
971
					if ($node[$right] < $parentNode[$right]) {
972
						$this->_sync($Model, $diff, '-', 'BETWEEN ' . $node[$right] . ' AND ' . ($parentNode[$right] - 1), $created);
973
						$this->_sync($Model, $edge - $parentNode[$right] + $diff + 1, '-', '> ' . $edge, $created);
974
					} else {
975
						$this->_sync($Model, $diff, '+', 'BETWEEN ' . $parentNode[$right] . ' AND ' . $node[$right], $created);
976
						$this->_sync($Model, $edge - $parentNode[$right] + 1, '-', '> ' . $edge, $created);
977
					}
978
				} else {
979
					$this->_sync($Model, $diff, '-', 'BETWEEN ' . $node[$right] . ' AND ' . ($parentNode[$right] - 1), $created);
980
					$this->_sync($Model, $edge - $parentNode[$right] + $diff + 1, '-', '> ' . $edge, $created);
981
				}
982
			}
983
		}
984
		return true;
985
	}
986
 
987
/**
988
 * get the maximum index value in the table.
989
 *
990
 * @param Model $Model
991
 * @param string $scope
992
 * @param string $right
993
 * @param integer $recursive
994
 * @param boolean $created
995
 * @return integer
996
 */
997
	protected function _getMax(Model $Model, $scope, $right, $recursive = -1, $created = false) {
998
		$db = ConnectionManager::getDataSource($Model->useDbConfig);
999
		if ($created) {
1000
			if (is_string($scope)) {
1001
				$scope .= " AND " . $Model->escapeField() . " <> ";
1002
				$scope .= $db->value($Model->id, $Model->getColumnType($Model->primaryKey));
1003
			} else {
1004
				$scope['NOT'][$Model->alias . '.' . $Model->primaryKey] = $Model->id;
1005
			}
1006
		}
1007
		$name = $Model->escapeField($right);
1008
		list($edge) = array_values($Model->find('first', array(
1009
			'conditions' => $scope,
1010
			'fields' => $db->calculate($Model, 'max', array($name, $right)),
1011
			'recursive' => $recursive,
1012
			'callbacks' => false
1013
		)));
1014
		return (empty($edge[$right])) ? 0 : $edge[$right];
1015
	}
1016
 
1017
/**
1018
 * get the minimum index value in the table.
1019
 *
1020
 * @param Model $Model
1021
 * @param string $scope
1022
 * @param string $left
1023
 * @param integer $recursive
1024
 * @return integer
1025
 */
1026
	protected function _getMin(Model $Model, $scope, $left, $recursive = -1) {
1027
		$db = ConnectionManager::getDataSource($Model->useDbConfig);
1028
		$name = $Model->escapeField($left);
1029
		list($edge) = array_values($Model->find('first', array(
1030
			'conditions' => $scope,
1031
			'fields' => $db->calculate($Model, 'min', array($name, $left)),
1032
			'recursive' => $recursive,
1033
			'callbacks' => false
1034
		)));
1035
		return (empty($edge[$left])) ? 0 : $edge[$left];
1036
	}
1037
 
1038
/**
1039
 * Table sync method.
1040
 *
1041
 * Handles table sync operations, Taking account of the behavior scope.
1042
 *
1043
 * @param Model $Model
1044
 * @param integer $shift
1045
 * @param string $dir
1046
 * @param array $conditions
1047
 * @param boolean $created
1048
 * @param string $field
1049
 * @return void
1050
 */
1051
	protected function _sync(Model $Model, $shift, $dir = '+', $conditions = array(), $created = false, $field = 'both') {
1052
		$ModelRecursive = $Model->recursive;
1053
		extract($this->settings[$Model->alias]);
1054
		$Model->recursive = $recursive;
1055
 
1056
		if ($field === 'both') {
1057
			$this->_sync($Model, $shift, $dir, $conditions, $created, $left);
1058
			$field = $right;
1059
		}
1060
		if (is_string($conditions)) {
1061
			$conditions = array($Model->escapeField($field) . " {$conditions}");
1062
		}
1063
		if (($scope !== '1 = 1' && $scope !== true) && $scope) {
1064
			$conditions[] = $scope;
1065
		}
1066
		if ($created) {
1067
			$conditions['NOT'][$Model->escapeField()] = $Model->id;
1068
		}
1069
		$Model->updateAll(array($Model->escapeField($field) => $Model->escapeField($field) . ' ' . $dir . ' ' . $shift), $conditions);
1070
		$Model->recursive = $ModelRecursive;
1071
	}
1072
 
1073
}