class.ilLoggingSetupAgent.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Setup;
use ILIAS\Setup\Config;
use ILIAS\Setup\Objective;
use ILIAS\Setup\Metrics\Storage;
use ILIAS\Refinery\Factory;
use ILIAS\Refinery\Transformation;
use ILIAS\UI;

class ilLoggingSetupAgent implements Setup\Agent
{
    use Setup\Agent\HasNoNamedObjective;

    protected Factory $refinery;

    public function __construct(Factory $refinery)
    {
        $this->refinery = $refinery;
    }

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

    public function getArrayToConfigTransformation(): Transformation
    {
        return $this->refinery->custom()->transformation(function ($data) {
            return new \ilLoggingSetupConfig(
                $data["enable"] ?? false,
                $data["path_to_logfile"] ?? null,
                $data["errorlog_dir"] ?? null
            );
        });
    }

    public function getInstallObjective(Config $config = null): Objective
    {
        return new ilLoggingConfigStoredObjective($config);
    }

    public function getUpdateObjective(Config $config = null): Objective
    {
        $objective = new Setup\Objective\NullObjective();
        if ($config !== null) {
            $objective = new ilLoggingConfigStoredObjective($config);
        }
        return new ILIAS\Setup\ObjectiveCollection(
            'Update of Services/Logging',
            false,
            $objective,
            new ilDatabaseUpdateStepsExecutedObjective(
                new ilLoggingUpdateSteps8()
            )
        );
    }

    public function getBuildArtifactObjective(): Objective
    {
        return new Setup\Objective\NullObjective();
    }

    public function getStatusObjective(Storage $storage): Objective
    {
        return new Setup\ObjectiveCollection(
            'Component Logging',
            true,
            new ilLoggingMetricsCollectedObjective($storage),
            new ilDatabaseUpdateStepsMetricsCollectedObjective($storage, new ilLoggingUpdateSteps8())
        );
    }

    public function getMigrations(): array
    {
        return [];
    }
}