ilDatabaseSetupAgent Class Reference

Inheritance diagram for ilDatabaseSetupAgent:

Collaboration diagram for ilDatabaseSetupAgent:

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

Protected Attributes
Refinery	$refinery

Detailed Description

Definition at line 25 of file class.ilDatabaseSetupAgent.php.

Constructor & Destructor Documentation

__construct()

ilDatabaseSetupAgent::__construct

(

Refinery

$refinery

)

Definition at line 31 of file class.ilDatabaseSetupAgent.php.

    {
        $this->refinery = $refinery;
    }

References $refinery, and ILIAS\Repository\refinery().

Here is the call graph for this function:

Member Function Documentation

getArrayToConfigTransformation()

ilDatabaseSetupAgent::getArrayToConfigTransformation

(

)

@inheritdocs

Definition at line 47 of file class.ilDatabaseSetupAgent.php.

                                                    : Transformation
    {
        // TODO: Migrate this to refinery-methods once possible.
        return $this->refinery->custom()->transformation(function ($data): \ilDatabaseSetupConfig {
            $data["password"] = $data["password"] ?? null; // password can be empty
            $password = $this->refinery->to()->data("password");
            return new \ilDatabaseSetupConfig(
                $data["type"] ?? "innodb",
                $data["host"] ?? "localhost",
                $data["database"] ?? "ilias",
                $data["user"] ?? null,
                $data["password"] ? $password->transform($data["password"]) : null,
                $data["create_database"] ?? true,
                $data["collation"] ?? null,
                (int) ($data["port"] ?? 3306),
                $data["path_to_db_dump"] ?? null
            );
        });
    }

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

Here is the call graph for this function:

getBuildArtifactObjective()

ilDatabaseSetupAgent::getBuildArtifactObjective

(

)

@inheritdocs

Definition at line 102 of file class.ilDatabaseSetupAgent.php.

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

getInstallObjective()

ilDatabaseSetupAgent::getInstallObjective

(

Setup\Config

$config = null

)

@inheritdocs

Definition at line 70 of file class.ilDatabaseSetupAgent.php.

                                                                    : Setup\Objective
    {
        if (!$config instanceof \ilDatabaseSetupConfig) {
            return new Setup\Objective\NullObjective();
        }
        return new Setup\ObjectiveCollection(
            "Complete objectives from Services\Database",
            false,
            new ilDatabaseConfigStoredObjective($config),
            new ilDatabaseEnvironmentValidObjective(),
            new \ilDatabaseUpdatedObjective()
        );
    }

References $config.

getMigrations()

ilDatabaseSetupAgent::getMigrations

(

)

@inheritDoc

Definition at line 118 of file class.ilDatabaseSetupAgent.php.

                                   : array
    {
        return [
            new Setup\ilMysqlMyIsamToInnoDbMigration()
        ];
    }

getNamedObjectives()

ilDatabaseSetupAgent::getNamedObjectives

(

?Setup\Config

$config = null

)

Definition at line 125 of file class.ilDatabaseSetupAgent.php.

                                                                    : array
    {
        return [
            'resetFailedSteps' => new Setup\ObjectiveConstructor(
                'reset null-states in il_db_steps',
                static fn (): Setup\Objective => new ilDatabaseResetStepsObjective()
            )
        ];
    }

getStatusObjective()

ilDatabaseSetupAgent::getStatusObjective

(

Setup\Metrics\Storage

$storage

)

Definition at line 110 of file class.ilDatabaseSetupAgent.php.

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

getUpdateObjective()

ilDatabaseSetupAgent::getUpdateObjective

(

Setup\Config

$config = null

)

@inheritdocs

Definition at line 87 of file class.ilDatabaseSetupAgent.php.

                                                                   : Setup\Objective
    {
        $p = [];
        $p[] = new \ilDatabaseUpdatedObjective();
        $p[] = new ilDatabaseEnvironmentValidObjective();
        return new Setup\ObjectiveCollection(
            "Complete objectives from Services\Database",
            false,
            ...$p
        );
    }

hasConfig()

ilDatabaseSetupAgent::hasConfig

(

)

@inheritdocs

Definition at line 39 of file class.ilDatabaseSetupAgent.php.

                               : bool
    {
        return true;
    }

Field Documentation

$refinery

Refinery ilDatabaseSetupAgent::$refinery

protected

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

Referenced by __construct().

---

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

• Services/Database/classes/Setup/class.ilDatabaseSetupAgent.php