ilDatabasePopulatedObjective Class Reference

Inheritance diagram for ilDatabasePopulatedObjective:

Collaboration diagram for ilDatabasePopulatedObjective:

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)
Public Member Functions inherited from ilDatabaseObjective
	__construct (protected \ilDatabaseSetupConfig $config)
Public Member Functions inherited from ILIAS\Setup\Objective
	achieve (Environment $environment)
	Objectives can be achieved. More...

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)

Detailed Description

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

Member Function Documentation

getDefaultEngine()

ilDatabasePopulatedObjective::getDefaultEngine ( ilDBInterface  $db )

private

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

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

Referenced by getPreconditions().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

getHash()

ilDatabasePopulatedObjective::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 31 of file class.ilDatabasePopulatedObjective.php.

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

getLabel()

ilDatabasePopulatedObjective::getLabel

(

)

Get a label that describes this objective.

Implements ILIAS\Setup\Objective.

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

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

getPreconditions()

ilDatabasePopulatedObjective::getPreconditions

(

Environment

$environment

)

Returns

[]

Implements ILIAS\Setup\Objective.

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

References ILIAS\Setup\Objective\achieve(), ILIAS\Setup\Environment\getConfigFor(), getDefaultEngine(), ILIAS\Setup\Environment\getResource(), ILIAS\Setup\Environment\hasConfigFor(), and readDumpFile().

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

Here is the call graph for this function:

isApplicable()

ilDatabasePopulatedObjective::isApplicable

(

Environment

$environment

)

Implements ILIAS\Setup\Objective.

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

References ILIAS\Setup\Environment\getResource(), ILIAS\Setup\Environment\hasConfigFor(), and isDatabasePopulated().

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

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

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

Here is the call graph for this function:

isDatabasePopulated()

ilDatabasePopulatedObjective::isDatabasePopulated ( ilDBInterface  $db )

protected

Definition at line 114 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

(

)

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

Implements ILIAS\Setup\Objective.

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

                               : bool
    {
        return true;
    }

queryReader()

ilDatabasePopulatedObjective::queryReader ( string  $path_to_db_dump )

private

Definition at line 151 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 129 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 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 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 180 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 29 of file class.ilDatabasePopulatedObjective.php.

---

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

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