@template-extends \ilTree More...

Collaboration diagram for ILIAS\Tree\TreeBuilder:

Public Member Functions
	__construct (int $tree_id)
	Create a new TreeBuilder instance. More...

	withTreeId (int $tree_id)
	Set the tree identifier. More...

	withRootId (int $root_id)
	Set the root node identifier. More...

	withDatabase (\ilDBInterface $db)
	Set the database interface. More...

	withLogger (LoggerInterface $logger)
	Set the logger. More...

	withSetting (Setting $setting)
	Set the settings. More...

	withEventHandler (\ilAppEventHandler $event_handler)
	Set the event handler. More...

	withObjectDataCache (\ilObjectDataCache $obj_data_cache)
	Set the object data cache. More...

	withObjectDefinition (\ilObjectDefinition $obj_definition)
	Set the object definition. More...

	withUser (\ilObjUser $user)
	Set the current user. More...

	withLanguage (Language $language)
	Set the language handler. More...

	forSetupEnvironment (\ilDBInterface $db, Setting $setting)
	Configure the builder for a setup environment with minimal dependencies. More...

	forMainTree ()
	Configure the builder for a main tree (default repository tree). More...

	forSubTree (int $root_id)
	Configure the builder for a subtree. More...

	build ()
	Build and return the ilTree instance. More...

Private Attributes
int	$tree_id

int	$root_id = 0

ilDBInterface	$db = null

LoggerInterface	$logger = null

Setting	$setting = null

ilAppEventHandler	$event_handler = null

ilObjectDataCache	$obj_data_cache = null

ilObjectDefinition	$obj_definition = null

ilObjUser	$user = null

Language	$language = null

Detailed Description

@template-extends \ilTree

Builder class for ilTree instances. Provides a fluent interface for constructing tree instances with various configurations.

Author: ILIAS Development

Definition at line 39 of file TreeBuilder.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Tree\TreeBuilder::__construct ( int $tree_id )

Create a new TreeBuilder instance.

Parameters

int $tree_id The tree identifier (required)

Definition at line 57 of file TreeBuilder.php.

    {
        $this->tree_id = $tree_id;
    }

References ILIAS\Tree\TreeBuilder\$tree_id.

Member Function Documentation

◆ build()

ILIAS\Tree\TreeBuilder::build ( )

Build and return the ilTree instance.

Returns: \ilTree The constructed tree instance

Definition at line 228 of file TreeBuilder.php.

                           : \ilTree
    {
        return new \ilTree(
            $this->tree_id,
            $this->root_id,
            $this->db,
            $this->logger,
            $this->setting,
            $this->event_handler,
            $this->obj_data_cache,
            $this->obj_definition,
            $this->user,
            $this->language
        );
    }

