aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/includes/nestedset/item/interface.php
diff options
context:
space:
mode:
authorJoas Schilling <nickvergessen@gmx.de>2013-04-16 23:07:48 +0200
committerJoas Schilling <nickvergessen@gmx.de>2013-04-16 23:07:48 +0200
commita1183a58894967bfec7da01c5004138e4daeb583 (patch)
tree94e80ed5b326c4febd82c01ee49f67c462a09738 /phpBB/includes/nestedset/item/interface.php
parenta0d10cd7fcf9449a025811f4adc1e9d8b1e5ac89 (diff)
downloadforums-a1183a58894967bfec7da01c5004138e4daeb583.tar
forums-a1183a58894967bfec7da01c5004138e4daeb583.tar.gz
forums-a1183a58894967bfec7da01c5004138e4daeb583.tar.bz2
forums-a1183a58894967bfec7da01c5004138e4daeb583.tar.xz
forums-a1183a58894967bfec7da01c5004138e4daeb583.zip
[ticket/11495] Add basic interface with nestedset operations
PHPBB3-11495
Diffstat (limited to 'phpBB/includes/nestedset/item/interface.php')
-rw-r--r--phpBB/includes/nestedset/item/interface.php61
1 files changed, 61 insertions, 0 deletions
diff --git a/phpBB/includes/nestedset/item/interface.php b/phpBB/includes/nestedset/item/interface.php
new file mode 100644
index 0000000000..18206d752e
--- /dev/null
+++ b/phpBB/includes/nestedset/item/interface.php
@@ -0,0 +1,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();
+}