class.ilPluginDBUpdate.php

Go to the documentation of this file.

<?php
use ILIAS\Data\Version;

class ilPluginDBUpdate extends ilDBUpdate
{
    protected const PLUGIN_UPDATE_FILE = "/sql/dbupdate.php";

    protected \ilDBInterface $db;
    protected \ilPluginInfo $plugin;

    public function __construct(
        \ilDBInterface $db,
        \ilPluginInfo $plugin
    ) {
        $this->client_ini = null;
        $this->db = $db;
        $this->plugin = $plugin;

        $this->currentVersion = $plugin->getCurrentDBVersion() ?? 0;

        $this->current_file = $this->getFileForStep(0 /* doesn't matter */);
        $this->DB_UPDATE_FILE = $this->PATH . $this->getDBUpdateScriptName();
        $this->LAST_UPDATE_FILE = $this->DB_UPDATE_FILE;

        $this->readDBUpdateFile();
        $this->readLastUpdateFile();
        $this->readFileVersion();

        $class_map = require ILIAS_ABSOLUTE_PATH . '/libs/composer/vendor/composer/autoload_classmap.php';
        $this->ctrl_structure_iterator = new ilCtrlArrayIterator($class_map);
    }

    public function getFileForStep(int $a_version /* doesn't matter */): string
    {
        return "dbupdate.php";
    }

    public function getCurrentVersion(): int
    {
        return $this->currentVersion;
    }

    public function setCurrentVersion(int $a_version): void
    {
        $this->currentVersion = $a_version;
    }

    public function loadXMLInfo(): bool
    {
        return true;
    }

    public function checkQuery(string $q): bool
    {
        if ((is_int(stripos($q, "create table")) || is_int(stripos($q, "alter table")) ||
                is_int(stripos($q, "drop table")))
            && !is_int(stripos($q, $this->getTablePrefix()))) {
            return false;
        }

        return true;
    }

    public function getDBUpdateScriptName(): string
    {
        return $this->plugin->getPath() . self::PLUGIN_UPDATE_FILE;
    }

    protected function getTablePrefix(): string
    {
        $component = $this->plugin->getComponent();
        $slot = $this->plugin->getPluginSlot();
        return $component->getId() . "_" . $slot->getId() . "_" . $this->plugin->getId();
    }
}