aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/includes/nestedset/item/interface.php
blob: 18206d752e4e15b13e0ff905e35c85bc0b64fd22 (plain)
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
<?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_item_interface
{
	/**
	* Returns the ID of the item
	*
	* @return int
	*/
	public function get_item_id();

	/**
	* Returns the ID of the parent item
	*
	* @return int
	*/
	public function get_parent_id();

	/**
	* Returns a serialized or empty string with the data of the item's parents
	*
	* @return string
	*/
	public function get_item_parents_data();

	/**
	* Returns the left_id of the item
	*
	* @return int
	*/
	public function get_left_id();

	/**
	* Returns the right_id of the item
	*
	* @return int
	*/
	public function get_right_id();

	/**
	* Does the item have sub-items?
	*
	* @return bool
	*/
	public function has_children();
}