[ticket/11495] Explain move() more

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.

PHPBB3-11495
This commit is contained in:
Joas Schilling 2013-04-25 13:09:00 +02:00
parent e8b192fa32
commit 61e72d3a10

View file

@ -56,6 +56,10 @@ interface phpbb_nestedset_interface
/**
* 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