ilDatabaseInitializedObjective Class Reference

Inheritance diagram for ilDatabaseInitializedObjective:

Collaboration diagram for ilDatabaseInitializedObjective:

Public Member Functions
	getHash ()
	getLabel ()
	isNotable ()
	getPreconditions (Setup\Environment $environment)
	achieve (Setup\Environment $environment)
	isApplicable (Setup\Environment $environment)
	@inheritDoc More...

Detailed Description

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

Member Function Documentation

achieve()

ilDatabaseInitializedObjective::achieve

(

Setup\Environment

$environment

)

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

                                                           : Setup\Environment
    {
        if ($environment->getResource(Setup\Environment::RESOURCE_DATABASE)) {
            return $environment;
        }
 
        $client_ini = $environment->getResource(Setup\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 Setup\UnachievableException(
                "Database cannot be connected."
            );
        }
 
        return $environment->withResource(Setup\Environment::RESOURCE_DATABASE, $db);
    }

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

Here is the call graph for this function:

getHash()

ilDatabaseInitializedObjective::getHash

(

)

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

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

getLabel()

ilDatabaseInitializedObjective::getLabel

(

)

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

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

getPreconditions()

ilDatabaseInitializedObjective::getPreconditions

(

Setup\Environment

$environment

)

Returns

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

Definition at line 43 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 $config.

isApplicable()

ilDatabaseInitializedObjective::isApplicable

(

Setup\Environment

$environment

)

@inheritDoc

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

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

isNotable()

ilDatabaseInitializedObjective::isNotable

(

)

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

                               : bool
    {
        return true;
    }

---

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

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