ilDatabaseExistsObjective Class Reference

Inheritance diagram for ilDatabaseExistsObjective:

Collaboration diagram for ilDatabaseExistsObjective:

Public Member Functions
	getHash ()
	getLabel ()
	isNotable ()
	getPreconditions (Setup\Environment $environment)
	achieve (Setup\Environment $environment)
	isApplicable (Setup\Environment $environment)
	@inheritDoc More...
Public Member Functions inherited from ilDatabaseObjective
	__construct (\ilDatabaseSetupConfig $config)

Additional Inherited Members
Protected Attributes inherited from ilDatabaseObjective
ilDatabaseSetupConfig	$config

Detailed Description

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

Member Function Documentation

achieve()

ilDatabaseExistsObjective::achieve

(

Setup\Environment

$environment

)

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

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

References ilDBWrapperFactory\getWrapper().

Here is the call graph for this function:

getHash()

ilDatabaseExistsObjective::getHash

(

)

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

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

getLabel()

ilDatabaseExistsObjective::getLabel

(

)

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

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

getPreconditions()

ilDatabaseExistsObjective::getPreconditions

(

Setup\Environment

$environment

)

Returns

array<\ilDatabaseServerIsConnectableObjective|\ilDatabaseCreatedObjective>

Definition at line 48 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

(

Setup\Environment

$environment

)

@inheritDoc

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

                                                                : bool
    {
        return true;
    }

isNotable()

ilDatabaseExistsObjective::isNotable

(

)

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

                               : bool
    {
        return true;
    }

---

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

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