ilDatabaseEnvironmentValidObjective Class Reference

Inheritance diagram for ilDatabaseEnvironmentValidObjective:

Collaboration diagram for ilDatabaseEnvironmentValidObjective:

Public Member Functions
	getHash ()
	getLabel ()
	isNotable ()
	getPreconditions (Setup\Environment $environment)
	isApplicable (Setup\Environment $environment)
	@inheritDoc 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 23 of file class.ilDatabaseEnvironmentValidObjective.php.

Member Function Documentation

checkDBAvailable()

ilDatabaseEnvironmentValidObjective::checkDBAvailable ( ?ilDBInterface  $db )

protected

Parameters

ilDBInterface

$db

Returns

void

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

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

checkDefaultEngine()

ilDatabaseEnvironmentValidObjective::checkDefaultEngine ( ilDBInterface  $db )

protected

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

    {
        $default_engine = 'unknown';
        try {
            $r = $db->query('SHOW ENGINES ');
            while ($d = $db->fetchObject($r)) {
                if (strtoupper($d->Support) === 'DEFAULT') {
                    $default_engine = strtolower($d->Engine);
                    break;
                }
            }
        } catch (Throwable $e) {
        }
        $default_engine = strtolower($default_engine);
 
        if ($default_engine !== strtolower(self::INNO_DB)) {
            throw new Setup\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 $d, Vendor\Package\$e, ilDBInterface\fetchObject(), and ilDBInterface\query().

Here is the call graph for this function:

checkRowFormat()

ilDatabaseEnvironmentValidObjective::checkRowFormat ( ilDBInterface  $db )

protected

Definition at line 92 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($row_format) !== self::ROW_FORMAT_DYNAMIC) {
            throw new Setup\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

(

)

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

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

getLabel()

ilDatabaseEnvironmentValidObjective::getLabel

(

)

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

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

getPreconditions()

ilDatabaseEnvironmentValidObjective::getPreconditions

(

Setup\Environment

$environment

)

Returns

array<\ilDatabaseServerIsConnectableObjective|\ilDatabaseCreatedObjective>

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

                                                                    : array
    {
        return [ ];
    }

isApplicable()

ilDatabaseEnvironmentValidObjective::isApplicable

(

Setup\Environment

$environment

)

@inheritDoc

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

                                                                : bool
    {
        return true;
    }

isNotable()

ilDatabaseEnvironmentValidObjective::isNotable

(

)

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

                               : bool
    {
        return true;
    }

Field Documentation

INNO_DB

const ilDatabaseEnvironmentValidObjective::INNO_DB = "InnoDB"

private

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

ROW_FORMAT_DYNAMIC

const ilDatabaseEnvironmentValidObjective::ROW_FORMAT_DYNAMIC = "DYNAMIC"

private

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

---

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

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