KSDocumentationTreeRecursion Class Reference

Tree Recursion, putting Entries into a Tree. More...

Inheritance diagram for KSDocumentationTreeRecursion:

Collaboration diagram for KSDocumentationTreeRecursion:

Public Member Functions
	__construct (Entries $entries, URI $parent_uri, string $current_opened_entry_id)
	getChildren ($record, $environment=null)
Public Member Functions inherited from ILIAS\UI\Component\Tree\TreeRecursion
	getChildren ( $record, $environment=null)
	Get a list of records (that list can also be empty). More...
	build (Node\Factory $factory, $record, $environment=null)
	Build and return a Node. More...

Protected Member Functions
	getNodeUri (Entry $a_node)

Protected Attributes
Entries	$entries
URI	$parent_uri
Entry	$current_node

Detailed Description

Tree Recursion, putting Entries into a Tree.

Definition at line 28 of file KSDocumentationTreeRecursion.php.

Constructor & Destructor Documentation

__construct()

KSDocumentationTreeRecursion::__construct	(	Entries	$entries,
		URI	$parent_uri,
		string	$current_opened_entry_id
	)

Definition at line 34 of file KSDocumentationTreeRecursion.php.

    {
        $this->entries = $entries;
        $this->parent_uri = $parent_uri;
        $this->current_node = $entries->getRootEntry();
        if ($current_opened_entry_id) {
            $this->current_node = $entries->getEntryById($current_opened_entry_id);
        }
    }

References $entries, and $parent_uri.

Member Function Documentation

getChildren()

KSDocumentationTreeRecursion::getChildren	(		$record,
			$environment = null
	)

Parameters

Entry

$record

Returns

Entry[]

Implements ILIAS\UI\Component\Tree\TreeRecursion.

Definition at line 47 of file KSDocumentationTreeRecursion.php.

                                                             : array
    {
        $entries = $this->entries->getChildrenOfEntry($record->getId());
        usort($entries, static fn(Entry $a, Entry $b): int => ilStr::strCmp($a->getTitle(), $b->getTitle()));
        return $entries;
    }

References Vendor\Package\$a, Vendor\Package\$b, $entries, and ilStr\strCmp().

Here is the call graph for this function:

getNodeUri()

KSDocumentationTreeRecursion::getNodeUri ( Entry  $a_node )

protected

Definition at line 72 of file KSDocumentationTreeRecursion.php.

                                                : URI
    {
        return $this->parent_uri->withParameter('node_id', $a_node->getId());
    }

References ILIAS\Data\URI\withParameter().

Here is the call graph for this function:

Field Documentation

$current_node

Entry KSDocumentationTreeRecursion::$current_node

protected

Definition at line 32 of file KSDocumentationTreeRecursion.php.

$entries

Entries KSDocumentationTreeRecursion::$entries

protected

Definition at line 30 of file KSDocumentationTreeRecursion.php.

Referenced by __construct(), and getChildren().

$parent_uri

URI KSDocumentationTreeRecursion::$parent_uri

protected

Definition at line 31 of file KSDocumentationTreeRecursion.php.

Referenced by __construct().

---

The documentation for this class was generated from the following file:

• components/ILIAS/Style/System/classes/Provider/KSDocumentationTreeRecursion.php