FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
phpbb/phpBB/phpbb/tree/tree_interface.php at master · ctrstudio/phpbb · GitHub
ctrstudio
/
phpbb
Public
forked from
phpbb/phpbb
Notifications
You must be signed in to change notification settings
Fork
0
Star
0
Code
Pull requests
0
Actions
Projects
Security and quality
0
Insights
Additional navigation options
Code
Pull requests
Actions
Projects
Security and quality
Insights
Expand file tree
Breadcrumbs
phpbb
/
phpBB
/
phpbb
/
tree
/
tree_interface.php
Copy path
More file actions
More file actions
Latest commit
History
History
History
120 lines (109 loc) · 3.71 KB
Breadcrumbs
phpbb
/
phpBB
/
phpbb
/
tree
/
tree_interface.php
Copy path
File metadata and controls
120 lines (109 loc) · 3.71 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace
phpbb
\
tree
;
interface
tree_interface
{
/**
* Inserts an item into the database table and into the tree.
*
* @param array $additional_data The item to be added
* @return array Array with item data as set in the database
*/
public
function
insert
(
array
$
additional_data
);
/**
* Delete an item from the tree and from the database table
*
* Also deletes the subtree from the tree and from the database table
*
* @param int $item_id The item to be deleted
* @return array Item ids that have been deleted
*/
public
function
delete
(
$
item_id
);
/**
* 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_id
,
$
new_parent_id
);
/**
* Get all items that are either ancestors or descendants of the item
*
* @param int $item_id Id of the item to retrieve the ancestors/descendants from
* @param bool $order_asc Order the items ascendingly (most outer ancestor first)
* @param bool $include_item Should the item matching the given item id be included in the list as well
* @return array Array of items (containing all columns from the item table)
* ID => Item data
*/
public
function
get_path_and_subtree_data
(
$
item_id
,
$
order_asc
,
$
include_item
);
/**
* Get all of the item's ancestors
*
* @param int $item_id Id of the item to retrieve the ancestors from
* @param bool $order_asc Order the items ascendingly (most outer ancestor first)
* @param bool $include_item Should the item matching the given item id be included in the list as well
* @return array Array of items (containing all columns from the item table)
* ID => Item data
*/
public
function
get_path_data
(
$
item_id
,
$
order_asc
,
$
include_item
);
/**
* Get all of the item's descendants
*
* @param int $item_id Id of the item to retrieve the descendants from
* @param bool $order_asc Order the items ascendingly
* @param bool $include_item Should the item matching the given item id be included in the list as well
* @return array Array of items (containing all columns from the item table)
* ID => Item data
*/
public
function
get_subtree_data
(
$
item_id
,
$
order_asc
,
$
include_item
);
}
Back
|
FazBrowse Home
|
New Git URL