Class cTreeItem

Tree item class

Direct known subclasses

Indirect known subclasses

Package: Core\GUI
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Bjoern Behrens
Located at classes/tree/class.ctreeitem.php

Methods summary
`public`	# `__construct( string $id = "", string $name = "", boolean $collapsed = false )` Parameters `$id` `string` $id [optional] `$name` `string` $name [optional] `$collapsed` `boolean` $collapsed [optional]
`public string`	# `getId( )` Id getter Id getter Returns `string`
`public string`	# `getName( )` Name getter Name getter Returns `string`
`public boolean`	# `getCollapsed( )` Collapsed state getter Collapsed state getter Returns `boolean`
`public boolean`	# `importTable( array $flat_array )` Imports a table from an array of arrays. Imports a table from an array of arrays. The entries "collapsed" and "attributes" are optional! Parameters `$flat_array` `array` $flat_array array( array( "id" => "Item ID", "name" => "Item name", "level" => 1, "collapsed" => true\|false, "attributes" => array( "attr_name" => "attr_value" ) ) ) Returns `boolean`
`public`	# `importStructuredArray( array $array )` Parameters `$array` `array` $array
`protected boolean`	# `_flattenArray( array $sourcearray, array & $destarray, integer & $lastid, integer & $level )` Parameters `$sourcearray` `array` $sourcearray `$destarray` `array` $destarray `$lastid` `integer` $lastid `$level` `integer` $level Returns `boolean`
`public`	# `addItem( cTreeItem & $item )` adds an item as a subitem to the current item adds an item as a subitem to the current item Parameters `$item` `cTreeItem` $item item object to add
`public boolean`	# `addItemToID( string $id, cTreeItem & $item )` adds an item to a specific ID adds an item to a specific ID Parameters `$id` `string` $id ID to add the item to `$item` `cTreeItem` $item Item to add Returns `boolean`
`public`	# `moveItem( cTreeItem $targetItem, mixed $itemToMove )` moves an item to another object moves an item to another object Parameters `$targetItem` `cTreeItem` $targetItem Item to move the subitem to `$itemToMove` `mixed` $itemToMove cTreeItem-Object or id of object to move
`public object`	# `deleteItem( mixed $id )` deletes a subitem deletes a subitem Parameters `$id` `mixed` $id item object or ID to delete Returns `object` deleted object
`public cTreeItem &`	# `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` `string` $id ID to retrieve Returns `cTreeItem`
`public`	# `setAttribute( string $attributeName, array $attributeValue )` sets a custom attribute for this TreeItem sets a custom attribute for this TreeItem Parameters `$attributeName` `string` $attributeName `$attributeValue` `array` $attributeValue The value(s) of the attribute
`public`	# `setAttributes( array $aAttributeArray )` sets a bunch of attributes sets a bunch of attributes Parameters `$aAttributeArray` `array` $aAttributeArray
`public mixed`	# `getAttribute( string $attributeName )` returns an attribute returns an attribute Parameters `$attributeName` `string` attributeName Returns `mixed`
`public boolean`	# `deleteAttribute( string $attributeName )` deletes an attribute deletes an attribute Parameters `$attributeName` `string` attributeName Returns `boolean`
`public boolean`	# `hasAttribute( string $attributeName, boolean $bRecursive = false )` Parameters `$attributeName` `string` $attributeName `$bRecursive` `boolean` $bRecursive [optional] Returns `boolean`
`public boolean`	# `setExpanded( mixed $id )` Parameters `$id` `mixed` $id expand ID of item to expand or array of item ID's to expand Returns `boolean`
`public \|boolean`	# `setCollapsed( mixed $id )` Parameters `$id` `mixed` $id collapse ID to collapse or an array with items to collapse Returns `\|boolean`
`protected`	# `_expandBelowLevel( integer $leveloffset )` Parameters `$leveloffset` `integer` $leveloffset leveloffset Level offset. Ignores all expand operations below the offset.
`protected`	# `_collapseBelowLevel( integer $leveloffset )` Parameters `$leveloffset` `integer` leveloffset Level offset. Ignores all expand operations below the offset.
`protected`	# `_expandBelowID( string $id, boolean $found = false )` Parameters `$id` `string` $id `$found` `boolean` $found [optional]
`protected`	# `_collapseBelowID( string $id, boolean $found = false )` Parameters `$id` `string` $id `$found` `boolean` $found [optional]
`public`	# `getCollapsedList( array & $list )` Returns all items (as ID array) which are collapsed. Returns all items (as ID array) which are collapsed. Parameters `$list` `array` $list Contains the list with all collapsed items
`public`	# `getExpandedList( array & $list )` getExpandedList Returns all items (as ID array) which are expanded. getExpandedList Returns all items (as ID array) which are expanded. Parameters `$list` `array` $list Contains the list with all expanded items
`public`	# `setPayloadObject( object $payload )` sets a payload object for later reference sets a payload object for later reference Parameters `$payload` `object` $payload The object to payload
`public object`	# `unsetPayloadObject( )` unsets a payload object unsets a payload object Returns `object`
`public`	# `traverse( object & $objects, integer $level = 0 )` traverse traverses the tree starting from this item, and returning all objects as $objects in a nested array. traverse traverses the tree starting from this item, and returning all objects as $objects in a nested array. Parameters `$objects` `object` $objects all found objects `$level` `integer` $level [optional] Level to start on
`public array`	# `flatTraverse( integer $level = 0 )` Traverses the tree starting from this item, and returning all objects as $objects in a flat array. Traverses the tree starting from this item, and returning all objects as $objects in a flat array. Parameters `$level` `integer` $level [optional] Level to start on Returns `array`
`public none`	# `setName( string $name )` Sets the name for this item. Sets the name for this item. Parameters `$name` `string` $name New name for this item Returns `none`

Properties summary
`public array`	`$_subitems`	`array()`	# 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 integer`	`$_level`		# Contains the level of this item Contains the level of this item
`public array`	`$_attributes`	`array()`	# Contains custom entries Contains custom entries
`public array`	`$_parent`	`false`	# Contains the parent of this item Contains the parent of this item
`public array`	`$_next`	`false`	# Contains the next item Contains the next item
`public array`	`$_previous`	`false`	# Contains the previous item Contains the previous item

Packages

Classes

Class cTreeItem

Direct known subclasses

Indirect known subclasses

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns