ilDatabaseSetupAgent Class Reference

Inheritance diagram for ilDatabaseSetupAgent:

Collaboration diagram for ilDatabaseSetupAgent:

Public Member Functions
	__construct (protected Refinery $refinery)
	hasConfig ()
	getArrayToConfigTransformation ()
	getInstallObjective (Config $config=null)
	getUpdateObjective (Config $config=null)
	getBuildObjective ()
	getStatusObjective (Storage $storage)
	getMigrations ()
	getNamedObjectives (?Config $config=null)
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 33 of file class.ilDatabaseSetupAgent.php.

Constructor & Destructor Documentation

__construct()

ilDatabaseSetupAgent::__construct

(

protected Refinery

$refinery

)

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

    {
    }

Member Function Documentation

getArrayToConfigTransformation()

ilDatabaseSetupAgent::getArrayToConfigTransformation

(

)

Implements ILIAS\Setup\Agent.

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

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

                                                    : Transformation
    {
        // TODO: Migrate this to refinery-methods once possible.
        return $this->refinery->custom()->transformation(function ($data): \ilDatabaseSetupConfig {
            $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
            );
        });
    }

Here is the call graph for this function:

getBuildObjective()

ilDatabaseSetupAgent::getBuildObjective

(

)

Implements ILIAS\Setup\Agent.

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

                                       : Objective
    {
        return new NullObjective();
    }

getInstallObjective()

ilDatabaseSetupAgent::getInstallObjective

(

Config

$config = null

)

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

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

getMigrations()

ilDatabaseSetupAgent::getMigrations

(

)

Implements ILIAS\Setup\Agent.

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

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

getNamedObjectives()

ilDatabaseSetupAgent::getNamedObjectives

(

?Config

$config = null

)

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

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

getStatusObjective()

ilDatabaseSetupAgent::getStatusObjective

(

Storage

$storage

)

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

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

getUpdateObjective()

ilDatabaseSetupAgent::getUpdateObjective

(

Config

$config = null

)

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

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

hasConfig()

ilDatabaseSetupAgent::hasConfig

(

)

Implements ILIAS\Setup\Agent.

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

                               : bool
    {
        return true;
    }

---

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

• components/ILIAS/Database/classes/Setup/class.ilDatabaseSetupAgent.php