Class TreeItem

Class TreeItem Class to create tree-based items

The treeitem class allows you to logically store tree-based structures.

Example:

Let's have a tree with 3 nodes. It's important that we always have a "root" key.

$root = new TreeItem("root", 1); $item1 = new TreeItem("node1",2); $item2 = new TreeItem("node2",3); $item3 = new TreeItem("node3",4);

$root->addItem($item1); $root->addItem($item2); $root->addItem($item3);

This represents the tree we described above.

If you know the ID of the item you want to add to, there's no need to have a specific item handy, but rather you can use the "addItemToID" function.

Package: Core\Backend
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Timo Hummel
Located at classes/class.treeitem.php

Methods summary
`public`	# `__construct( string $name = "", string $id = "", boolean $collapsed = false )` Constructor Function Creates a new, independant tree item. Constructor Function Creates a new, independant tree item. Parameters `$name` The name of that item `$id` The unique ID of that item `$collapsed` Is this item collapsed by default
`public`	# `addItem( object & $item )` Adds a new subitem to this item. Adds a new subitem to this item. Parameters `$item` the item to add
`public`	# `addItemToID( object $item, string $id )` Adds a new subitem to a specific item with an ID. Traverses all subitems to find the correct item. Adds a new subitem to a specific item with an ID. Traverses all subitems to find the correct item. Parameters `$item` the item to add `$id` the ID to add the item to
`public object &`	# `getItemByID( string $id )` Retrieves a specific item by its ID. Note that this function traverses all subitems to find the correct item. Retrieves a specific item by its ID. Note that this function traverses all subitems to find the correct item. Parameters `$id` the ID to find Returns object The item, or false if nothing was found
`public`	# `removeItem( string $id )` Removes an item with a specific ID. Removes an item with a specific ID. Parameters `$id` the ID to find
`public boolean`	# `isCustomAttributeSet( string $item )` Checks if a specific custom attribute is set Checks if a specific custom attribute is set Parameters `$item` the attribute name to find Returns boolean
`public boolean`	# `markExpanded( string $id )` Marks an item as expanded. Traverses all subitems to find the ID. Note that only the item with $id is expanded, but not its childs. Marks an item as expanded. Traverses all subitems to find the ID. Note that only the item with $id is expanded, but not its childs. Parameters `$id` the ID to expand, or an array with all id's Returns boolean
`public`	# `expandAll( string $start = -2 )` Expands all items, starting from the $start item. Expands all items, starting from the $start item. Parameters `$start` the ID to start expanding from
`public`	# `collapseAll( string $start = -2 )` Collapses all items, starting from the $start item. Collapses all items, starting from the $start item. Parameters `$start` the ID to start collapsing from
`public`	# `markCollapsed( string $id )` Marks an item as collpased. Traverses all subitems to find the ID. Note that only the item with $id is collapsed, but not its childs. Marks an item as collpased. Traverses all subitems to find the ID. Note that only the item with $id is collapsed, but not its childs. Parameters `$id` the ID to collapse
`public`	# `traverse( object & $objects, integer $level = 0 )` Traverses the tree starting from this item, and returning all objects as $objects. Traverses the tree starting from this item, and returning all objects as $objects. Parameters `$objects` all found objects `$level` Level to start on
`public`	# `getFlatTree( unknown_type $item, unknown_type & $flat_tree )` Starts iterating at root node and flattens the tree into an array Starts iterating at root node and flattens the tree into an array Parameters `$item` `$flat_tree`
`public boolean`	# `hasCollapsedNode( unknown_type $item_id )` Parameters `$item_id` Returns boolean
`public`	# `getTreeParentNodes( unknown_type & $parentNodes, unknown_type $id )` Returns a list of the id of all parent nodes of the given node Returns a list of the id of all parent nodes of the given node Parameters `$parentNodes` `$id`
`public`	# `getParentNodes( unknown_type & $parentNodes, unknown_type $stop_id )` Returns a list of the id of all parent nodes of the given node Not using the nodes of hierarchical tree, but flat tree !! Returns a list of the id of all parent nodes of the given node Not using the nodes of hierarchical tree, but flat tree !! Parameters `$parentNodes` `$stop_id`
`public`	# `getRealCollapsedList( unknown_type & $list )` getCollapsedList thinks if a node has no subnodes it is collapsed I don't think so getCollapsedList thinks if a node has no subnodes it is collapsed I don't think so Parameters `$list`
`public`	# `getCollapsedList( array & $list )` Returns all items (as ID array) which are collapsed. Returns all items (as ID array) which are collapsed. Parameters `$list` Contains the list with all collapsed items
`public`	# `getExpandedList( array & $list )` Returns all items (as ID array) which are expanded. Returns all items (as ID array) which are expanded. Parameters `$list` Contains the list with all expanded items

Properties summary
`public array`	`$subitems` Sub Items for this tree item Sub Items for this tree item	#
`public boolean`	`$collapsed` Determinates if this tree item is collapsed Determinates if this tree item is collapsed	#
`public string`	`$id` ID for this item ID for this item	#
`public string`	`$name` Name for this item Name for this item	#
`public string`	`$collapsed_icon` Icon for the collapsed item Icon for the collapsed item	#
`public string`	`$expanded_icon` Icon for the expanded item Icon for the expanded item	#
`public string`	`$lastnode_icon` Icon for last node in a branch Icon for last node in a branch	#
`public integer`	`$level` Contains the level of this item Contains the level of this item	#
`public array`	`$custom` Contains custom entries Contains custom entries	#
`public array`	`$parent` Contains the parent of this item Contains the parent of this item	#

Packages

Classes

Functions

Class TreeItem

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Parameters