ilDatabaseEnvironmentValidObjective Class Reference

Inheritance diagram for ilDatabaseEnvironmentValidObjective:

Collaboration diagram for ilDatabaseEnvironmentValidObjective:

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)
	isApplicable (Environment $environment)
	@inheritDoc More...
Public Member Functions inherited from ILIAS\Setup\Objective
	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...

Protected Member Functions
	checkDefaultEngine (ilDBInterface $db)
	checkRowFormat (ilDBInterface $db)
	checkDBAvailable (?ilDBInterface $db)

Private Attributes
const	ROW_FORMAT_DYNAMIC = "DYNAMIC"
const	INNO_DB = "InnoDB"

Detailed Description

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

Member Function Documentation

checkDBAvailable()

ilDatabaseEnvironmentValidObjective::checkDBAvailable ( ?ilDBInterface  $db )

protected

Parameters

ilDBInterface

$db

Returns

void

Definition at line 115 of file class.ilDatabaseEnvironmentValidObjective.php.

                                                           : void
    {
        if ($db === null) {
            throw new UnachievableException(
                "Database cannot be connected. Please check the credentials."
            );
        }
    }

checkDefaultEngine()

ilDatabaseEnvironmentValidObjective::checkDefaultEngine ( ilDBInterface  $db )

protected

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

    {
        $default_engine = 'unknown';
        try {
            $r = $db->query('SHOW ENGINES ');
            while ($d = $db->fetchObject($r)) {
                if (strtoupper((string) $d->Support) === 'DEFAULT') {
                    $default_engine = strtolower((string) $d->Engine);
                    break;
                }
            }
        } catch (Throwable) {
        }
        $default_engine = strtolower($default_engine);
 
        if ($default_engine !== strtolower(self::INNO_DB)) {
            throw new UnachievableException(
                "The default database engine is not set to '" . self::INNO_DB
                . ", `$default_engine` given'. Please set the default database engine to '"
                . self::INNO_DB . " to proceed'."
            );
        }
    }

References Vendor\Package\$d, ilDBInterface\fetchObject(), and ilDBInterface\query().

Here is the call graph for this function:

checkRowFormat()

ilDatabaseEnvironmentValidObjective::checkRowFormat ( ilDBInterface  $db )

protected

Definition at line 100 of file class.ilDatabaseEnvironmentValidObjective.php.

                                                        : void
    {
        $setting = $db->fetchObject($db->query('SELECT @@GLOBAL.innodb_default_row_format AS row_format;'));
        $row_format = $setting->row_format ?? null;
        if ($row_format === null || strtoupper((string) $row_format) !== self::ROW_FORMAT_DYNAMIC) {
            throw new UnachievableException(
                "The default row format of the database is not set to '" . self::ROW_FORMAT_DYNAMIC . "'. Please set the default row format to " . self::ROW_FORMAT_DYNAMIC . " and run an 'OPTIMIZE TABLE' for each of your database tables before you continue."
            );
        }
    }

References ilDBInterface\fetchObject(), and ilDBInterface\query().

Here is the call graph for this function:

getHash()

ilDatabaseEnvironmentValidObjective::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 36 of file class.ilDatabaseEnvironmentValidObjective.php.

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

getLabel()

ilDatabaseEnvironmentValidObjective::getLabel

(

)

Get a label that describes this objective.

Implements ILIAS\Setup\Objective.

Definition at line 41 of file class.ilDatabaseEnvironmentValidObjective.php.

                              : string
    {
        return "The database server has valid settings.";
    }

getPreconditions()

ilDatabaseEnvironmentValidObjective::getPreconditions

(

Environment

$environment

)

Returns

array<\ilDatabaseServerIsConnectableObjective|\ilDatabaseCreatedObjective>

Implements ILIAS\Setup\Objective.

Definition at line 54 of file class.ilDatabaseEnvironmentValidObjective.php.

                                                              : array
    {
        return [ ];
    }

isApplicable()

ilDatabaseEnvironmentValidObjective::isApplicable

(

Environment

$environment

)

@inheritDoc

Implements ILIAS\Setup\Objective.

Definition at line 127 of file class.ilDatabaseEnvironmentValidObjective.php.

                                                          : bool
    {
        return true;
    }

isNotable()

ilDatabaseEnvironmentValidObjective::isNotable

(

)

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

Implements ILIAS\Setup\Objective.

Definition at line 46 of file class.ilDatabaseEnvironmentValidObjective.php.

                               : bool
    {
        return true;
    }

Field Documentation

INNO_DB

const ilDatabaseEnvironmentValidObjective::INNO_DB = "InnoDB"

private

Definition at line 34 of file class.ilDatabaseEnvironmentValidObjective.php.

ROW_FORMAT_DYNAMIC

const ilDatabaseEnvironmentValidObjective::ROW_FORMAT_DYNAMIC = "DYNAMIC"

private

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

---

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

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