ilDatabasePopulatedObjective Class Reference

Inheritance diagram for ilDatabasePopulatedObjective:

Collaboration diagram for ilDatabasePopulatedObjective:

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

Data Fields
const	MIN_NUMBER_OF_ILIAS_TABLES = 200

Protected Member Functions
	isDatabasePopulated (ilDBInterface $db)

Private Member Functions
	readDumpFile (ilDBInterface $db)
	queryReader (string $path_to_db_dump)
	setDefaultEngine (ilDBInterface $db)
	getDefaultEngine (ilDBInterface $db)

Additional Inherited Members
Protected Attributes inherited from ilDatabaseObjective
ilDatabaseSetupConfig	$config

Detailed Description

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

Member Function Documentation

getDefaultEngine()

ilDatabasePopulatedObjective::getDefaultEngine ( ilDBInterface  $db )

private

Definition at line 190 of file class.ilDatabasePopulatedObjective.php.

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

Referenced by getPreconditions().

                                                        : string
    {
        try {
            $r = $db->query('SHOW ENGINES ');

            $default = '';
            while ($d = $db->fetchObject($r)) {
                if (strtoupper($d->Support) === 'DEFAULT') {
                    $default = $d->Engine;
                    break;
                }
            }
            return strtolower($default);
        } catch (Throwable $e) {
            return 'unknown';
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getHash()

ilDatabasePopulatedObjective::getHash

(

)

Definition at line 29 of file class.ilDatabasePopulatedObjective.php.

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

getLabel()

ilDatabasePopulatedObjective::getLabel

(

)

Definition at line 39 of file class.ilDatabasePopulatedObjective.php.

                              : string
    {
        return "The database is populated with ILIAS-tables.";
    }

getPreconditions()

ilDatabasePopulatedObjective::getPreconditions

(

Setup\Environment

$environment

)

Returns

[]

Definition at line 52 of file class.ilDatabasePopulatedObjective.php.

References getDefaultEngine(), and readDumpFile().

                                                                    : array
    {
        if ($environment->hasConfigFor(Setup\CLI\InstallCommand::IMPORT)) {
            return [new ObjectiveWithPreconditions(
                new \ilDatabaseExistsObjective($this->config),
                new ImportFileUnzippedFileObjective($environment->getConfigFor(Setup\CLI\InstallCommand::IMPORT))
            )];
        }
        if ($environment->getResource(Setup\Environment::RESOURCE_DATABASE)) {
            return [];
        }
        return [
            new \ilDatabaseExistsObjective($this->config)
        ];
    }

Here is the call graph for this function:

isApplicable()

ilDatabasePopulatedObjective::isApplicable

(

Setup\Environment

$environment

)

Definition at line 101 of file class.ilDatabasePopulatedObjective.php.

References isDatabasePopulated().

                                                                : bool
    {
        if ($environment->hasConfigFor(Setup\CLI\InstallCommand::IMPORT)) {
            return true;
        }

        $db = $environment->getResource(Setup\Environment::RESOURCE_DATABASE);

        return !$this->isDatabasePopulated($db);
    }

Here is the call graph for this function:

isDatabasePopulated()

ilDatabasePopulatedObjective::isDatabasePopulated ( ilDBInterface  $db )

protected

Definition at line 112 of file class.ilDatabasePopulatedObjective.php.

References ilDBInterface\listTables().

Referenced by isApplicable().

                                                             : bool
    {
        $probe_tables = ['usr_data', 'object_data', 'object_reference'];
        $number_of_probe_tables = count($probe_tables);
        $tables = $db->listTables();
        $number_of_tables = count($tables);

        return
            $number_of_tables > self::MIN_NUMBER_OF_ILIAS_TABLES
            && count(array_intersect($tables, $probe_tables)) === $number_of_probe_tables;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isNotable()

ilDatabasePopulatedObjective::isNotable

(

)

Definition at line 44 of file class.ilDatabasePopulatedObjective.php.

                               : bool
    {
        return true;
    }

queryReader()

ilDatabasePopulatedObjective::queryReader ( string  $path_to_db_dump )

private

Definition at line 149 of file class.ilDatabasePopulatedObjective.php.

Referenced by readDumpFile().

                                                         : Generator
    {
        $stack = '';
        $handle = fopen($path_to_db_dump, "r");
        while (($line = fgets($handle)) !== false) {
            if (preg_match('/^--/', $line)) { // Skip comments
                continue;
            }
            if (preg_match('/^\/\*/', $line)) { // Run Variables Assignments as single query
                yield $line;
                $stack = '';
                continue;
            }
            if (!preg_match('/;$/', trim($line))) { // Break after ; character which indicates end of query
                $stack .= $line;
            } else {
                $stack .= $line;
                yield $stack;
                $stack = '';
            }
        }

        fclose($handle);
    }

Here is the caller graph for this function:

readDumpFile()

ilDatabasePopulatedObjective::readDumpFile ( ilDBInterface  $db )

private

Exceptions

ilDatabaseException

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

References Vendor\Package\$e, ilDBInterface\execute(), ilDBInterface\prepareManip(), and queryReader().

Referenced by getPreconditions().

                                                    : void
    {
        $path_to_db_dump = $this->config->getPathToDBDump();
        if (!is_file(realpath($path_to_db_dump) ?: '') ||
            !is_readable(realpath($path_to_db_dump) ?: '')) {
            throw new Setup\UnachievableException(
                "Cannot read database dump file: $path_to_db_dump"
            );
        }
        foreach ($this->queryReader(realpath($path_to_db_dump)) as $query) {
            try {
                $statement = $db->prepareManip($query);
                $db->execute($statement);
            } catch (Throwable $e) {
                throw new Setup\UnachievableException(
                    "Cannot populate database with dump file: $path_to_db_dump. Query failed: $query wih message " . $e->getMessage(
                    )
                );
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setDefaultEngine()

ilDatabasePopulatedObjective::setDefaultEngine ( ilDBInterface  $db )

private

Parameters

ilDBInterface | null

$db

Definition at line 178 of file class.ilDatabasePopulatedObjective.php.

References ilDBInterface\getDBType(), ilDBInterface\manipulate(), ilDBConstants\TYPE_GALERA, ilDBConstants\TYPE_INNODB, and ilDBConstants\TYPE_MYSQL.

                                                        : void
    {
        switch ($db->getDBType()) {
            case 'pdo-mysql-innodb':
            case ilDBConstants::TYPE_INNODB:
            case ilDBConstants::TYPE_GALERA:
            case ilDBConstants::TYPE_MYSQL:
                $db->manipulate('SET default_storage_engine=InnoDB;');
                break;
        }
    }

Here is the call graph for this function:

Field Documentation

MIN_NUMBER_OF_ILIAS_TABLES

const ilDatabasePopulatedObjective::MIN_NUMBER_OF_ILIAS_TABLES = 200

Definition at line 27 of file class.ilDatabasePopulatedObjective.php.

---

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

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