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
|
<?php
/**
*
* @package Nested Set
* @copyright (c) 2013 phpBB Group
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
*
*/
/**
* @ignore
*/
if (!defined('IN_PHPBB'))
{
exit;
}
interface phpbb_nestedset_interface
{
/**
* Insert an item into the nested set (also insert the rows into the table)
*
* @param array $item The item to be added
* @return array Array with item data as set in the database
*/
public function insert(array $additional_data);
/**
* Add an item at the end of the nested set
*
* @param array $item The item to be added
* @return bool True if the item was added
*/
public function add(array $item);
/**
* Remove an item from the nested set
*
* Also removes all subitems from the nested set
*
* @param int $item_id The item to be deleted
* @return array Item ids that have been removed
*/
public function remove($item);
/**
* Delete an item from the nested set (also deletes the rows form the table)
*
* Also deletes all subitems from the nested set
*
* @param int $item_id The item to be deleted
* @return array Item ids that have been deleted
*/
public function delete($item);
/**
* Move an item by a given delta
*
* An item is only moved up/down within the same parent. If the delta is
* larger then the number of children, the item is moved to the top/bottom
* of the list of children within this parent.
*
* @param int $item_id The item to be moved
* @param int $delta Number of steps to move this item, < 0 => down, > 0 => up
* @return bool True if the item was moved
*/
public function move($item_id, $delta);
/**
* Move an item down by 1
*
* @param int $item_id The item to be moved
* @return bool True if the item was moved
*/
public function move_down($item_id);
/**
* Move an item up by 1
*
* @param int $item_id The item to be moved
* @return bool True if the item was moved
*/
public function move_up($item_id);
/**
* Moves all children of one item to another item
*
* If the new parent already has children, the new children are appended
* to the list.
*
* @param int $current_parent_id The current parent item
* @param int $new_parent_id The new parent item
* @return bool True if any items where moved
*/
public function move_children($current_parent_id, $new_parent_id);
/**
* Change parent item
*
* Moves the item to the bottom of the new parent's list of children
*
* @param int $item_id The item to be moved
* @param int $new_parent_id The new parent item
* @return bool True if the parent was set successfully
*/
public function change_parent($item, $new_parent_id);
/**
* Get children and parent branch of the item
*
* @param int $item_id The item id to get the parents/children from
* @param bool $order_desc Order the items descending (most outer parent first)
* @param bool $include_item Should the item (matching the given item id) be included in the list aswell
* @return array Array of items (containing all columns from the item table)
* ID => Item data
*/
public function get_full_branch_data($item_id, $order_desc, $include_item);
/**
* Get parent branch of the item
*
* @param int $item_id The item id to get the parents from
* @param bool $order_desc Order the items descending (most outer parent first)
* @param bool $include_item Should the item (matching the given item id) be included in the list aswell
* @return array Array of items (containing all columns from the item table)
* ID => Item data
*/
public function get_parent_branch_data($item_id, $order_desc, $include_item);
/**
* Get children branch of the item
*
* @param int $item_id The item id to get the children from
* @param bool $order_desc Order the items descending (most outer parent first)
* @param bool $include_item Should the item (matching the given item id) be included in the list aswell
* @return array Array of items (containing all columns from the item table)
* ID => Item data
*/
public function get_children_branch_data($item_id, $order_desc, $include_item);
/**
* Get base information of parent items
*
* @param array $item The item to get the branch from
* @return array Array of items (containing basic columns from the item table)
* ID => Item data
*/
public function get_parent_data(array $item);
/**
* Regenerate left/right ids from parent/child relationship
*
* This method regenerates the left/right ids for the nested set based on
* the parent/child relations. This function executes three queries per
* item, so it should only be called, when the set has one of the following
* problems:
* - The set has a duplicated value inside the left/right id chain
* - The set has a missing value inside the left/right id chain
* - The set has items that do not have a left/right is set
*
* When regenerating the items, the items are sorted by parent id and their
* current left id, so the current child/parent relationships are kept
* and running the function on a working set will not change any orders.
*
* @param int $new_id First left_id to be used (should start with 1)
* @param int $parent_id parent_id of the current set (default = 0)
* @param bool $reset_ids Should we reset all left_id/right_id on the first call?
* @return int $new_id The next left_id/right_id that should be used
*/
public function regenerate_left_right_ids($new_id, $parent_id = 0, $reset_ids = false);
}
|
