makary/phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-10 05:18:52 +00:00
Code Issues Projects Releases Packages Wiki Activity

[ticket/11495] Fix some docs and replace branch with other terms

Browse source 
PHPBB3-11495
This commit is contained in:
Joas Schilling 2013-04-30 10:32:01 +02:00
parent 2afa673023
commit 8a4260703f
3 changed files with 34 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
phpBB/includes/tree/interface.php
View file

@ -28,12 +28,12 @@ interface phpbb_tree_interface
/** /**
* Delete an item from the tree and from the database table * Delete an item from the tree and from the database table
* *
* Also deletes all subitems 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 * @param int $item_id The item to be deleted
* @return array Item ids that have been deleted * @return array Item ids that have been deleted
*/ */
public function delete($item); public function delete($item_id);
/** /**
* Move an item by a given delta * Move an item by a given delta
@ -79,16 +79,16 @@ interface phpbb_tree_interface
/** /**
* Change parent item * Change parent item
* *
* Moves the item to the bottom of the new parent's list of children * Moves the item to the bottom of the new parent's subtree
* *
* @param int $item_id The item to be moved * @param int $item_id The item to be moved
* @param int $new_parent_id The new parent item * @param int $new_parent_id The new parent item
* @return bool True if the parent was set successfully * @return bool True if the parent was set successfully
*/ */
public function change_parent($item, $new_parent_id); public function change_parent($item_id, $new_parent_id);
/** /**
* Get children and parent branch of the item * Get all items that are either a parent or part of the subtree of the item
* *
* @param int $item_id The item id to get the parents/children from * @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 $order_desc Order the items descending (most outer parent first)
@ -96,10 +96,10 @@ interface phpbb_tree_interface
* @return array Array of items (containing all columns from the item table) * @return array Array of items (containing all columns from the item table)
* ID => Item data * ID => Item data
*/ */
public function get_full_branch_data($item_id, $order_desc, $include_item); public function get_path_and_subtree_data($item_id, $order_desc, $include_item);
/** /**
* Get parent branch of the item * Get all parent items of the item
* *
* @param int $item_id The item id to get the parents from * @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 $order_desc Order the items descending (most outer parent first)
@ -107,10 +107,10 @@ interface phpbb_tree_interface
* @return array Array of items (containing all columns from the item table) * @return array Array of items (containing all columns from the item table)
* ID => Item data * ID => Item data
*/ */
public function get_parent_branch_data($item_id, $order_desc, $include_item); public function get_path_data($item_id, $order_desc, $include_item);
/** /**
* Get children branch of the item * Get all items of the item's subtree
* *
* @param int $item_id The item id to get the children from * @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 $order_desc Order the items descending (most outer parent first)
@ -118,7 +118,7 @@ interface phpbb_tree_interface
* @return array Array of items (containing all columns from the item table) * @return array Array of items (containing all columns from the item table)
* ID => Item data * ID => Item data
*/ */
public function get_children_branch_data($item_id, $order_desc, $include_item); public function get_subtree_data($item_id, $order_desc, $include_item);
/** /**
* Get base information of parent items * Get base information of parent items

24
phpBB/includes/tree/nestedset.php
View file

@ -154,7 +154,7 @@ abstract class phpbb_tree_nestedset implements phpbb_tree_interface
*/ */
protected function remove_item_from_nestedset($item_id) protected function remove_item_from_nestedset($item_id)
{ {
$items = $this->get_children_branch_data($item_id); $items = $this->get_subtree_data($item_id);
$item_ids = array_keys($items); $item_ids = array_keys($items);
$this->remove_subset($item_ids, $items[$item_id]); $this->remove_subset($item_ids, $items[$item_id]);
@ -338,7 +338,7 @@ abstract class phpbb_tree_nestedset implements phpbb_tree_interface
throw new RuntimeException($this->message_prefix . 'LOCK_FAILED_ACQUIRE'); throw new RuntimeException($this->message_prefix . 'LOCK_FAILED_ACQUIRE');
} }
$item_data = $this->get_children_branch_data($current_parent_id); $item_data = $this->get_subtree_data($current_parent_id);
if (!isset($item_data[$current_parent_id])) if (!isset($item_data[$current_parent_id]))
{ {
$this->lock->release(); $this->lock->release();
@ -447,7 +447,7 @@ abstract class phpbb_tree_nestedset implements phpbb_tree_interface
throw new RuntimeException($this->message_prefix . 'LOCK_FAILED_ACQUIRE'); throw new RuntimeException($this->message_prefix . 'LOCK_FAILED_ACQUIRE');
} }
$item_data = $this->get_children_branch_data($item_id); $item_data = $this->get_subtree_data($item_id);
if (!isset($item_data[$item_id])) if (!isset($item_data[$item_id]))
{ {
$this->lock->release(); $this->lock->release();
@ -529,45 +529,45 @@ abstract class phpbb_tree_nestedset implements phpbb_tree_interface
/** /**
* @inheritdoc * @inheritdoc
*/ */
public function get_full_branch_data($item_id, $order_desc = true, $include_item = true) public function get_path_and_subtree_data($item_id, $order_desc = true, $include_item = true)
{ {
$condition = 'i2.' . $this->column_left_id . ' BETWEEN i1.' . $this->column_left_id . ' AND i1.' . $this->column_right_id . ' $condition = 'i2.' . $this->column_left_id . ' BETWEEN i1.' . $this->column_left_id . ' AND i1.' . $this->column_right_id . '
OR i1.' . $this->column_left_id . ' BETWEEN i2.' . $this->column_left_id . ' AND i2.' . $this->column_right_id; OR i1.' . $this->column_left_id . ' BETWEEN i2.' . $this->column_left_id . ' AND i2.' . $this->column_right_id;
return $this->get_branch_data($item_id, $condition, $order_desc, $include_item); return $this->get_set_of_nodes_data($item_id, $condition, $order_desc, $include_item);
} }
/** /**
* @inheritdoc * @inheritdoc
*/ */
public function get_parent_branch_data($item_id, $order_desc = true, $include_item = true) public function get_path_data($item_id, $order_desc = true, $include_item = true)
{ {
$condition = 'i1.' . $this->column_left_id . ' BETWEEN i2.' . $this->column_left_id . ' AND i2.' . $this->column_right_id . ''; $condition = 'i1.' . $this->column_left_id . ' BETWEEN i2.' . $this->column_left_id . ' AND i2.' . $this->column_right_id . '';
return $this->get_branch_data($item_id, $condition, $order_desc, $include_item); return $this->get_set_of_nodes_data($item_id, $condition, $order_desc, $include_item);
} }
/** /**
* @inheritdoc * @inheritdoc
*/ */
public function get_children_branch_data($item_id, $order_desc = true, $include_item = true) public function get_subtree_data($item_id, $order_desc = true, $include_item = true)
{ {
$condition = 'i2.' . $this->column_left_id . ' BETWEEN i1.' . $this->column_left_id . ' AND i1.' . $this->column_right_id . ''; $condition = 'i2.' . $this->column_left_id . ' BETWEEN i1.' . $this->column_left_id . ' AND i1.' . $this->column_right_id . '';
return $this->get_branch_data($item_id, $condition, $order_desc, $include_item); return $this->get_set_of_nodes_data($item_id, $condition, $order_desc, $include_item);
} }
/** /**
* Get children and parent branch of the item * Get items that are related to the given item by the condition
* *
* @param int $item_id The item id to get the parents/children from * @param int $item_id The item id to get the node set from
* @param string $condition Query string restricting the item list * @param string $condition Query string restricting the item list
* @param bool $order_desc Order the items descending (most outer parent first) * @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 * @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) * @return array Array of items (containing all columns from the item table)
* ID => Item data * ID => Item data
*/ */
protected function get_branch_data($item_id, $condition, $order_desc = true, $include_item = true) protected function get_set_of_nodes_data($item_id, $condition, $order_desc = true, $include_item = true)
{ {
$rows = array(); $rows = array();

24
tests/tree/nestedset_forum_get_data_test.php
View file

@ -11,7 +11,7 @@ require_once dirname(__FILE__) . '/nestedset_forum_base.php';
class phpbb_tests_tree_nestedset_forum_get_data_test extends phpbb_tests_tree_nestedset_forum_base class phpbb_tests_tree_nestedset_forum_get_data_test extends phpbb_tests_tree_nestedset_forum_base
{ {
public function get_full_branch_data_data() public function get_path_and_subtree_data_data()
{ {
return array( return array(
array(1, true, true, array(1, 2, 3)), array(1, true, true, array(1, 2, 3)),
@ -32,14 +32,14 @@ class phpbb_tests_tree_nestedset_forum_get_data_test extends phpbb_tests_tree_ne
} }
/** /**
* @dataProvider get_full_branch_data_data * @dataProvider get_path_and_subtree_data_data
*/ */
public function test_get_full_branch_data($forum_id, $order_desc, $include_item, $expected) public function test_get_path_and_subtree_data($forum_id, $order_desc, $include_item, $expected)
{ {
$this->assertEquals($expected, array_keys($this->set->get_full_branch_data($forum_id, $order_desc, $include_item))); $this->assertEquals($expected, array_keys($this->set->get_path_and_subtree_data($forum_id, $order_desc, $include_item)));
} }
public function get_parent_branch_data_data() public function get_path_data_data()
{ {
return array( return array(
array(1, true, true, array(1)), array(1, true, true, array(1)),
@ -60,14 +60,14 @@ class phpbb_tests_tree_nestedset_forum_get_data_test extends phpbb_tests_tree_ne
} }
/** /**
* @dataProvider get_parent_branch_data_data * @dataProvider get_path_data_data
*/ */
public function test_get_parent_branch_data($forum_id, $order_desc, $include_item, $expected) public function test_get_path_data($forum_id, $order_desc, $include_item, $expected)
{ {
$this->assertEquals($expected, array_keys($this->set->get_parent_branch_data($forum_id, $order_desc, $include_item))); $this->assertEquals($expected, array_keys($this->set->get_path_data($forum_id, $order_desc, $include_item)));
} }
public function get_children_branch_data_data() public function get_subtree_data_data()
{ {
return array( return array(
array(1, true, true, array(1, 2, 3)), array(1, true, true, array(1, 2, 3)),
@ -88,11 +88,11 @@ class phpbb_tests_tree_nestedset_forum_get_data_test extends phpbb_tests_tree_ne
} }
/** /**
* @dataProvider get_children_branch_data_data * @dataProvider get_subtree_data_data
*/ */
public function test_get_children_branch_data($forum_id, $order_desc, $include_item, $expected) public function test_get_subtree_data($forum_id, $order_desc, $include_item, $expected)
{ {
$this->assertEquals($expected, array_keys($this->set->get_children_branch_data($forum_id, $order_desc, $include_item))); $this->assertEquals($expected, array_keys($this->set->get_subtree_data($forum_id, $order_desc, $include_item)));
} }
public function get_parent_data_data() public function get_parent_data_data()