Class XoopsObjectTree

A tree structures with XoopsObjects as nodes

Package: kernel\core
Copyright: (c) 2000-2016 XOOPS Project (www.xoops.org)
License: GPL 2 (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
`protected`	# `initialize( )` Initialize the object Initialize the object
`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.
`protected`	# `makeSelBoxOptions( string $fieldName, string $selected, integer $key, string & $ret, string $prefix_orig, string $prefix_curr = '' )` Make options for a select box from Make options for a select box from Deprecated since 2.5.9, please use makeSelectElement() functionality Parameters `$fieldName` Name of the member variable from the node objects that should be used as the title for the options. `$selected` Value to display as selected `$key` ID of the object to display as the root of select options `$ret` (reference to a string when called from outside) Result from previous recursions `$prefix_orig` String to indent items at deeper levels `$prefix_curr` String to indent the current item
`public string`	# `makeSelBox( string $name, string $fieldName, string $prefix = '-', string $selected = '', boolean $addEmptyOption = false, integer $key = 0, string $extra = '' )` Make a select box with options from the tree Make a select box with options from the tree Deprecated since 2.5.9, please use makeSelectElement() Parameters `$name` Name of the select box `$fieldName` Name of the member variable from the node objects that should be used as the title for the options. `$prefix` String to indent deeper levels `$selected` Value to display as selected `$addEmptyOption` Set TRUE to add an empty option with value "0" at the top of the hierarchy `$key` ID of the object to display as the root of select options `$extra` Returns string HTML select box
`public XoopsFormSelect`	# `makeSelectElement( string $name, string $fieldName, string $prefix = '-', string $selected = '', boolean $addEmptyOption = false, integer $key = 0, string $extra = '', string $caption = '' )` Make a select box with options from the tree Make a select box with options from the tree Parameters `$name` Name of the select box `$fieldName` Name of the member variable from the node objects that should be used as the title for the options. `$prefix` String to indent deeper levels `$selected` Value to display as selected `$addEmptyOption` Set TRUE to add an empty option with value "0" at the top of the hierarchy `$key` ID of the object to display as the root of select options `$extra` extra content to add to the element `$caption` optional caption for form element Returns `XoopsFormSelect` form element
`protected`	# `addSelectOptions( XoopsFormSelect $element, string $fieldName, integer $key, string $prefix_orig, string $prefix_curr = '' )` Make options for a select box from Make options for a select box from Parameters `$element` form element to receive tree values as options `$fieldName` Name of the member variable from the node objects that should be used as the title for the options. `$key` ID of the object to display as the root of select options `$prefix_orig` String to indent items at deeper levels `$prefix_curr` String to indent the current item
`public mixed`	# `__get( string $name )` Magic __get method Magic __get method Some modules did not respect the leading underscore is private convention and broke when code was modernized. This will keep them running for now. Parameters `$name` unknown variable name requested currently only '_tree' is supported Returns mixed value

Properties summary
`protected`	`$parentId`	#
`protected`	`$myId`	#
`protected`	`$rootId`	#
`protected array`	`$tree`	# `array()`
`protected`	`$objects`	#

Namespaces

Classes

Interfaces

Exceptions

Functions

Class XoopsObjectTree

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Deprecated

Parameters

Deprecated

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns