ilBackgroundTasksSetupAgent Class Reference

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)
	getUpdateObjective (?Config $config=null)
	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 ()
Public Member Functions inherited from ILIAS\Setup\Agent
	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...
	getStatusObjective (Metrics\Storage $storage)
	Get the objective to be achieved when status is requested. 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.

    {
    }

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.

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

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

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

)

PhpParamsInspection

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

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

getMigrations()

ilBackgroundTasksSetupAgent::getMigrations

(

)

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

)

PhpParamsInspection

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

References null.

                                                              : 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