ilDatabaseServerIsConnectableObjective Class Reference

Inheritance diagram for ilDatabaseServerIsConnectableObjective:

Collaboration diagram for ilDatabaseServerIsConnectableObjective:

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

Additional Inherited Members
Protected Attributes inherited from ilDatabaseObjective
	$config

Detailed Description

Definition at line 7 of file class.ilDatabaseServerIsConnectableObjective.php.

Member Function Documentation

achieve()

ilDatabaseServerIsConnectableObjective::achieve

(

Setup\Environment

$environment

)

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

                                                            : Setup\Environment
    {
        $db = \ilDBWrapperFactory::getWrapper($this->config->getType());
        $db->initFromIniFile($this->config->toMockIniFile());
        try {
            $connect = $db->connect();
        } catch (PDOException $e) {
            // 1049 is "unknown database", which is ok because we propably didn't
            // install the db yet,.
            if ($e->getCode() != 1049) {
                throw $e;
            } else {
                $connect = true;
            }
        }
        if (!$connect) {
            throw new Setup\UnachievableException(
                "Database cannot be reached. Please check the credentials."
            );
        }
        return $environment;
    }

References Vendor\Package\$e, and ilDBWrapperFactory\getWrapper().

Here is the call graph for this function:

getHash()

ilDatabaseServerIsConnectableObjective::getHash

(

)

Definition at line 9 of file class.ilDatabaseServerIsConnectableObjective.php.

                              : string
    {
        $pw = $this->config->getPassword();
        return hash("sha256", implode("-", [
            self::class,
            $this->config->getHost(),
            $this->config->getPort(),
            $this->config->getUser(),
            $pw ? $pw->toString() : ""
        ]));
    }

getLabel()

ilDatabaseServerIsConnectableObjective::getLabel

(

)

Definition at line 21 of file class.ilDatabaseServerIsConnectableObjective.php.

                               : string
    {
        return "The database server is connectable with the supplied configuration.";
    }

getPreconditions()

ilDatabaseServerIsConnectableObjective::getPreconditions

(

Setup\Environment

$environment

)

Definition at line 31 of file class.ilDatabaseServerIsConnectableObjective.php.

                                                                     : array
    {
        return [];
    }

isNotable()

ilDatabaseServerIsConnectableObjective::isNotable

(

)

Definition at line 26 of file class.ilDatabaseServerIsConnectableObjective.php.

                                : bool
    {
        return true;
    }

---

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

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