diff options
| author | Andreas Fischer <bantu@phpbb.com> | 2013-10-10 23:39:09 +0200 |
|---|---|---|
| committer | Andreas Fischer <bantu@phpbb.com> | 2013-10-10 23:39:09 +0200 |
| commit | 353ac33d5cea1752047779eb8c70c7ce3a64b6c8 (patch) | |
| tree | 76e08c4e16c68256700506b7111c3cbb547dc877 /phpBB/phpbb/tree/tree_interface.php | |
| parent | 0228424983e35badc779923a1f0398fc3ab7c8b2 (diff) | |
| parent | b59131f558a6d0fe4c836e2658152c8698f0cd22 (diff) | |
| download | forums-353ac33d5cea1752047779eb8c70c7ce3a64b6c8.tar forums-353ac33d5cea1752047779eb8c70c7ce3a64b6c8.tar.gz forums-353ac33d5cea1752047779eb8c70c7ce3a64b6c8.tar.bz2 forums-353ac33d5cea1752047779eb8c70c7ce3a64b6c8.tar.xz forums-353ac33d5cea1752047779eb8c70c7ce3a64b6c8.zip | |
Merge remote-tracking branch 'phpbb/develop' into ticket/11621
* phpbb/develop: (542 commits)
[ticket/11901] Pass empty string as relative_url for non-local magic URL.
[ticket/11898] Correct adm_relative_path created by installer
[ticket/11898] Correct admin S_LOGIN_ACTION
[ticket/11892] Fix undefined variables: to_forum_id & to_topic_id
[ticket/11890] Fix untranslated string when deleting posts through MCP.
[ticket/11895] Fix undefined $forum_id
[ticket/10383] Update the results without the overlay popup.
[ticket/10383] Make the content transitions smoother.
[ticket/10383] AJAXify poll voting
[ticket/11888] Update default search backend in namespaces migration
[ticket/11739] Rename “Remember Me” login keys module
[ticket/11893] Remove unnecessary <fieldset> causing a large font size
[ticket/11894] Fix typo in "Delete post" option
[ticket/11888] Use \phpbb\search\fulltext_native as search backend config
[ticket/11608] Mark failed test as incomplete for mysql search backend
[ticket/11608] Update search backend class names to namespaces
[ticket/11608] Move markIncomplete to search backends test
[ticket/11608] Rename base search test class file
[ticket/11608] Remove suffix test from base class
[ticket/11608] Mark postgres search not found test as incomplete
...
Diffstat (limited to 'phpBB/phpbb/tree/tree_interface.php')
| -rw-r--r-- | phpBB/phpbb/tree/tree_interface.php | 124 |
1 files changed, 124 insertions, 0 deletions
diff --git a/phpBB/phpbb/tree/tree_interface.php b/phpBB/phpbb/tree/tree_interface.php new file mode 100644 index 0000000000..162c1e5e29 --- /dev/null +++ b/phpBB/phpbb/tree/tree_interface.php @@ -0,0 +1,124 @@ +<?php +/** +* +* @package tree +* @copyright (c) 2013 phpBB Group +* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2 +* +*/ + +namespace phpbb\tree; + +/** +* @ignore +*/ +if (!defined('IN_PHPBB')) +{ + exit; +} + +interface tree_interface +{ + /** + * Inserts an item into the database table and into the tree. + * + * @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); + + /** + * 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); +} |