Class XoopsObjectTree

A tree structures with XoopsObjects as nodes

Package: kernel\core
Copyright: XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono onokazu@xoops.org
Located at lass/tree.php

Methods summary
`public`	# `__construct( array & $objectArr, string $myId, string $parentId, string $rootId = null )` Constructor Constructor Parameters `$objectArr` Array of `XoopsObject`s `$myId` field name of object ID `$parentId` field name of parent object ID `$rootId` field name of root object ID
`public array`	# `getTree( )` Get the tree Get the tree Returns array Associative array comprising the tree
`public object`	# `getByKey( string $key )` returns an object from the tree specified by its id returns an object from the tree specified by its id Parameters `$key` ID of the object to retrieve Returns object Object within the tree
`public array`	# `getFirstChild( string $key )` returns an array of all the first child object of an object specified by its id returns an array of all the first child object of an object specified by its id Parameters `$key` ID of the parent object Returns array Array of children of the parent
`public array`	# `getAllChild( string $key, array $ret = array() )` returns an array of all child objects of an object specified by its id returns an array of all child objects of an object specified by its id Parameters `$key` ID of the parent `$ret` (Empty when called from client) Array of children from previous recursions. Returns array Array of child nodes.
`public array`	# `getAllParent( string $key, array $ret = array(), integer $uplevel = 1 )` returns an array of all parent objects. the key of returned array represents how many levels up from the specified object returns an array of all parent objects. the key of returned array represents how many levels up from the specified object Parameters `$key` ID of the child object `$ret` (empty when called from outside) Result from previous recursions `$uplevel` (empty when called from outside) level of recursion Returns array Array of parent nodes.
`public string`	# `makeSelBox( string $name, string $fieldName, string $prefix = '-', boolean $selected = '', integer $addEmptyOption = false, string $key = 0, string $extra = '' )` Make a select box with options from the tree Make a select box with options from the tree Parameters `$name` $fieldName Name of the member variable from the node objects that should be used as the title for the options. `$fieldName` $prefix String to indent deeper levels `$prefix` $selected Value to display as selected `$selected` $addEmptyOption Set TRUE to add an empty option with value "0" at the top of the hierarchy `$addEmptyOption` $key ID of the object to display as the root of select options `$key` $extra `$extra` $name Returns string HTML select box
`public array`	# `makeArrayTree( string $fieldName, string $prefix = '-', integer $key = 0 )` Make options for a array Make options for a array Parameters `$fieldName` Name of the member variable from the node objects that should be used as the column. `$prefix` String to indent deeper levels `$key` ID of the object to display as the root of the array Returns array
`public`	# `_makeArrayTreeOptions( string $fieldName, integer $key, string & $ret, string $prefix_orig, $prefix_curr = '' )` Make a array with options from the tree Make a array with options from the tree Parameters `$fieldName` Name of the member variable from the node objects that should be used as the column. `$key` ID of the object to display as the root of the array `$ret` $prefix_orig String to indent deeper levels (origin) `$prefix_orig` $prefix_curr String to indent deeper levels (current) `$prefix_curr`

Namespaces

Classes

Interfaces

Functions

Class XoopsObjectTree

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters