ilDatabaseExistsObjective Class Reference

Inheritance diagram for ilDatabaseExistsObjective:

Collaboration diagram for ilDatabaseExistsObjective:

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)
Public Member Functions inherited from ilDatabaseObjective
	__construct (protected \ilDatabaseSetupConfig $config)

Detailed Description

Definition at line 24 of file class.ilDatabaseExistsObjective.php.

Member Function Documentation

achieve()

ilDatabaseExistsObjective::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 60 of file class.ilDatabaseExistsObjective.php.

References ilDBWrapperFactory\getWrapper(), and ILIAS\Setup\Environment\withResource().

                                                     : Environment
    {
        $db = \ilDBWrapperFactory::getWrapper($this->config->getType());
        $db->initFromIniFile($this->config->toMockIniFile());
        $connect = $db->connect(true);
        if (!$connect) {
            throw new UnachievableException(
                "Database cannot be connected. Please check the credentials."
            );
        }

        return $environment->withResource(Environment::RESOURCE_DATABASE, $db);
    }

Here is the call graph for this function:

getHash()

ilDatabaseExistsObjective::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 26 of file class.ilDatabaseExistsObjective.php.

                             : string
    {
        return hash("sha256", implode("-", [
            self::class,
            $this->config->getHost(),
            $this->config->getPort(),
            $this->config->getDatabase()
        ]));
    }

getLabel()

ilDatabaseExistsObjective::getLabel

(

)

Get a label that describes this objective.

Implements ILIAS\Setup\Objective.

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

                              : string
    {
        return "The database exists on the server.";
    }

getPreconditions()

ilDatabaseExistsObjective::getPreconditions

(

Environment

$environment

)

Returns

array<|>

Implements ILIAS\Setup\Objective.

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

                                                              : array
    {
        $preconditions = [
            new \ilDatabaseServerIsConnectableObjective($this->config)
        ];
        if ($this->config->getCreateDatabase()) {
            $preconditions[] = new \ilDatabaseCreatedObjective($this->config);
        }
        return $preconditions;
    }

isApplicable()

ilDatabaseExistsObjective::isApplicable

(

Environment

$environment

)

Implements ILIAS\Setup\Objective.

Definition at line 77 of file class.ilDatabaseExistsObjective.php.

                                                          : bool
    {
        return true;
    }

isNotable()

ilDatabaseExistsObjective::isNotable

(

)

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

Implements ILIAS\Setup\Objective.

Definition at line 41 of file class.ilDatabaseExistsObjective.php.

                               : bool
    {
        return true;
    }

---

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

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