ilBackgroundTasksSetupAgent Class Reference

Inheritance diagram for ilBackgroundTasksSetupAgent:

Collaboration diagram for ilBackgroundTasksSetupAgent:

Public Member Functions
	__construct (Refinery\Factory $refinery)
	hasConfig ()
	getArrayToConfigTransformation ()
	getInstallObjective (Setup\Config $config=null)
	getUpdateObjective (Setup\Config $config=null)
	getBuildArtifactObjective ()
	getStatusObjective (Setup\Metrics\Storage $storage)
	getMigrations ()
	@inheritDoc More...

Protected Attributes
	$refinery

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilBackgroundTasksSetupAgent::__construct

(

Refinery\Factory

$refinery

)

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

      {
        $this->refinery = $refinery;
    }

References $refinery.

Member Function Documentation

getArrayToConfigTransformation()

ilBackgroundTasksSetupAgent::getArrayToConfigTransformation

(

)

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

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

References $data, and ilBackgroundTasksSetupConfig\TYPE_SYNCHRONOUS.

getBuildArtifactObjective()

ilBackgroundTasksSetupAgent::getBuildArtifactObjective

(

)

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

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

getInstallObjective()

ilBackgroundTasksSetupAgent::getInstallObjective

(

Setup\Config

$config = null

)

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

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

References $config.

getMigrations()

ilBackgroundTasksSetupAgent::getMigrations

(

)

@inheritDoc

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

                                    : array
    {
        return [];
    }

getStatusObjective()

ilBackgroundTasksSetupAgent::getStatusObjective

(

Setup\Metrics\Storage

$storage

)

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

                                                                       : Setup\Objective
    {
        return new ilBackgroundTasksMetricsCollectedObjective($storage);
    }

getUpdateObjective()

ilBackgroundTasksSetupAgent::getUpdateObjective

(

Setup\Config

$config = null

)

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

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

References $config.

hasConfig()

ilBackgroundTasksSetupAgent::hasConfig

(

)

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

                                : bool
    {
        return true;
    }

Field Documentation

$refinery

ilBackgroundTasksSetupAgent::$refinery

protected

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

Referenced by __construct().

---

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

• Services/BackgroundTasks/classes/Setup/class.ilBackgroundTasksSetupAgent.php