ilDatabaseConfigStoredObjective Class Reference

Inheritance diagram for ilDatabaseConfigStoredObjective:

Collaboration diagram for ilDatabaseConfigStoredObjective:

Public Member Functions
	getHash ()
	Get a hash for this objective. More...
	getLabel ()
	Get a label that describes this objective. More...
	isNotable ()
	Get to know if this is an interesting objective for a human. More...
	getPreconditions (Environment $environment)
	achieve (Environment $environment)
	Objectives can be achieved. More...
	isApplicable (Environment $environment)
	Get to know whether the objective is applicable. More...
Public Member Functions inherited from ilDatabaseObjective
	__construct (protected \ilDatabaseSetupConfig $config)

Detailed Description

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

Member Function Documentation

achieve()

ilDatabaseConfigStoredObjective::achieve

(

Environment

$environment

)

Objectives can be achieved.

They might add resources to the environment when they have been achieved.

This method needs to be idempotent for a given environment. That means: if this is executed a second time, nothing new should happen. Or the other way round: if the environment already looks like desired, the objective should not take any further actions when this is called.

Exceptions

Implements ILIAS\Setup\Objective.

Definition at line 53 of file class.ilDatabaseConfigStoredObjective.php.

References ILIAS\Setup\Environment\getResource(), and null.

                                                     : Environment
    {
        $client_ini = $environment->getResource(Environment::RESOURCE_CLIENT_INI);

        $type = $this->config->getType();

        if ($type === 'postgres' || $type === 'pdo-postgre') {
            throw new NotExecutableException('ILIAS 8 no longer Supports POSTGRES');
        }

        $client_ini->setVariable("db", "type", $type);
        $client_ini->setVariable("db", "host", $this->config->getHost());
        $client_ini->setVariable("db", "name", $this->config->getDatabase());
        $client_ini->setVariable("db", "user", $this->config->getUser());
        $client_ini->setVariable("db", "port", (string) ($this->config->getPort() ?? ""));
        $pw = $this->config->getPassword();
        $client_ini->setVariable("db", "pass", $pw !== null ? $pw->toString() : "");

        if (!$client_ini->write()) {
            throw new UnachievableException("Could not write client.ini.php");
        }

        return $environment;
    }

Here is the call graph for this function:

getHash()

ilDatabaseConfigStoredObjective::getHash

(

)

Get a hash for this objective.

The hash of two objectives must be the same, if they are the same objective, with the same config on the same environment, i.e. if the one is achieved the other is achieved as well because they are the same.

Implements ILIAS\Setup\Objective.

Definition at line 27 of file class.ilDatabaseConfigStoredObjective.php.

                             : string
    {
        return hash("sha256", self::class);
    }

getLabel()

ilDatabaseConfigStoredObjective::getLabel

(

)

Get a label that describes this objective.

Implements ILIAS\Setup\Objective.

Definition at line 32 of file class.ilDatabaseConfigStoredObjective.php.

                              : string
    {
        return "Fill ini with settings for Services/Database";
    }

getPreconditions()

ilDatabaseConfigStoredObjective::getPreconditions

(

Environment

$environment

)

Returns

array<int, |>

Implements ILIAS\Setup\Objective.

Definition at line 45 of file class.ilDatabaseConfigStoredObjective.php.

                                                              : array
    {
        return [
            new ilIniFilesLoadedObjective(),
            new ilDatabaseExistsObjective($this->config)
        ];
    }

isApplicable()

ilDatabaseConfigStoredObjective::isApplicable

(

Environment

$environment

)

Get to know whether the objective is applicable.

Don't change the environment or cause changes on services in the environment. Just check if this objective needs to be achieved, either currently or at all. In case of doubt whether the objective is applicable or not return true.

Implements ILIAS\Setup\Objective.

Definition at line 78 of file class.ilDatabaseConfigStoredObjective.php.

References ILIAS\Setup\Environment\getResource(), and null.

                                                          : bool
    {
        $client_ini = $environment->getResource(Environment::RESOURCE_CLIENT_INI);

        $port = $this->config->getPort() ?? "";
        $pass = $this->config->getPassword() !== null ? $this->config->getPassword()->toString() : "";
        if ($client_ini->readVariable("db", "type") !== $this->config->getType()) {
            return true;
        }
        if ($client_ini->readVariable("db", "host") !== $this->config->getHost()) {
            return true;
        }
        if ($client_ini->readVariable("db", "name") !== $this->config->getDatabase()) {
            return true;
        }
        if ($client_ini->readVariable("db", "user") !== $this->config->getUser()) {
            return true;
        }
        if ($client_ini->readVariable("db", "port") !== $port) {
            return true;
        }
        return $client_ini->readVariable("dv", "pass") !== $pass;
    }

Here is the call graph for this function:

isNotable()

ilDatabaseConfigStoredObjective::isNotable

(

)

Get to know if this is an interesting objective for a human.

Implements ILIAS\Setup\Objective.

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

                               : bool
    {
        return false;
    }

---

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

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