class.ilBackgroundTasksSetupAgent.php

Go to the documentation of this file.

<?php

/* Copyright (c) 2019 Richard Klees <richard.klees@concepts-and-training.de> Extended GPL, see docs/LICENSE */

use ILIAS\Setup;
use ILIAS\Refinery;
use ILIAS\Data;
use ILIAS\UI;

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

    protected $refinery;

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

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

    public function getArrayToConfigTransformation() : Refinery\Transformation
    {
        return $this->refinery->custom()->transformation(function ($data) {
            return new \ilBackgroundTasksSetupConfig(
                $data["type"] ?? \ilBackgroundTasksSetupConfig::TYPE_SYNCHRONOUS,
                $data["max_number_of_concurrent_tasks"] ?? 1
            );
        });
    }

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

    public function getUpdateObjective(Setup\Config $config = null) : Setup\Objective
    {
        if ($config !== null) {
            return new ilBackgroundTasksConfigStoredObjective($config);
        }
        return new Setup\Objective\NullObjective();
    }

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

    public function getStatusObjective(Setup\Metrics\Storage $storage) : Setup\Objective
    {
        return new ilBackgroundTasksMetricsCollectedObjective($storage);
    }

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