Class XoopsObjectTree


					
	public

__construct(array &$objectArr, string $myId, string $parentId, string $rootId = null)

Constructor

Parameters

`$objectArr`	Array of {@link 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

#


					
	public
					
					&

getTree(): array

Get the tree

Returns

Associative array comprising the tree

#


					
	public
					
					&

getByKey(string $key): object

returns an object from the tree specified by its id

Parameters

$key

ID of the object to retrieve

Returns

Object within the tree

#


					
	public

getFirstChild(string $key): array

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 of children of the parent

#


					
	public

getAllChild(string $key, array $ret = []): array

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 of child nodes.

#


					
	public

getAllParent(string $key, array $ret = [], int $upLevel = 1): array

returns an array of all parent objects. the key of returned array represents how many levels up from the specified…

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 of parent nodes.

#


					
	protected

makeSelBoxOptions(
	string $fieldName,
	string $selected,
	int $key,
	string &$ret,
	string $prefix_orig,
	string $prefix_curr = '',
): void

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

makeSelBox(
	string $name,
	string $fieldName,
	string $prefix = '-',
	string $selected = '',
	bool $addEmptyOption = false,
	integer $key = 0,
	string $extra = '',
): string

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

Returns

HTML select box

#


					
	public

makeSelectElement(
	string $name,
	string $fieldName,
	string $prefix = '-',
	string $selected = '',
	bool $addEmptyOption = false,
	integer $key = 0,
	string $extra = '',
	string $caption = '',
): XoopsFormSelect

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

form element

#


					
	protected

addSelectOptions(
	XoopsFormSelect $element,
	string $fieldName,
	int $key,
	string $prefix_orig,
	string $prefix_curr = '',
): void

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

__get(string $name): mixed

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

value

#

Properties
`protected`	`$parentId`	#
`protected`	`$myId`	#
`protected`	`$rootId`	#
`protected`	`$tree = []`	#
`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