ilDatabaseInitializedObjective Class Reference

Inheritance diagram for ilDatabaseInitializedObjective:

Collaboration diagram for ilDatabaseInitializedObjective:

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)
	@inheritDoc More...
	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)
	Objectives might depend on other objectives. More...
	achieve (Environment $environment)
	Objectives can be achieved. More...
	isApplicable (Environment $environment)
	Get to know whether the objective is applicable. More...

Detailed Description

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

Member Function Documentation

achieve()

ilDatabaseInitializedObjective::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

LogicException if there are unfullfilled preconditions.

Exceptions

RuntimeException if there are missing resources.

Implements ILIAS\Setup\Objective.

Definition at line 62 of file class.ilDatabaseInitializedObjective.php.

                                                     : Environment
    {
        if ($environment->getResource(Environment::RESOURCE_DATABASE)) {
            return $environment;
        }
 
        $client_ini = $environment->getResource(Environment::RESOURCE_CLIENT_INI);
 
        $type = $client_ini->readVariable("db", "type");
        if ($type === "") {
            $type = ilDBConstants::TYPE_INNODB;
        }
 
        $db = \ilDBWrapperFactory::getWrapper($type);
        $db->initFromIniFile($client_ini);
        $connect = $db->connect(true);
        if (!$connect) {
            throw new UnachievableException(
                "Database cannot be connected."
            );
        }
 
        return $environment->withResource(Environment::RESOURCE_DATABASE, $db);
    }

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

Here is the call graph for this function:

getHash()

ilDatabaseInitializedObjective::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.ilDatabaseInitializedObjective.php.

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

getLabel()

ilDatabaseInitializedObjective::getLabel

(

)

Get a label that describes this objective.

Implements ILIAS\Setup\Objective.

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

                              : string
    {
        return "The database object is initialized.";
    }

getPreconditions()

ilDatabaseInitializedObjective::getPreconditions

(

Environment

$environment

)

Returns

array<\ilIniFilesLoadedObjective>|array<\ilDatabaseConfigStoredObjective|\ilDatabasePopulatedObjective>

Implements ILIAS\Setup\Objective.

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

                                                              : array
    {
        // If there is no config for the database the existing config seems
        // to be ok, and we can just connect.
        if (!$environment->hasConfigFor("database")) {
            return [
                new ilIniFilesLoadedObjective()
            ];
        }
 
        $config = $environment->getConfigFor("database");
        return [
            new ilDatabasePopulatedObjective($config),
            new ilDatabaseConfigStoredObjective($config)
        ];
    }

References ILIAS\Setup\Environment\getConfigFor(), and ILIAS\Setup\Environment\hasConfigFor().

Here is the call graph for this function:

isApplicable()

ilDatabaseInitializedObjective::isApplicable

(

Environment

$environment

)

@inheritDoc

Implements ILIAS\Setup\Objective.

Definition at line 90 of file class.ilDatabaseInitializedObjective.php.

                                                          : bool
    {
        return $environment->getResource(Environment::RESOURCE_CLIENT_INI) !== null;
    }

References ILIAS\Setup\Environment\getResource().

Here is the call graph for this function:

isNotable()

ilDatabaseInitializedObjective::isNotable

(

)

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

Implements ILIAS\Setup\Objective.

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

                               : bool
    {
        return true;
    }

---

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

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