Inheritance diagram for ilBackgroundTasksSetupAgent:

Collaboration diagram for ilBackgroundTasksSetupAgent:

Public Member Functions

__construct (protected Factory $refinery)

hasConfig ()

Does this agent require a configuration? More...

getArrayToConfigTransformation ()

Agents must be able to tell how to create a configuration from a nested array.

Exceptions

LogicException if Agent has no Config

More...

getInstallObjective (?Config $config=null)

Get the goals the agent wants to achieve on setup.The provided configuration is to be used to set according configuration values in the installation.

Exceptions

InvalidArgumentException if Config does not match the Agent..

More...

getUpdateObjective (?Config $config=null)

Get the goal the agent wants to achieve on update.The provided configuration is to be used to change according configuration values in the installation. If this is not possible for some reason, an according UnachievableException needs to be thrown in the according objective.The configuration is not to be used to initialize the required environment for the objectives. This must be done via ClientIdReadObjective and depending objectives like ilIniFilesLoadedObjective.If no configuration is provided the configuration of the component should stay as is.

Exceptions

InvalidArgumentException if Config does not match the Agent..

More...

getBuildObjective ()

Get the goal the agent wants to achieve to build artifacts.

Exceptions

InvalidArgumentException if Config does not match the Agent.

More...

getStatusObjective (Storage $storage)

getMigrations ()

@inheritDoc More...

Public Member Functions inherited from ILIAS\Setup\Agent

hasConfig ()

Does this agent require a configuration? More...

getArrayToConfigTransformation ()

Agents must be able to tell how to create a configuration from a nested array. More...

getInstallObjective (?Config $config=null)

Get the goals the agent wants to achieve on setup. More...

getUpdateObjective (?Config $config=null)

Get the goal the agent wants to achieve on update. More...

getBuildObjective ()

Get the goal the agent wants to achieve to build artifacts. More...

getStatusObjective (Metrics\Storage $storage)

Get the objective to be achieved when status is requested. More...

getMigrations ()

Get a named map of migrations available for this Agent. More...

getNamedObjectives (?Config $config=null)

Gets all named objectives The keys of the returned array are the commands. More...

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilBackgroundTasksSetupAgent::__construct ( protected Factory $refinery )

Definition at line 33 of file class.ilBackgroundTasksSetupAgent.php.

34 {

35 }

Member Function Documentation

◆ getArrayToConfigTransformation()

ilBackgroundTasksSetupAgent::getArrayToConfigTransformation ( )

Agents must be able to tell how to create a configuration from a nested array.

Exceptions

LogicException if Agent has no Config

Implements ILIAS\Setup\Agent.

Definition at line 48 of file class.ilBackgroundTasksSetupAgent.php.

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

References $data, ILIAS\Repository\refinery(), and ilBackgroundTasksSetupConfig\TYPE_SYNCHRONOUS.

Here is the call graph for this function:

◆ getBuildObjective()

ilBackgroundTasksSetupAgent::getBuildObjective ( )

Get the goal the agent wants to achieve to build artifacts.

Exceptions

InvalidArgumentException if Config does not match the Agent.

Implements ILIAS\Setup\Agent.

Definition at line 80 of file class.ilBackgroundTasksSetupAgent.php.

                                       : Objective
    {
        return new NullObjective();
    }

◆ getInstallObjective()

ilBackgroundTasksSetupAgent::getInstallObjective ( ?Config $config = null )

Get the goals the agent wants to achieve on setup.The provided configuration is to be used to set according configuration values in the installation.

Exceptions

InvalidArgumentException if Config does not match the Agent..

@noinspection PhpParamsInspection

Implements ILIAS\Setup\Agent.

Definition at line 59 of file class.ilBackgroundTasksSetupAgent.php.

                                                               : Objective
    {
        return new ilBackgroundTasksConfigStoredObjective($config);
    }

◆ getMigrations()

ilBackgroundTasksSetupAgent::getMigrations ( )

@inheritDoc

Implements ILIAS\Setup\Agent.

Definition at line 101 of file class.ilBackgroundTasksSetupAgent.php.

                                   : array
    {
        return [];
    }

◆ getStatusObjective()

ilBackgroundTasksSetupAgent::getStatusObjective ( Storage $storage )

Definition at line 88 of file class.ilBackgroundTasksSetupAgent.php.

                                                        : Objective
    {
        return new ObjectiveCollection(
            'Component BackgroundTasks',
            true,
            new ilBackgroundTasksMetricsCollectedObjective($storage),
            new ilDatabaseUpdateStepsMetricsCollectedObjective($storage, new ilBackgroundTasksDB80())
        );
    }

◆ getUpdateObjective()

ilBackgroundTasksSetupAgent::getUpdateObjective ( ?Config $config = null )

Get the goal the agent wants to achieve on update.The provided configuration is to be used to change according configuration values in the installation. If this is not possible for some reason, an according UnachievableException needs to be thrown in the according objective.The configuration is not to be used to initialize the required environment for the objectives. This must be done via ClientIdReadObjective and depending objectives like ilIniFilesLoadedObjective.If no configuration is provided the configuration of the component should stay as is.

Exceptions

InvalidArgumentException if Config does not match the Agent..

@noinspection PhpParamsInspection

Implements ILIAS\Setup\Agent.

Definition at line 68 of file class.ilBackgroundTasksSetupAgent.php.

                                                              : Objective
    {
        if ($config !== null) {
            return new ilBackgroundTasksConfigStoredObjective($config);
        }
        return new NullObjective();
    }

◆ hasConfig()

ilBackgroundTasksSetupAgent::hasConfig ( )

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 40 of file class.ilBackgroundTasksSetupAgent.php.

                               : bool
    {
        return true;
    }

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

components/ILIAS/BackgroundTasks_/classes/Setup/class.ilBackgroundTasksSetupAgent.php