Inheritance diagram for ilTreeImplementationSwitch:

Collaboration diagram for ilTreeImplementationSwitch:

Public Member Functions
	__construct (string $mode)

	getHash ()

	getLabel ()

	isNotable ()

	getPreconditions (Environment $environment)

	achieve (Environment $environment)

	isApplicable (Environment $environment)

Public Member Functions inherited from ilSetupObjective
	__construct (Setup\Config $config)

Data Fields
const	NESTED_SET_TO_MATERIALIZED_PATH = 'nested_set_to_materialized_path'

const	MATERIALIZED_PATH_TO_NESTED_SET = 'materialized_path_to_nested_set'

Private Member Functions
	renumberNestedSet (ilDBInterface $db, int $node_id, int $i)

Private Attributes
string	$mode

Additional Inherited Members
Protected Attributes inherited from ilSetupObjective
Setup Config	$config

Detailed Description

Definition at line 25 of file class.ilTreeImplementationSwitch.php.

Constructor & Destructor Documentation

◆ __construct()

ilTreeImplementationSwitch::__construct ( string $mode )

Definition at line 32 of file class.ilTreeImplementationSwitch.php.

    {
        parent::__construct(new NullConfig());
        $this->mode = $mode;
    }

References $mode, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ achieve()

ilTreeImplementationSwitch::achieve ( Environment $environment )

Definition at line 64 of file class.ilTreeImplementationSwitch.php.

                                                     : Environment
    {
        $db = $environment->getResource(Environment::RESOURCE_DATABASE);
        $settings_factory = $environment->getResource(Environment::RESOURCE_SETTINGS_FACTORY);
 
        $is_nested_set = $settings_factory->settingsFor('common')->get('main_tree_impl', 'ns') === 'ns';
 
        if ($this->mode === self::NESTED_SET_TO_MATERIALIZED_PATH && $is_nested_set) {
            ilMaterializedPathTree::createFromParentRelation($db);
 
            $db->dropIndexByFields('tree', ['lft']);
            $db->dropIndexByFields('tree', ['path']);
            $db->addIndex('tree', ['path'], 'i4');
 
            $settings_factory->settingsFor('common')->set('main_tree_impl', 'mp');
        } elseif ($this->mode === self::MATERIALIZED_PATH_TO_NESTED_SET && !$is_nested_set) {
            $renumber_callable = function (ilDBInterface $db) {
                $this->renumberNestedSet($db, 1, 1);
            };
            $ilAtomQuery = $db->buildAtomQuery();
            $ilAtomQuery->addTableLock('tree');
 
            $ilAtomQuery->addQueryCallable($renumber_callable);
            $ilAtomQuery->run();
 
            $db->dropIndexByFields('tree', ['lft']);
            $db->dropIndexByFields('tree', ['path']);
            $db->addIndex('tree', ['lft'], 'i4');
 
            $settings_factory->settingsFor('common')->set('main_tree_impl', 'ns');
        } else {
            throw new UnachievableException('The tree implementation switch does already equal the requested mode');
        }
 
        return $environment;
    }

References ilMaterializedPathTree\createFromParentRelation(), ILIAS\Setup\Environment\getResource(), and renumberNestedSet().

Here is the call graph for this function:

◆ getHash()

ilTreeImplementationSwitch::getHash ( )

Definition at line 38 of file class.ilTreeImplementationSwitch.php.

                             : string
    {
        return hash('sha256', self::class);
    }

◆ getLabel()

ilTreeImplementationSwitch::getLabel ( )

Definition at line 43 of file class.ilTreeImplementationSwitch.php.

                              : string
    {
        if ($this->mode === self::MATERIALIZED_PATH_TO_NESTED_SET) {
            return 'The tree implementation is switched to nested set';
        }
        return 'The tree implementation is switched to materialized path';
    }

◆ getPreconditions()

ilTreeImplementationSwitch::getPreconditions ( Environment $environment )

Definition at line 56 of file class.ilTreeImplementationSwitch.php.

                                                              : array
    {
        return [
            new ilSettingsFactoryExistsObjective(),
            new ilDatabaseInitializedObjective(),
        ];
    }

◆ isApplicable()

ilTreeImplementationSwitch::isApplicable ( Environment $environment )

Definition at line 136 of file class.ilTreeImplementationSwitch.php.

                                                          : bool
    {
        $settings_factory = $environment->getResource(Environment::RESOURCE_SETTINGS_FACTORY);
 
        $is_nested_set = $settings_factory->settingsFor('common')->get('main_tree_impl', 'ns') === 'ns';
 
        if ($this->mode === self::MATERIALIZED_PATH_TO_NESTED_SET) {
            return !$is_nested_set;
        }
 
        return $is_nested_set;
    }

References ILIAS\Setup\Environment\getResource().

Here is the call graph for this function:

◆ isNotable()

ilTreeImplementationSwitch::isNotable ( )

Definition at line 51 of file class.ilTreeImplementationSwitch.php.

                               : bool
    {
        return true;
    }

◆ renumberNestedSet()

ilTreeImplementationSwitch::renumberNestedSet	(	ilDBInterface	$db,
		int	$node_id,
		int	$i
	)

private

Definition at line 101 of file class.ilTreeImplementationSwitch.php.

                                                                               : int
    {
        $db->manipulateF(
            'UPDATE tree SET lft = %s WHERE child = %s',
            [ilDBConstants::T_INTEGER, ilDBConstants::T_INTEGER],
            [$i, $node_id]
        );
 
        $query = 'SELECT child FROM tree WHERE parent = ' . $db->quote($node_id, ilDBConstants::T_INTEGER) . ' ORDER BY lft';
        $res = $db->query($query);
 
        $children = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $children[] = (int) $row->child;
        }
 
        foreach ($children as $child) {
            $i = $this->renumberNestedSet($db, $child, $i + 1);
        }
        $i++;
 
        if (count($children) > 0) {
            $i += 100;
        }
 
        $query = 'UPDATE tree SET rgt = %s WHERE child = %s';
        $db->manipulateF(
            $query,
            [ilDBConstants::T_INTEGER, ilDBConstants::T_INTEGER],
            [$i, $node_id]
        );
 
        return $i;
    }