ilDatabaseUpdatedObjective Class Reference

Inheritance diagram for ilDatabaseUpdatedObjective:

Collaboration diagram for ilDatabaseUpdatedObjective:

Public Member Functions
	getHash ()
	Get a hash for this objective. More...
	getLabel ()
	Get a label that describes this objective. More...
	isNotable ()
	Get to know if this is an interesting objective for a human. More...
	getPreconditions (Environment $environment)
	achieve (Environment $environment)
	Objectives can be achieved. More...
	isApplicable (Environment $environment)

Detailed Description

Definition at line 27 of file class.ilDatabaseUpdatedObjective.php.

Member Function Documentation

achieve()

ilDatabaseUpdatedObjective::achieve

(

Environment

$environment

)

Objectives can be achieved.

They might add resources to the environment when they have been achieved.

This method needs to be idempotent for a given environment. That means: if this is executed a second time, nothing new should happen. Or the other way round: if the environment already looks like desired, the objective should not take any further actions when this is called.

Exceptions

Implements ILIAS\Setup\Objective.

Definition at line 52 of file class.ilDatabaseUpdatedObjective.php.

References $client_id, $DIC, $GLOBALS, $ini, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Setup\Environment\getResource(), ILIAS\UI\examples\MessageBox\Info\info(), and null.

                                                     : Environment
    {
        $db = $environment->getResource(Environment::RESOURCE_DATABASE);
        $io = $environment->getResource(Environment::RESOURCE_ADMIN_INTERACTION);
        $ini = $environment->getResource(Environment::RESOURCE_ILIAS_INI);
        $client_ini = $environment->getResource(Environment::RESOURCE_CLIENT_INI);
        $client_id = $environment->getResource(Environment::RESOURCE_CLIENT_ID);

        // ATTENTION: This is a total abomination. It only exists to allow the db-
        // update 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 Container();
        $GLOBALS["DIC"]["ilDB"] = $db;
        $GLOBALS["ilDB"] = $db;
        $GLOBALS["DIC"]["ilBench"] = null;
        $GLOBALS["DIC"]["ilLog"] = new class ($io) {
            public function __construct(protected $io)
            {
            }

            public function write(): void
            {
            }

            public function info(): void
            {
            }

            public function warning($msg): void
            {
                $this->io->inform($msg);
            }

            public function error($msg): never
            {
                throw new UnachievableException(
                    "Problem in DB-Update: $msg"
                );
            }
        };
        $GLOBALS["ilLog"] = $GLOBALS["DIC"]["ilLog"];
        $GLOBALS["DIC"]["ilLoggerFactory"] = new class () {
            public function getRootLogger(): object
            {
                return new class () {
                    public function write(): void
                    {
                    }
                };
            }
        };
        $GLOBALS["ilCtrlStructureReader"] = new class () {
            public function getStructure(): void
            {
            }

            public function setIniFile(): void
            {
            }
        };
        if (!defined("CLIENT_DATA_DIR")) {
            define("CLIENT_DATA_DIR", $ini->readVariable("clients", "datadir") . "/" . $client_id);
        }
        if (!defined("CLIENT_WEB_DIR")) {
            define("CLIENT_WEB_DIR", dirname(__DIR__, 5) . "/public/data/" . $client_id);
        }
        if (!defined("ILIAS_ABSOLUTE_PATH")) {
            define("ILIAS_ABSOLUTE_PATH", dirname(__FILE__, 6));
        }
        if (!defined("ILIAS_LOG_ENABLED")) {
            define("ILIAS_LOG_ENABLED", false);
        }
        if (!defined("ROOT_FOLDER_ID")) {
            define("ROOT_FOLDER_ID", (int) $client_ini->readVariable("system", "ROOT_FOLDER_ID"));
        }
        if (!defined("ROLE_FOLDER_ID")) {
            define("ROLE_FOLDER_ID", (int) $client_ini->readVariable("system", "ROLE_FOLDER_ID"));
        }
        if (!defined("SYSTEM_FOLDER_ID")) {
            define("SYSTEM_FOLDER_ID", (int) $client_ini->readVariable("system", "SYSTEM_FOLDER_ID"));
        }

        $db_update = new ilDBUpdate($db);
        $db_update->applyCustomUpdates();

        $GLOBALS["DIC"] = $DIC;

        return $environment;
    }

Here is the call graph for this function:

getHash()

ilDatabaseUpdatedObjective::getHash

(

)

Get a hash for this objective.

The hash of two objectives must be the same, if they are the same objective, with the same config on the same environment, i.e. if the one is achieved the other is achieved as well because they are the same.

Implements ILIAS\Setup\Objective.

Definition at line 29 of file class.ilDatabaseUpdatedObjective.php.

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

getLabel()

ilDatabaseUpdatedObjective::getLabel

(

)

Get a label that describes this objective.

Implements ILIAS\Setup\Objective.

Definition at line 34 of file class.ilDatabaseUpdatedObjective.php.

                              : string
    {
        return "The database is updated.";
    }

getPreconditions()

ilDatabaseUpdatedObjective::getPreconditions

(

Environment

$environment

)

Returns

[]|ClientIdReadObjective[]|[]

Implements ILIAS\Setup\Objective.

Definition at line 47 of file class.ilDatabaseUpdatedObjective.php.

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

isApplicable()

ilDatabaseUpdatedObjective::isApplicable

(

Environment

$environment

)

Implements ILIAS\Setup\Objective.

Definition at line 148 of file class.ilDatabaseUpdatedObjective.php.

                                                          : bool
    {
        return true;
    }

isNotable()

ilDatabaseUpdatedObjective::isNotable

(

)

Get to know if this is an interesting objective for a human.

Implements ILIAS\Setup\Objective.

Definition at line 39 of file class.ilDatabaseUpdatedObjective.php.

                               : bool
    {
        return true;
    }

---

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

• components/ILIAS/Database/classes/Setup/class.ilDatabaseUpdatedObjective.php