contenido\classes\tree\class.ctree.php

Show:

inherited

Classes
- \cTree

Table of Contents

Project: Contenido Content Management System

Description: logical cTree

Requirements:

Author: Timo Hummel
Con_php_req: 5.0
Copyright: four for business AG
License: http://www.contenido.org/license/LIZENZ.txt
Link: http://www.4fb.de
Link: {@internal created 2004-08-04 $Id: class.ctree.php,v 1.2 2004/08/04 07:56:19 timo.hummel Exp $ }}
Package: Contenido Backend classes
Version: 1.12

\cTree
jump to top

Package: Default

class cTree

Parent(s): \cTreeItem
Children: \cWidgetTreeView

Properties

array $_attributes

inherited

Contains custom entries

Inherited from: \cTreeItem::$$_attributes

Details

Type: array
Inherited_from: \cTreeItem::$$_attributes

boolean $_collapsed

inherited

Determinates if this tree item is collapsed

Inherited from: \cTreeItem::$$_collapsed

Details

Type: boolean
Inherited_from: \cTreeItem::$$_collapsed

string $_id

inherited

ID for this item

Inherited from: \cTreeItem::$$_id

Details

Type: string
Inherited_from: \cTreeItem::$$_id

integer $_level

inherited

Contains the level of this item

Inherited from: \cTreeItem::$$_level

Details

Type: integer
Inherited_from: \cTreeItem::$$_level

string $_name

inherited

Name for this item

Inherited from: \cTreeItem::$$_name

Details

Type: string
Inherited_from: \cTreeItem::$$_name

array $_next

inherited

Contains the next item

Inherited from: \cTreeItem::$$_next

Details

Type: array
Inherited_from: \cTreeItem::$$_next

array $_parent

inherited

Contains the parent of this item

Inherited from: \cTreeItem::$$_parent

Details

Type: array
Inherited_from: \cTreeItem::$$_parent

array $_previous

inherited

Contains the previous item

Inherited from: \cTreeItem::$$_previous

Details

Type: array
Inherited_from: \cTreeItem::$$_previous

array $_subitems

inherited

Sub Items for this tree item

Inherited from: \cTreeItem::$$_subitems

Details

Type: array
Inherited_from: \cTreeItem::$$_subitems

$_treeIcon

Details

Type: n/a

Methods

_flattenArray( $sourcearray, $destarray, $lastid, $level) : void

inherited

Inherited from: \cTreeItem::_flattenArray()

Parameters

Name	Type	Description
$sourcearray
$destarray
$lastid
$level

addItem(\cTreeItem $item) : void

inherited

adds an item as a subitem to the current item

Inherited from: \cTreeItem::addItem()

Parameters

Name	Type	Description
$item	\cTreeItem	item item object to add

Details

Access: public

addItemToID(string $id, \cTreeItem $item) : void

inherited

adds an item to a specific ID

Inherited from: \cTreeItem::addItemToID()

Parameters

Name	Type	Description
$id	string	id ID to add the item to
$item	\cTreeItem	item Item to add

Details

Access: public

cTree( $name = "") : void

Parameters

Name	Type	Description
$name

cTreeItem( $id = "", $name = "", $collapsed = false) : void

inherited

Inherited from: \cTreeItem::cTreeItem()

Parameters

Name	Type	Description
$id
$name
$collapsed

collapseBelowID(int $id, $found = false) : void

inherited

Inherited from: \cTreeItem::collapseBelowID()

Parameters

Name	Type	Description
$id	int	leveloffset Level offset. Ignores all expand operations below the offset.
$found

Details

Access: public

collapseBelowLevel(int $leveloffset) : void

inherited

Inherited from: \cTreeItem::collapseBelowLevel()

Parameters

Name	Type	Description
$leveloffset	int	leveloffset Level offset. Ignores all expand operations below the offset.

Details

Access: public

deleteAttribute(string $attributeName) : void

inherited

deletes an attribute

Inherited from: \cTreeItem::deleteAttribute()

Parameters

Name	Type	Description
$attributeName	string	attributeName

Details

Access: public

deleteItem(mixed $id) : \deleted

inherited

deletes a subitem

Inherited from: \cTreeItem::deleteItem()

Parameters

Name	Type	Description
$id	mixed	item object or ID to delete

Returns

Type	Description
\deleted	object

Details

Access: public

expandBelowID(int $id, $found = false) : void

inherited

Inherited from: \cTreeItem::expandBelowID()

Parameters

Name	Type	Description
$id	int	leveloffset Level offset. Ignores all expand operations below the offset.
$found

Details

Access: public

expandBelowLevel(int $leveloffset) : void

inherited

Inherited from: \cTreeItem::expandBelowLevel()

Parameters

Name	Type	Description
$leveloffset	int	leveloffset Level offset. Ignores all expand operations below the offset.

Details

Access: public

exportTree() : array

inherited

Exports a tree as an array of arrays.