References ILIAS\UI\examples\Symbol\Glyph\Language\language(), ILIAS\Repository\logger(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ forMainTree()

ILIAS\Tree\TreeBuilder::forMainTree ( )

Configure the builder for a main tree (default repository tree).

Returns: $this

Definition at line 204 of file TreeBuilder.php.

                                 : self
    {
        $this->root_id = defined("ROOT_FOLDER_ID") ? ROOT_FOLDER_ID : 0;
 
        return $this;
    }

References ROOT_FOLDER_ID.

◆ forSetupEnvironment()

ILIAS\Tree\TreeBuilder::forSetupEnvironment	(	\ilDBInterface	$db,
		Setting	$setting
	)

Configure the builder for a setup environment with minimal dependencies.

This is a convenience method that sets up the builder with null/fallback values for dependencies that may not be available in setup contexts.

Parameters

\ilDBInterface $db Required database connection

Returns: $this

Definition at line 190 of file TreeBuilder.php.

                                                                             : self
    {
        $this->db = $db;
        $this->setting = $setting;
        $this->logger = new \ILIAS\Tree\Logging\NullLogger();
        $this->language = new \ILIAS\Tree\Language\NullLanguage();
        return $this;
    }

References ILIAS\Tree\TreeBuilder\$db, ILIAS\Tree\TreeBuilder\$setting, ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ILIAS\Repository\logger().

Here is the call graph for this function:

◆ forSubTree()

ILIAS\Tree\TreeBuilder::forSubTree ( int $root_id )

Configure the builder for a subtree.

Parameters

int $root_id The root node ID for the subtree

Returns: $this

Definition at line 217 of file TreeBuilder.php.

                                            : self
    {
        $this->root_id = $root_id;
        return $this;
    }

References ILIAS\Tree\TreeBuilder\$root_id.

◆ withDatabase()

ILIAS\Tree\TreeBuilder::withDatabase ( \ilDBInterface $db )

Set the database interface.

Parameters

\ilDBInterface $db Database interface

Returns: $this

Definition at line 92 of file TreeBuilder.php.

                                                    : self
    {
        $this->db = $db;
        return $this;
    }

References ILIAS\Tree\TreeBuilder\$db.

◆ withEventHandler()

ILIAS\Tree\TreeBuilder::withEventHandler ( \ilAppEventHandler $event_handler )

Set the event handler.

Parameters

\ilAppEventHandler $event_handler Event handler

Returns: $this

Definition at line 128 of file TreeBuilder.php.

                                                                       : self
    {
        $this->event_handler = $event_handler;
        return $this;
    }

References ILIAS\Tree\TreeBuilder\$event_handler.

◆ withLanguage()

ILIAS\Tree\TreeBuilder::withLanguage ( Language $language )

Set the language handler.

Parameters

Language $language Language instance

Returns: $this

Definition at line 176 of file TreeBuilder.php.

                                                    : self
    {
        $this->language = $language;
        return $this;
    }

References ILIAS\Tree\TreeBuilder\$language, and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Here is the call graph for this function:

◆ withLogger()

ILIAS\Tree\TreeBuilder::withLogger ( LoggerInterface $logger )

Set the logger.

Parameters

LoggerInterface $logger Logger instance

Returns: $this

Definition at line 104 of file TreeBuilder.php.

                                                       : self
    {
        $this->logger = $logger;
        return $this;
    }

References ILIAS\Tree\TreeBuilder\$logger, and ILIAS\Repository\logger().

Here is the call graph for this function:

◆ withObjectDataCache()

ILIAS\Tree\TreeBuilder::withObjectDataCache ( \ilObjectDataCache $obj_data_cache )

Set the object data cache.

Parameters

\ilObjectDataCache $obj_data_cache Object data cache

Returns: $this

Definition at line 140 of file TreeBuilder.php.

                                                                           : self
    {
        $this->obj_data_cache = $obj_data_cache;
        return $this;
    }

References ILIAS\Tree\TreeBuilder\$obj_data_cache.

◆ withObjectDefinition()

ILIAS\Tree\TreeBuilder::withObjectDefinition ( \ilObjectDefinition $obj_definition )

Set the object definition.

Parameters

\ilObjectDefinition $obj_definition Object definition

Returns: $this

Definition at line 152 of file TreeBuilder.php.

                                                                             : self
    {
        $this->obj_definition = $obj_definition;
        return $this;
    }

References ILIAS\Tree\TreeBuilder\$obj_definition.

◆ withRootId()

ILIAS\Tree\TreeBuilder::withRootId ( int $root_id )

Set the root node identifier.

Parameters

int $root_id Root node identifier (defaults to ROOT_FOLDER_ID if 0)

Returns: $this

Definition at line 80 of file TreeBuilder.php.

                                            : self
    {
        $this->root_id = $root_id;
        return $this;
    }

References ILIAS\Tree\TreeBuilder\$root_id.

◆ withSetting()

ILIAS\Tree\TreeBuilder::withSetting ( Setting $setting )

Set the settings.

Parameters

Setting $setting Settings instance

Returns: $this

Definition at line 116 of file TreeBuilder.php.

                                                 : self
    {
        $this->setting = $setting;
        return $this;
    }

References ILIAS\Tree\TreeBuilder\$setting.

◆ withTreeId()

ILIAS\Tree\TreeBuilder::withTreeId ( int $tree_id )

Set the tree identifier.

Parameters

int $tree_id Tree identifier

Returns: $this

Definition at line 68 of file TreeBuilder.php.

                                            : self
    {
        $this->tree_id = $tree_id;
        return $this;
    }

References ILIAS\Tree\TreeBuilder\$tree_id.

◆ withUser()

ILIAS\Tree\TreeBuilder::withUser ( \ilObjUser $user )

Set the current user.

Parameters

\ilObjUser $user User object

Returns: $this

Definition at line 164 of file TreeBuilder.php.

                                              : self
    {
        $this->user = $user;
        return $this;
    }

References ILIAS\Tree\TreeBuilder\$user, and ILIAS\Repository\user().

Here is the call graph for this function:

Field Documentation

◆ $db

ilDBInterface ILIAS\Tree\TreeBuilder::$db = null

private

Definition at line 43 of file TreeBuilder.php.

Referenced by ILIAS\Tree\TreeBuilder\forSetupEnvironment(), and ILIAS\Tree\TreeBuilder\withDatabase().

◆ $event_handler

ilAppEventHandler ILIAS\Tree\TreeBuilder::$event_handler = null

private

Definition at line 46 of file TreeBuilder.php.

Referenced by ILIAS\Tree\TreeBuilder\withEventHandler().

◆ $language

Language ILIAS\Tree\TreeBuilder::$language = null

private

Definition at line 50 of file TreeBuilder.php.

Referenced by ILIAS\Tree\TreeBuilder\withLanguage().

◆ $logger

LoggerInterface ILIAS\Tree\TreeBuilder::$logger = null

private

Definition at line 44 of file TreeBuilder.php.

Referenced by ILIAS\Tree\TreeBuilder\withLogger().

◆ $obj_data_cache

ilObjectDataCache ILIAS\Tree\TreeBuilder::$obj_data_cache = null

private

Definition at line 47 of file TreeBuilder.php.

Referenced by ILIAS\Tree\TreeBuilder\withObjectDataCache().

◆ $obj_definition

ilObjectDefinition ILIAS\Tree\TreeBuilder::$obj_definition = null

private

Definition at line 48 of file TreeBuilder.php.

Referenced by ILIAS\Tree\TreeBuilder\withObjectDefinition().

◆ $root_id

int ILIAS\Tree\TreeBuilder::$root_id = 0

private

Definition at line 42 of file TreeBuilder.php.

Referenced by ILIAS\Tree\TreeBuilder\forSubTree(), and ILIAS\Tree\TreeBuilder\withRootId().

◆ $setting

Setting ILIAS\Tree\TreeBuilder::$setting = null

private

Definition at line 45 of file TreeBuilder.php.

Referenced by ILIAS\Tree\TreeBuilder\forSetupEnvironment(), and ILIAS\Tree\TreeBuilder\withSetting().

◆ $tree_id

int ILIAS\Tree\TreeBuilder::$tree_id

private

Definition at line 41 of file TreeBuilder.php.

Referenced by ILIAS\Tree\TreeBuilder\__construct(), and ILIAS\Tree\TreeBuilder\withTreeId().

◆ $user

ilObjUser ILIAS\Tree\TreeBuilder::$user = null

private

Definition at line 49 of file TreeBuilder.php.

Referenced by ILIAS\Tree\TreeBuilder\withUser().

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

components/ILIAS/Tree/src/TreeBuilder.php

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ build()

◆ forMainTree()

◆ forSetupEnvironment()

◆ forSubTree()

◆ withDatabase()

◆ withEventHandler()

◆ withLanguage()

◆ withLogger()

◆ withObjectDataCache()

◆ withObjectDefinition()

◆ withRootId()

◆ withSetting()

◆ withTreeId()

◆ withUser()

Field Documentation

◆ $db

◆ $event_handler

◆ $language

◆ $logger

◆ $obj_data_cache

◆ $obj_definition

◆ $root_id

◆ $setting

◆ $tree_id

◆ $user