class.ilUICoreSetupAgent.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

/* Copyright (c) 2021 Thibeau Fuhrer <thf@studer-raimann.ch> Extended GPL, see docs/LICENSE */

use ILIAS\Refinery\Transformation;
use ILIAS\Setup\ObjectiveCollection;
use ILIAS\Setup\Objective\NullObjective;
use ILIAS\Setup\Metrics\Storage;
use ILIAS\Setup\Objective;
use ILIAS\Setup\Agent;
use ILIAS\Setup\Config;
use ILIAS\Setup\ObjectiveConstructor;

class ilUICoreSetupAgent implements Agent
{
    public function hasConfig(): bool
    {
        return false;
    }

    public function getArrayToConfigTransformation(): Transformation
    {
        throw new LogicException(self::class . " has no Config.");
    }

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

    public function getUpdateObjective(Config $config = null): Objective
    {
        return new ilDatabaseUpdateStepsExecutedObjective(
            new ilCtrlDatabaseUpdateSteps()
        );
    }

    public function getBuildArtifactObjective(): Objective
    {
        return new ObjectiveCollection(
            'buildIlCtrlArtifacts',
            false,
            new ilCtrlBaseClassArtifactObjective(),
            new ilCtrlStructureArtifactObjective(),
            new ilCtrlSecurityArtifactObjective(),
        );
    }

    public function getStatusObjective(Storage $storage): Objective
    {
        return new NullObjective();
    }

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

    public function getNamedObjectives(?Config $config = null): array
    {
        return [
            'buildIlCtrlArtifacts' => new ObjectiveConstructor(
                'builds all necessary ilCtrl artifacts.',
                function () {
                    return $this->getBuildArtifactObjective();
                }
            ),

            'updateIlCtrlDatabase' => new ObjectiveConstructor(
                'executes all ilCtrl database update steps.',
                function () {
                    return $this->getUpdateObjective();
                }
            ),
        ];
    }
}