class.ilComponentDefinitionsStoredObjective.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Setup;
use ILIAS\DI;
use ILIAS\COPage\Setup\ilCOPageDBUpdateSteps;
use ILIAS\ILIASObject\Setup\ObjectDefinitionProcessor;

class ilComponentDefinitionsStoredObjective implements Setup\Objective
{
    protected $populate_before;

    public function __construct(bool $populate_before = true)
    {
        $this->populate_before = $populate_before;
    }

    public function getHash(): string
    {
        return hash("sha256", self::class);
    }

    public function getLabel(): string
    {
        return "Module- and Servicedefinitions are stored.";
    }

    public function isNotable(): bool
    {
        return true;
    }

    public function getPreconditions(Setup\Environment $environment): array
    {
        return [
            new \ilDatabaseUpdatedObjective(),
            new \ilDatabaseUpdateStepsExecutedObjective(new ilCOPageDBUpdateSteps()),
            new \ilSettingsFactoryExistsObjective(),
            new \ilComponentRepositoryExistsObjective(),
            new \ilComponentFactoryExistsObjective(),
        ];
    }

    public function achieve(Setup\Environment $environment): Setup\Environment
    {
        $ilias_path = __DIR__ . "/../../../..";

        $db = $environment->getResource(Setup\Environment::RESOURCE_DATABASE);
        $ini = $environment->getResource(Setup\Environment::RESOURCE_ILIAS_INI);
        $client_ini = $environment->getResource(Setup\Environment::RESOURCE_CLIENT_INI);
        $component_repository = $environment->getResource(Setup\Environment::RESOURCE_COMPONENT_REPOSITORY);
        $component_factory = $environment->getResource(Setup\Environment::RESOURCE_COMPONENT_FACTORY);
        $settings_factory = $environment->getResource(Setup\Environment::RESOURCE_SETTINGS_FACTORY);

        // ATTENTION: This is a total abomination. It only exists to allow various
        // sub components of the various readers to run. This is a memento to the
        // fact, that dependency injection is something we want. Currently, every
        // component could just service locate the whole world via the global $DIC.
        $DIC = $GLOBALS["DIC"];
        $GLOBALS["DIC"] = new DI\Container();
        $GLOBALS["DIC"]["ilDB"] = $db;
        $GLOBALS["DIC"]["ilIliasIniFile"] = $ini;
        $GLOBALS["DIC"]["ilClientIniFile"] = $client_ini;
        $GLOBALS["DIC"]["ilBench"] = null;
        $GLOBALS["DIC"]["ilObjDataCache"] = null;
        $GLOBALS["DIC"]["lng"] = new class () {
            public function loadLanguageModule(): void
            {
            }
        };
        $GLOBALS["DIC"]["ilLog"] = new class () {
            public function write(): void
            {
            }
            public function debug(): void
            {
            }
        };
        $GLOBALS["DIC"]["ilLoggerFactory"] = new class () {
            public function getRootLogger()
            {
                return new class () {
                    public function write(): void
                    {
                    }
                };
            }
            public function getLogger()
            {
                return new class () {
                    public function write(): void
                    {
                    }
                };
            }
        };
        if (!defined("ILIAS_LOG_ENABLED")) {
            define("ILIAS_LOG_ENABLED", false);
        }
        if (!defined("ILIAS_ABSOLUTE_PATH")) {
            define("ILIAS_ABSOLUTE_PATH", dirname(__FILE__, 6));
        }

        $reader = new \ilComponentDefinitionReader(
            new \ilBadgeDefinitionProcessor($db),
            new \ilCOPageDefinitionProcessor($db),
            new \ilComponentInfoDefinitionProcessor(),
            new \ilLoggingDefinitionProcessor($db),
            new \ILIAS\Cron\Setup\DefinitionProcessor(
                $db,
                $settings_factory->settingsFor(),
                $component_repository,
                $component_factory
            ),
            new \ilMailTemplateContextDefinitionProcessor($db),
            new ObjectDefinitionProcessor($db),
            new \ilSystemCheckDefinitionProcessor($db),
            new \ilSecurePathDefinitionProcessor($db),
        );
        $reader->purge();
        $reader->readComponentDefinitions();

        $GLOBALS["DIC"] = $DIC;

        return $environment;
    }

    public function isApplicable(Setup\Environment $environment): bool
    {
        return true;
    }
}