ilDatabaseServerIsConnectableObjective Class Reference

Inheritance diagram for ilDatabaseServerIsConnectableObjective:

Collaboration diagram for ilDatabaseServerIsConnectableObjective:

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)
	Objectives might depend on other objectives. More...
	achieve (Environment $environment)
	Objectives can be achieved. More...
	isApplicable (Environment $environment)
	@inheritDoc More...
Public Member Functions inherited from ilDatabaseObjective
	__construct (protected \ilDatabaseSetupConfig $config)
	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 24 of file ilDatabaseServerIsConnectableObjective.php.

Member Function Documentation

achieve()

ilDatabaseServerIsConnectableObjective::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 53 of file ilDatabaseServerIsConnectableObjective.php.

                                                     : 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;
            }
 
            $connect = true;
        }
        if (!$connect) {
            throw new 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

(

)

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 ilDatabaseServerIsConnectableObjective.php.

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

getLabel()

ilDatabaseServerIsConnectableObjective::getLabel

(

)

Get a label that describes this objective.

Implements ILIAS\Setup\Objective.

Definition at line 38 of file ilDatabaseServerIsConnectableObjective.php.

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

getPreconditions()

ilDatabaseServerIsConnectableObjective::getPreconditions

(

Environment

$environment

)

Objectives might depend on other objectives.

Exceptions

UnachievableException

if the objective is not achievable

Returns

Objective[]

Implements ILIAS\Setup\Objective.

Definition at line 48 of file ilDatabaseServerIsConnectableObjective.php.

                                                              : array
    {
        return [];
    }

isApplicable()

ilDatabaseServerIsConnectableObjective::isApplicable

(

Environment

$environment

)

@inheritDoc

Implements ILIAS\Setup\Objective.

Definition at line 80 of file ilDatabaseServerIsConnectableObjective.php.

                                                          : bool
    {
        return true;
    }

isNotable()

ilDatabaseServerIsConnectableObjective::isNotable

(

)

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

Implements ILIAS\Setup\Objective.

Definition at line 43 of file ilDatabaseServerIsConnectableObjective.php.

                               : bool
    {
        return true;
    }

---

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

• components/ILIAS/Database/classes/Setup/ilDatabaseServerIsConnectableObjective.php