class.ilVersionWrittenToSettingsObjective.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Setup;
use ILIAS\Data;

class ilVersionWrittenToSettingsObjective implements Setup\Objective
{
    public const ILIAS_VERSION_KEY = "ilias_version";

    protected Data\Factory $data_factory;

    public function __construct(Data\Factory $data_factory)
    {
        $this->data_factory = $data_factory;
    }

    public function getHash(): string
    {
        return hash(
            "sha256",
            get_class($this)
        );
    }

    public function getLabel(): string
    {
        return "The ILIAS Version is written to the settings.";
    }

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

    public function getPreconditions(Setup\Environment $environment): array
    {
        return [
            new ilSettingsFactoryExistsObjective()
        ];
    }

    public function achieve(Setup\Environment $environment): Setup\Environment
    {
        $factory = $environment->getResource(Setup\Environment::RESOURCE_SETTINGS_FACTORY);
        $settings = $factory->settingsFor("common");

        $current_version = $this->data_factory->version(ILIAS_VERSION_NUMERIC);
        $settings->set(self::ILIAS_VERSION_KEY, (string) $current_version);

        return $environment;
    }

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