Inherited from: \cTreeItem::exportTree()

Array format: array( array("id" => "Item ID", "name" => "Item name", "level" => 1, "attributes" => array("attr_name" => "attr_value")) );

Returns

Type	Description
array

Details

Access: public

flatTraverse(integer $level = 0) : void

inherited

flatTraverse traverses the tree starting from this item, and returning all objects as $objects in a flat array.

Inherited from: \cTreeItem::flatTraverse()

Parameters

Name	Type	Description
$level	integer	Level to start on

getAttribute(string $attributeName) : mixed

inherited

returns an attribute

Inherited from: \cTreeItem::getAttribute()

Parameters

Name	Type	Description
$attributeName	string	attributeName

Returns

Type	Description
mixed

Details

Access: public

getCollapsedList(array $list) : void

inherited

getCollapsedList Returns all items (as ID array) which are collapsed.

Inherited from: \cTreeItem::getCollapsedList()

Parameters

Name	Type	Description
$list	array	Contains the list with all collapsed items

getExpandedList(array $list) : void

inherited

getExpandedList Returns all items (as ID array) which are expanded.

Inherited from: \cTreeItem::getExpandedList()

Parameters

Name	Type	Description
$list	array	Contains the list with all expanded items

getItemByID(string $id) : \cTreeItem

inherited

Retrieves a specific item by its ID.

Inherited from: \cTreeItem::getItemByID()

Note that this function traverses all subitems to find the correct item.

Parameters

Name	Type	Description
$id	string	id ID to retrieve

Returns

Type	Description
\cTreeItem

Details

Access: public

hasAttribute( $attributeName, $bRecursive = false) : void

inherited

Inherited from: \cTreeItem::hasAttribute()

Parameters

Name	Type	Description
$attributeName
$bRecursive

importStructuredArray( $array) : void

inherited

Inherited from: \cTreeItem::importStructuredArray()

Parameters

Name	Type	Description
$array

importTable(array $flat_array) : void

inherited

Imports a table from an array of arrays.

Inherited from: \cTreeItem::importTable()

Array format: array( array("id" => "Item ID", "name" => "Item name", "level" => 1, "collapsed" => true|false, "attributes" => array("attr_name" => "attr_value")) );

The entries "collapsed" and "attributes" are optional!

Parameters

Name	Type	Description
$flat_array	array	flat_array See above

Details

Access: public

moveItem(\cTreeItem $targetItem, mixed $itemToMove) : void

inherited

moves an item to another object

Inherited from: \cTreeItem::moveItem()

Parameters

Name	Type	Description
$targetItem	\cTreeItem	targetItem Item to move the subitem to
$itemToMove	mixed	itemToMove cTreeItem-Object or id of object to move

Details

Access: public

setAttribute(string $attributeName, array $attributeValue) : void

inherited

sets a custom attribute for this TreeItem

Inherited from: \cTreeItem::setAttribute()

Parameters

Name	Type	Description
$attributeName	string	attributeName
$attributeValue	array	attributeValue The value(s) of the attribute

Details

Access: public

setAttributes(string $aAttributeArray) : void

inherited

sets a bunch of attributes

Inherited from: \cTreeItem::setAttributes()

Parameters

Name	Type	Description
$aAttributeArray	string	attributeName

Details

Access: public

setCollapsed(mixed $id) : void

inherited

Inherited from: \cTreeItem::setCollapsed()

Parameters

Name	Type	Description
$id	mixed	collapse ID to collapse or an array with items to collapse

Details

Access: public

setExpanded(mixed $id) : void

inherited

Inherited from: \cTreeItem::setExpanded()

Parameters

Name	Type	Description
$id	mixed	expand ID of item to expand or array of item ID's to expand

Details

Access: public

setIcon( $path) : void

Parameters

Name	Type	Description
$path

setName(string $name) : \none

inherited

setName sets the Name for this item.

Inherited from: \cTreeItem::setName()

Parameters

Name	Type	Description
$name	string	New name for this item

Returns

Type	Description
\none

setPayloadObject(object $payload) : void

inherited

sets a payload object for later reference

Inherited from: \cTreeItem::setPayloadObject()

Parameters

Name	Type	Description
$payload	object	payload The object to payload

Details

Access: public

setTreeName(string $name) : void

sets a new name for the tree.

Parameters

Name	Type	Description
$name	string	name Name of the tree

Details

Access: public

traverse(object $objects, integer $level = 0) : void

inherited

traverse traverses the tree starting from this item, and returning all objects as $objects in a nested array.

Inherited from: \cTreeItem::traverse()

Parameters

Name	Type	Description
$objects	object	all found objects
$level	integer	Level to start on

unsetPayloadObject() : object

inherited

unsets a payload object

Inherited from: \cTreeItem::unsetPayloadObject()

Returns

Type	Description
object

Details

Access: public

contenido\classes\tree\class.ctree.php

\cTreejump to top

Properties

Methods

\cTree
jump to top