ilDBUpdate Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilDBUpdate:

Collaboration diagram for ilDBUpdate:

Public Member Functions
	__construct (ilDBInterface $a_db_handler, ilIniFile $client_ini=null)
	getFileForStep (int $a_version)
	Get db update file name for db step. More...
	initStep (int $i)
	readDBUpdateFile ()
	readLastUpdateFile ()
	getCurrentVersion ()
	setCurrentVersion (int $a_version)
	setRunningStatus (int $a_nr)
	Set running status for a step. More...
	getRunningStatus ()
	Get running status. More...
	clearRunningStatus ()
	Clear running status. More...
	readFileVersion ()
	getFileVersion ()
	Get Version of file. More...
	execQuery (ilDBInterface $db, string $str)
	execute a query More...
	checkQuery (string $q)
	check query More...
	applyUpdate (int $a_break=0)
	Apply update. More...
	applyUpdateNr (int $nr, $hotfix=false, $custom_update=false)
	apply an update More...
	getDBVersionStatus ()
	getTables ()
	getTableStatus (string $table)
	getHotfixCurrentVersion ()
	Get current hotfix version. More...
	setHotfixCurrentVersion (int $a_version)
	Set current hotfix version. More...
	getHotfixFileVersion ()
	Get current hotfix version. More...
	readHotfixFileVersion (array $a_file_content)
	Set current hotfix version. More...
	readHotfixInfo (bool $a_force=false)
	Get status of hotfix file. More...
	hotfixAvailable ()
	Get status of hotfix file. More...
	applyHotfix ()
	Apply hotfix. More...
	getCustomUpdatesCurrentVersion ()
	setCustomUpdatesCurrentVersion (?int $a_version)
	getCustomUpdatesFileVersion ()
	readCustomUpdatesFileVersion (array $a_file_content)
	readCustomUpdatesInfo (bool $a_force=false)
	customUpdatesAvailable ()
	applyCustomUpdates ()
	getUpdateSteps (int $a_break=0)
	Get update steps as string (for presentation) More...
	getHotfixSteps ()
	Get hotfix steps. More...
	getUpdateStepNr (int $nr, bool $hotfix=false, bool $custom_update=false)
	Get single update step for presentation. More...

Data Fields
string	$DB_UPDATE_FILE
int	$currentVersion = null
int	$fileVersion = null
string	$updateMsg

Protected Attributes
ilIniFile	$client_ini = null
int	$custom_updates_current_version = 0
int	$custom_updates_file_version = null
bool	$custom_updates_info_read = null
string	$error
string	$PATH = './'
ilDBInterface	$db
string	$current_file
string	$LAST_UPDATE_FILE
array	$filecontent
array	$lastfilecontent
int	$db_update_running
int	$hotfix_current_version
ilSetting	$hotfix_setting
array	$hotfix_version
array	$hotfix_content
int	$hotfix_file_version
ilSetting	$custom_updates_setting
array	$custom_updates_content
Iterator	$ctrl_structure_iterator

Private Member Functions
	initGlobalsRequiredForUpdateSteps (?ilCtrlStructureReader &$ilCtrlStructureReader, ?ilDBInterface &$ilDB)

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Database Update class

Author

Peter Gabriel pgabr.nosp@m.iel@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilDBUpdate::__construct	(	ilDBInterface	$a_db_handler,
		ilIniFile	$client_ini = null
	)

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

References $client_ini, getCurrentVersion(), getFileForStep(), PATH, readDBUpdateFile(), readFileVersion(), and readLastUpdateFile().

    {
        // workaround to allow setup migration
        $this->client_ini = $client_ini;
        $this->db = $a_db_handler;
        $this->PATH = "./";

        $this->getCurrentVersion();

        // get update file for current version
        $updatefile = $this->getFileForStep($this->currentVersion + 1);

        $this->current_file = $updatefile;
        $this->DB_UPDATE_FILE = $this->PATH . "setup/sql/" . $updatefile;

        //
        // NOTE: IF YOU SET THIS TO THE NEWEST FILE, CHANGE ALSO getFileForStep()
        //
        $this->LAST_UPDATE_FILE = $this->PATH . "setup/sql/dbupdate_05.php";

        $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);
    }

Here is the call graph for this function:

Member Function Documentation

applyCustomUpdates()

ilDBUpdate::applyCustomUpdates

(

)

Definition at line 665 of file class.ilDBUpdate.php.

References $c, $custom_updates_content, Vendor\Package\$f, $i, $ilDB, applyUpdateNr(), getCustomUpdatesCurrentVersion(), getCustomUpdatesFileVersion(), initGlobalsRequiredForUpdateSteps(), and readCustomUpdatesInfo().

                                        : bool
    {
        $ilCtrlStructureReader = null;
        $ilDB = null;
        $this->initGlobalsRequiredForUpdateSteps($ilCtrlStructureReader, $ilDB);
        $this->readCustomUpdatesInfo(true);

        $f = $this->getCustomUpdatesFileVersion();
        $c = $this->getCustomUpdatesCurrentVersion();

        if ($c < $f) {
            $msg = array();
            for ($i = ($c + 1); $i <= $f; $i++) {
                $this->filecontent = $this->custom_updates_content;

                if ($this->applyUpdateNr($i, false, true) === false) {
                    $msg[] = array("msg" => "update_error: " . $this->error,
                                   "nr" => $i,
                    );
                    $this->updateMsg = implode("\n", $msg);

                    return false;
                }

                $msg[] = array("msg" => "custom_update_applied",
                               "nr" => $i,
                );
            }

            $this->updateMsg = implode("\n", $msg);
        } else {
            $this->updateMsg = "no_changes";
        }

        return true;
    }

Here is the call graph for this function:

applyHotfix()

ilDBUpdate::applyHotfix

(

)

Apply hotfix.

Definition at line 568 of file class.ilDBUpdate.php.

References $c, Vendor\Package\$f, $hotfix_content, $i, $ilDB, applyUpdateNr(), getHotfixCurrentVersion(), getHotfixFileVersion(), initGlobalsRequiredForUpdateSteps(), and readHotfixInfo().

                                 : bool
    {
        $ilCtrlStructureReader = null;
        $ilDB = null;
        $this->initGlobalsRequiredForUpdateSteps($ilCtrlStructureReader, $ilDB);
        $this->readHotfixInfo(true);

        $f = $this->getHotfixFileVersion();
        $c = $this->getHotfixCurrentVersion();

        if ($c < $f) {
            $msg = array();
            for ($i = ($c + 1); $i <= $f; $i++) {
                $this->filecontent = $this->hotfix_content;

                if ($this->applyUpdateNr($i, true) === false) {
                    $msg[] = array("msg" => "update_error: " . $this->error,
                                   "nr" => $i,
                    );
                    $this->updateMsg = implode("\n", $msg);

                    return false;
                }

                $msg[] = array("msg" => "hotfix_applied",
                               "nr" => $i,
                );
            }

            $this->updateMsg = implode("\n", $msg);
        } else {
            $this->updateMsg = "no_changes";
        }

        return true;
    }

Here is the call graph for this function:

applyUpdate()

ilDBUpdate::applyUpdate

(

int

$a_break = 0

)

Apply update.

Returns

bool|void

Definition at line 290 of file class.ilDBUpdate.php.

References $c, $currentVersion, Vendor\Package\$f, $fileVersion, $i, $ilDB, applyUpdateNr(), getFileForStep(), initGlobalsRequiredForUpdateSteps(), initStep(), PATH, and readDBUpdateFile().

    {
        $ilCtrlStructureReader = null;
        $ilDB = null;
        $this->initGlobalsRequiredForUpdateSteps($ilCtrlStructureReader, $ilDB);

        $f = $this->fileVersion;
        $c = $this->currentVersion;

        if ($a_break > $this->currentVersion
            && $a_break < $this->fileVersion
        ) {
            $f = $a_break;
        }

        if ($c < $f) {
            $msg = array();
            for ($i = ($c + 1); $i <= $f; $i++) {
                // check wether next update file must be loaded
                if ($this->current_file != $this->getFileForStep($i)) {
                    $this->DB_UPDATE_FILE = $this->PATH . "setup/sql/" . $this->getFileForStep($i);
                    $this->readDBUpdateFile();
                }

                $this->initStep($i);

                if ($this->applyUpdateNr($i) === false) {
                    $msg[] = "msg: update_error - " . $this->error . "; nr: " . $i . ";";
                    $this->updateMsg = implode("\n", $msg);

                    return false;
                }

                $msg[] = "msg: update_applied; nr: " . $i . ";";
            }

            $this->updateMsg = implode("\n", $msg);
        } else {
            $this->updateMsg = "no_changes";
        }

        if ($f < $this->fileVersion) {
            return true;
        }
    }

Here is the call graph for this function:

applyUpdateNr()

ilDBUpdate::applyUpdateNr	(	int	$nr,
			$hotfix = false,
			$custom_update = false
	)

apply an update

Parameters

int

$nr

number what patch to apply (Reference: Patch for https://mantis.ilias.de/view.php?id=28550) private

Definition at line 341 of file class.ilDBUpdate.php.

References $error, $i, $ilDB, $update, clearRunningStatus(), execQuery(), initGlobalsRequiredForUpdateSteps(), setCurrentVersion(), setCustomUpdatesCurrentVersion(), setHotfixCurrentVersion(), and setRunningStatus().

Referenced by applyCustomUpdates(), applyHotfix(), and applyUpdate().

                                                                                   : bool
    {
        $ilCtrlStructureReader = null;
        $ilMySQLAbstraction = null;
        $ilDB = null;
        $this->initGlobalsRequiredForUpdateSteps($ilCtrlStructureReader, $ilDB);

        //search for desired $nr
        reset($this->filecontent);

        if (!$hotfix && !$custom_update) {
            $this->setRunningStatus($nr);
        }

        //init
        $i = 0;

        //go through filecontent
        while (!preg_match("/^<\#" . $nr . ">/", $this->filecontent[$i]) && $i < count($this->filecontent)) {
            $i++;
        }

        //update not found
        if ($i === count($this->filecontent)) {
            $this->error = "update_not_found";

            return false;
        }

        $i++;

        //update found, now extract this update to a new array
        $update = array();
        while ($i < count($this->filecontent) && !preg_match("/^<#" . ($nr + 1) . ">/", $this->filecontent[$i])) {
            $update[] = trim($this->filecontent[$i]);
            $i++;
        }

        //now you have the update, now process it
        $sql = array();
        $php = array();
        $mode = "sql";

        foreach ($update as $row) {
            if (preg_match("/<\?php/", $row)) {
                if (count($sql) > 0) {
                    if ($this->execQuery($this->db, implode("\n", $sql)) === false) {
                        return false;
                    }
                    $sql = array();
                }
                $mode = "php";
            } elseif (preg_match("/\?>/", $row)) {
                if (count($php) > 0) {
                    $code = implode("\n", $php);
                    if (eval($code) === false) {
                        $this->error = "Parse error: " . $code;

                        return false;
                    }
                    $php = array();
                }
                $mode = "sql";
            } else {
                if ($mode === "sql") {
                    $sql[] = $row;
                }

                if ($mode === "php") {
                    $php[] = $row;
                }
            } //else
        } //foreach

        if ($mode === "sql" && count($sql) > 0) {
            if ($this->execQuery($this->db, implode("\n", $sql)) === false) {
                $this->error = "dump_error: " . $this->error;

                return false;
            }
        }

        //increase db_Version number
        if (!$hotfix && !$custom_update) {
            $this->setCurrentVersion($nr);
        } elseif ($hotfix) {
            $this->setHotfixCurrentVersion($nr);
        } elseif ($custom_update) {
            $this->setCustomUpdatesCurrentVersion($nr);
        }

        if (!$hotfix && !$custom_update) {
            $this->clearRunningStatus();
        }

        //$this->currentVersion = $ilias->getSetting("db_version");

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkQuery()

ilDBUpdate::checkQuery

(

string

$q

)

check query

Definition at line 253 of file class.ilDBUpdate.php.

Referenced by execQuery().

                                         : bool
    {
        return true;
    }

Here is the caller graph for this function:

clearRunningStatus()

ilDBUpdate::clearRunningStatus

(

)

Clear running status.

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

Referenced by applyUpdateNr().

                                        : void
    {
        $set = new ilSetting("common", true);
        $set->set("db_update_running", "0");
        $this->db_update_running = 0;
    }

Here is the caller graph for this function:

customUpdatesAvailable()

ilDBUpdate::customUpdatesAvailable

(

)

Definition at line 659 of file class.ilDBUpdate.php.

References $custom_updates_current_version, and readCustomUpdatesInfo().

                                            : bool
    {
        $this->readCustomUpdatesInfo();
        return $this->custom_updates_file_version > $this->custom_updates_current_version;
    }

Here is the call graph for this function:

execQuery()

ilDBUpdate::execQuery	(	ilDBInterface	$db,
		string	$str
	)

execute a query

Returns

bool

PhpUndefinedVariableInspection

PhpUndefinedVariableInspection

Definition at line 214 of file class.ilDBUpdate.php.

References $check, $i, checkQuery(), and ilDBInterface\query().

Referenced by applyUpdateNr().

                                                             : bool
    {
        $q = "";
        $sql = explode("\n", trim($str));
        foreach ($sql as $i => $statement) {
            $sql[$i] = trim($statement);
            if ($statement !== "" && $statement[0] !== "#") {
                //take line per line, until last char is ";"
                if (substr($statement, -1) === ";") {
                    //query is complete
                    $q .= " " . substr($statement, 0, -1);
                    $check = $this->checkQuery($q);
                    if ($check === true) {
                        $db->query($q);
                    } else {
                        $this->error = (string) $check;
                        return false;
                    }
                    unset($q);
                } //if
                else {
                    $q .= " " . $statement;
                } //else
            } //if
        } //for
        if (isset($q) && $q !== "") {
            echo "incomplete_statement: " . $q . "<br>";

            return false;
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCurrentVersion()

ilDBUpdate::getCurrentVersion

(

)

Definition at line 137 of file class.ilDBUpdate.php.

References $currentVersion, and ILIAS\Repository\int().

Referenced by __construct().

                                       : int
    {
        $set = new ilSetting("common", true);
        $this->currentVersion = (int) $set->get("db_version");

        return $this->currentVersion;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCustomUpdatesCurrentVersion()

ilDBUpdate::getCustomUpdatesCurrentVersion

(

)

Definition at line 605 of file class.ilDBUpdate.php.

References $custom_updates_current_version, and readCustomUpdatesInfo().

Referenced by applyCustomUpdates().

                                                    : ?int
    {
        $this->readCustomUpdatesInfo();

        return $this->custom_updates_current_version;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCustomUpdatesFileVersion()

ilDBUpdate::getCustomUpdatesFileVersion

(

)

Definition at line 621 of file class.ilDBUpdate.php.

References $custom_updates_file_version, and readCustomUpdatesInfo().

Referenced by applyCustomUpdates().

                                                 : ?int
    {
        $this->readCustomUpdatesInfo();

        return $this->custom_updates_file_version;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDBVersionStatus()

ilDBUpdate::getDBVersionStatus

(

)

Definition at line 441 of file class.ilDBUpdate.php.

References $currentVersion.

                                        : bool
    {
        return !($this->fileVersion > $this->currentVersion);
    }

getFileForStep()

ilDBUpdate::getFileForStep

(

int

$a_version

)

Get db update file name for db step.

Definition at line 85 of file class.ilDBUpdate.php.

Referenced by __construct(), applyUpdate(), and getUpdateSteps().

                                                  : string
    {
        //
        // NOTE: IF YOU ADD A NEW FILE HERE, CHANGE ALSO THE CONSTRUCTOR
        //
        switch (true) {
            case ($a_version > 5431): // last number in previous file
                return "dbupdate_05.php";
            case ($a_version > 4182): // last number in previous file
                return "dbupdate_04.php";
            case ($a_version > 2948): // last number in previous file
                return "dbupdate_03.php";
            case ($a_version > 864): // last number in previous file
                return "dbupdate_02.php";
            default:
                return "dbupdate.php";
        }
    }

Here is the caller graph for this function:

getFileVersion()

ilDBUpdate::getFileVersion

(

)

Get Version of file.

Definition at line 205 of file class.ilDBUpdate.php.

References $fileVersion.

                                    : ?int
    {
        return $this->fileVersion;
    }

getHotfixCurrentVersion()

ilDBUpdate::getHotfixCurrentVersion

(

)

Get current hotfix version.

Definition at line 482 of file class.ilDBUpdate.php.

References readHotfixInfo().

Referenced by applyHotfix(), and getHotfixSteps().

                                             : ?int
    {
        $this->readHotfixInfo();

        return $this->hotfix_current_version ?? null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getHotfixFileVersion()

ilDBUpdate::getHotfixFileVersion

(

)

Get current hotfix version.

Definition at line 507 of file class.ilDBUpdate.php.

References readHotfixInfo().

Referenced by applyHotfix(), and getHotfixSteps().

                                          : ?int
    {
        $this->readHotfixInfo();

        return $this->hotfix_file_version ?? null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getHotfixSteps()

ilDBUpdate::getHotfixSteps

(

)

Get hotfix steps.

Returns

string steps from the update file

Definition at line 743 of file class.ilDBUpdate.php.

References $c, Vendor\Package\$f, $hotfix_content, $i, getHotfixCurrentVersion(), getHotfixFileVersion(), getUpdateStepNr(), and readHotfixInfo().

                                    : string
    {
        $this->readHotfixInfo(true);

        $str = "";

        $f = $this->getHotfixFileVersion();
        $c = $this->getHotfixCurrentVersion();

        if ($c < $f) {
            for ($i = ($c + 1); $i <= $f; $i++) {
                $this->filecontent = $this->hotfix_content;

                $str .= $this->getUpdateStepNr($i, true);
            }
        }

        return $str;
    }

Here is the call graph for this function:

getRunningStatus()

ilDBUpdate::getRunningStatus

(

)

Get running status.

Returns

int current runnning db step

Definition at line 167 of file class.ilDBUpdate.php.

References $db_update_running, and ILIAS\Repository\int().

                                      : int
    {
        $set = new ilSetting("common", true);
        $this->db_update_running = (int) $set->get("db_update_running");

        return $this->db_update_running;
    }

Here is the call graph for this function:

getTables()

ilDBUpdate::getTables

(

)

Returns

array<int, array<string, mixed>>

Definition at line 449 of file class.ilDBUpdate.php.

References Vendor\Package\$a, $query, $res, and getTableStatus().

                               : array
    {
        $a = array();

        $query = "SHOW TABLES";
        $res = $this->db->query($query);
        while ($row = $res->fetchRow()) {
            $status = $this->getTableStatus($row[0]);
            $a[] = array("name" => $status["Table"],
                         "table" => $row[0],
                         "status" => $status["Msg_text"],
            );
        }

        return $a;
    }

Here is the call graph for this function:

getTableStatus()

ilDBUpdate::getTableStatus

(

string

$table

)

Returns

mixed

Definition at line 469 of file class.ilDBUpdate.php.

References $query, and ilDBConstants\FETCHMODE_ASSOC.

Referenced by getTables().

    {
        $query = "ANALYZE TABLE " . $table;
        return $this->db->query($query)->fetchRow(ilDBConstants::FETCHMODE_ASSOC);
    }

Here is the caller graph for this function:

getUpdateStepNr()

ilDBUpdate::getUpdateStepNr	(	int	$nr,
		bool	$hotfix = false,
		bool	$custom_update = false
	)

Get single update step for presentation.

Definition at line 766 of file class.ilDBUpdate.php.

References $i.

Referenced by getHotfixSteps(), and getUpdateSteps().

                                                                                               : string
    {
        $str = "";

        //search for desired $nr
        reset($this->filecontent);

        //init
        $i = 0;

        //go through filecontent
        while (!preg_match("/^<#" . $nr . ">/", $this->filecontent[$i]) && $i < count($this->filecontent)) {
            $i++;
        }

        //update not found
        if ($i === count($this->filecontent)) {
            return '';
        }

        $i++;
        while ($i < count($this->filecontent) && !preg_match("/^<#" . ($nr + 1) . ">/", $this->filecontent[$i])) {
            $str .= $this->filecontent[$i];
            $i++;
        }

        return "<pre><b><#" . $nr . "></b>\n" . htmlentities($str) . "</pre>";
    }

Here is the caller graph for this function:

getUpdateSteps()

ilDBUpdate::getUpdateSteps

(

int

$a_break = 0

)

Get update steps as string (for presentation)

Returns

string steps from the update file

Definition at line 706 of file class.ilDBUpdate.php.

References $c, $currentVersion, Vendor\Package\$f, $fileVersion, $i, $ilDB, getFileForStep(), getUpdateStepNr(), initGlobalsRequiredForUpdateSteps(), PATH, and readDBUpdateFile().

                                                    : string
    {
        $ilCtrlStructureReader = null;
        $ilMySQLAbstraction = null;
        $ilDB = null;
        $this->initGlobalsRequiredForUpdateSteps($ilCtrlStructureReader, $ilDB);

        $str = "";

        $f = $this->fileVersion;
        $c = $this->currentVersion;

        if ($a_break > $this->currentVersion
            && $a_break < $this->fileVersion
        ) {
            $f = $a_break;
        }

        if ($c < $f) {
            for ($i = ($c + 1); $i <= $f; $i++) {
                // check wether next update file must be loaded
                if ($this->current_file != $this->getFileForStep($i)) {
                    $this->DB_UPDATE_FILE = $this->PATH . "setup/sql/" . $this->getFileForStep($i);
                    $this->readDBUpdateFile();
                }

                $str .= $this->getUpdateStepNr($i);
            }
        }

        return $str;
    }

Here is the call graph for this function:

hotfixAvailable()

ilDBUpdate::hotfixAvailable

(

)

Get status of hotfix file.

Definition at line 559 of file class.ilDBUpdate.php.

References $hotfix_current_version, and readHotfixInfo().

                                     : bool
    {
        $this->readHotfixInfo();
        return isset($this->hotfix_file_version) && $this->hotfix_file_version > $this->hotfix_current_version;
    }

Here is the call graph for this function:

initGlobalsRequiredForUpdateSteps()

ilDBUpdate::initGlobalsRequiredForUpdateSteps ( ?ilCtrlStructureReader &  $ilCtrlStructureReader, ?ilDBInterface &  $ilDB  )

private

Definition at line 258 of file class.ilDBUpdate.php.

References $DIC, and $GLOBALS.

Referenced by applyCustomUpdates(), applyHotfix(), applyUpdate(), applyUpdateNr(), and getUpdateSteps().

     : void {
        global $DIC;

        // TODO: There is currently a huge mixup of globals, $DIC and dependencies, esprecially in setup and during DB-Updates. This leads to many problems. The following core tries to provide the needed dependencies for the dbupdate-script. The code hopefully will change in the future.

        if (isset($GLOBALS['ilCtrlStructureReader'])) {
            $ilCtrlStructureReader = $GLOBALS['ilCtrlStructureReader'];
        } elseif ($DIC->offsetExists('ilCtrlStructureReader')) {
            $ilCtrlStructureReader = $DIC['ilCtrlStructureReader'];
        } else {
            $ilCtrlStructureReader = new ilCtrlStructureReader(
                $this->ctrl_structure_iterator,
                new ilCtrlStructureCidGenerator()
            );
            $DIC->offsetSet('ilCtrlStructureReader', $ilCtrlStructureReader);
        }

        $GLOBALS['ilCtrlStructureReader'] = $ilCtrlStructureReader;

        if ($this->client_ini) {
            $ilCtrlStructureReader->setIniFile($this->client_ini);
        }
        $ilDB = $DIC->database();
    }

Here is the caller graph for this function:

initStep()

ilDBUpdate::initStep

(

int

$i

)

Definition at line 104 of file class.ilDBUpdate.php.

Referenced by applyUpdate().

                                    : void
    {
        //
    }

Here is the caller graph for this function:

readCustomUpdatesFileVersion()

ilDBUpdate::readCustomUpdatesFileVersion

(

array

$a_file_content

)

Definition at line 628 of file class.ilDBUpdate.php.

References $version.

Referenced by readCustomUpdatesInfo().

                                                                       : int
    {
        //go through filecontent and search for last occurence of <#x>
        reset($a_file_content);
        $regs = [];
        $version = '';
        foreach ($a_file_content as $row) {
            if (preg_match("/^<#([0-9]+)>/", $row, $regs)) {
                $version = $regs[1];
            }
        }

        return (int) $version;
    }

Here is the caller graph for this function:

readCustomUpdatesInfo()

ilDBUpdate::readCustomUpdatesInfo

(

bool

$a_force = false

)

Definition at line 643 of file class.ilDBUpdate.php.

References ILIAS\Repository\int(), PATH, and readCustomUpdatesFileVersion().

Referenced by applyCustomUpdates(), customUpdatesAvailable(), getCustomUpdatesCurrentVersion(), getCustomUpdatesFileVersion(), and setCustomUpdatesCurrentVersion().

                                                                : void
    {
        if ($this->custom_updates_info_read && !$a_force) {
            return;
        }

        $this->custom_updates_setting = new ilSetting();
        $custom_updates_file = $this->PATH . "setup/sql/dbupdate_custom.php";
        if (is_file($custom_updates_file)) {
            $this->custom_updates_content = @file($custom_updates_file);
            $this->custom_updates_current_version = (int) $this->custom_updates_setting->get('db_version_custom', "0");
            $this->custom_updates_file_version = $this->readCustomUpdatesFileVersion($this->custom_updates_content);
        }
        $this->custom_updates_info_read = true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readDBUpdateFile()

ilDBUpdate::readDBUpdateFile

(

)

Definition at line 109 of file class.ilDBUpdate.php.

Referenced by ilPluginDBUpdate\__construct(), __construct(), applyUpdate(), and getUpdateSteps().

                                      : bool
    {
        if (!file_exists($this->DB_UPDATE_FILE)) {
            $this->error = "no_db_update_file";
            $this->filecontent = array();

            return false;
        }

        $this->filecontent = @file($this->DB_UPDATE_FILE);

        return true;
    }

Here is the caller graph for this function:

readFileVersion()

ilDBUpdate::readFileVersion

(

)

Definition at line 185 of file class.ilDBUpdate.php.

References $fileVersion, $version, and ILIAS\Repository\int().

Referenced by ilPluginDBUpdate\__construct(), and __construct().

                                     : int
    {
        //go through filecontent and search for last occurence of <#x>
        reset($this->lastfilecontent);
        $regs = array();
        $version = 0;
        foreach ($this->lastfilecontent as $row) {
            if (preg_match('/^<\#([0-9]+)>/', $row, $regs)) {
                $version = $regs[1];
            }
        }

        $this->fileVersion = (int) $version;

        return $this->fileVersion;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readHotfixFileVersion()

ilDBUpdate::readHotfixFileVersion

(

array

$a_file_content

)

Set current hotfix version.

Definition at line 517 of file class.ilDBUpdate.php.

References $version.

Referenced by readHotfixInfo().

                                                                : int
    {
        //go through filecontent and search for last occurence of <#x>
        reset($a_file_content);
        $regs = [];
        $version = '';
        foreach ($a_file_content as $row) {
            if (preg_match("/^<#([0-9]+)>/", $row, $regs)) {
                $version = $regs[1];
            }
        }

        return (int) $version;
    }

Here is the caller graph for this function:

readHotfixInfo()

ilDBUpdate::readHotfixInfo

(

bool

$a_force = false

)

Get status of hotfix file.

Definition at line 535 of file class.ilDBUpdate.php.

References ILIAS_VERSION_NUMERIC, ILIAS\Repository\int(), PATH, and readHotfixFileVersion().

Referenced by applyHotfix(), getHotfixCurrentVersion(), getHotfixFileVersion(), getHotfixSteps(), hotfixAvailable(), and setHotfixCurrentVersion().

                                                         : void
    {
        if (isset($this->hotfix_info_read) && $this->hotfix_info_read && !$a_force) {
            return;
        }
        $this->hotfix_setting = new ilSetting("common", true);
        $ilias_version = ILIAS_VERSION_NUMERIC;
        $version_array = explode(".", $ilias_version);
        $this->hotfix_version[0] = $version_array[0];
        $this->hotfix_version[1] = $version_array[1];
        $hotfix_file = $this->PATH . "setup/sql/" . $this->hotfix_version[0] . "_hotfixes.php";
        if (is_file($hotfix_file)) {
            $this->hotfix_content = @file($hotfix_file);
            $this->hotfix_current_version = (int) $this->hotfix_setting->get(
                "db_hotfixes_" . $this->hotfix_version[0]
            );
            $this->hotfix_file_version = $this->readHotfixFileVersion($this->hotfix_content);
        }
        $this->hotfix_info_read = true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readLastUpdateFile()

ilDBUpdate::readLastUpdateFile

(

)

Definition at line 123 of file class.ilDBUpdate.php.

Referenced by ilPluginDBUpdate\__construct(), and __construct().

                                        : bool
    {
        if (!file_exists($this->LAST_UPDATE_FILE)) {
            $this->error = "no_last_update_file";
            $this->lastfilecontent = array();

            return false;
        }

        $this->lastfilecontent = @file($this->LAST_UPDATE_FILE);

        return true;
    }

Here is the caller graph for this function:

setCurrentVersion()

ilDBUpdate::setCurrentVersion

(

int

$a_version

)

Definition at line 145 of file class.ilDBUpdate.php.

Referenced by applyUpdateNr().

                                                     : void
    {
        $set = new ilSetting("common", true);
        $set->set("db_version", (string) $a_version);
        $this->currentVersion = $a_version;
    }

Here is the caller graph for this function:

setCustomUpdatesCurrentVersion()

ilDBUpdate::setCustomUpdatesCurrentVersion

(

?int

$a_version

)

Definition at line 612 of file class.ilDBUpdate.php.

References readCustomUpdatesInfo().

Referenced by applyUpdateNr().

                                                                   : bool
    {
        $this->readCustomUpdatesInfo();
        $this->custom_updates_setting->set('db_version_custom', (string) $a_version);
        $this->custom_updates_current_version = $a_version;

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setHotfixCurrentVersion()

ilDBUpdate::setHotfixCurrentVersion

(

int

$a_version

)

Set current hotfix version.

Definition at line 492 of file class.ilDBUpdate.php.

References readHotfixInfo().

Referenced by applyUpdateNr().

                                                           : bool
    {
        $this->readHotfixInfo();
        $this->hotfix_setting->set(
            "db_hotfixes_" . $this->hotfix_version[0],
            (string) $a_version
        );
        $this->hotfix_current_version = $a_version;

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setRunningStatus()

ilDBUpdate::setRunningStatus

(

int

$a_nr

)

Set running status for a step.

Parameters

int	step number

Definition at line 156 of file class.ilDBUpdate.php.

Referenced by applyUpdateNr().

                                               : void
    {
        $set = new ilSetting("common", true);
        $set->set("db_update_running", (string) $a_nr);
        $this->db_update_running = $a_nr;
    }

Here is the caller graph for this function:

Field Documentation

$client_ini

ilIniFile ilDBUpdate::$client_ini = null

protected

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

Referenced by __construct().

$ctrl_structure_iterator

Iterator ilDBUpdate::$ctrl_structure_iterator

protected

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

$current_file

string ilDBUpdate::$current_file

protected

Definition at line 40 of file class.ilDBUpdate.php.

$currentVersion

int ilDBUpdate::$currentVersion = null

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

Referenced by applyUpdate(), ilPluginDBUpdate\getCurrentVersion(), getCurrentVersion(), getDBVersionStatus(), and getUpdateSteps().

$custom_updates_content

array ilDBUpdate::$custom_updates_content

protected

Definition at line 51 of file class.ilDBUpdate.php.

Referenced by applyCustomUpdates().

$custom_updates_current_version

int ilDBUpdate::$custom_updates_current_version = 0

protected

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

Referenced by customUpdatesAvailable(), and getCustomUpdatesCurrentVersion().

$custom_updates_file_version

int ilDBUpdate::$custom_updates_file_version = null

protected

Definition at line 35 of file class.ilDBUpdate.php.

Referenced by getCustomUpdatesFileVersion().

$custom_updates_info_read

bool ilDBUpdate::$custom_updates_info_read = null

protected

Definition at line 36 of file class.ilDBUpdate.php.

$custom_updates_setting

ilSetting ilDBUpdate::$custom_updates_setting

protected

Definition at line 50 of file class.ilDBUpdate.php.

$db

ilDBInterface ilDBUpdate::$db

protected

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

$DB_UPDATE_FILE

string ilDBUpdate::$DB_UPDATE_FILE

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

Referenced by ilPluginDBUpdate\__construct().

$db_update_running

int ilDBUpdate::$db_update_running

protected

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

Referenced by getRunningStatus().

$error

string ilDBUpdate::$error

protected

Definition at line 37 of file class.ilDBUpdate.php.

Referenced by applyUpdateNr().

$filecontent

array ilDBUpdate::$filecontent

protected

Definition at line 42 of file class.ilDBUpdate.php.

$fileVersion

int ilDBUpdate::$fileVersion = null

Definition at line 31 of file class.ilDBUpdate.php.

Referenced by applyUpdate(), getFileVersion(), getUpdateSteps(), and readFileVersion().

$hotfix_content

array ilDBUpdate::$hotfix_content

protected

Definition at line 48 of file class.ilDBUpdate.php.

Referenced by applyHotfix(), and getHotfixSteps().

$hotfix_current_version

int ilDBUpdate::$hotfix_current_version

protected

Definition at line 45 of file class.ilDBUpdate.php.

Referenced by hotfixAvailable().

$hotfix_file_version

int ilDBUpdate::$hotfix_file_version

protected

Definition at line 49 of file class.ilDBUpdate.php.

$hotfix_setting

ilSetting ilDBUpdate::$hotfix_setting

protected

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

$hotfix_version

array ilDBUpdate::$hotfix_version

protected

Definition at line 47 of file class.ilDBUpdate.php.

$LAST_UPDATE_FILE

string ilDBUpdate::$LAST_UPDATE_FILE

protected

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

$lastfilecontent

array ilDBUpdate::$lastfilecontent

protected

Definition at line 43 of file class.ilDBUpdate.php.

$PATH

string ilDBUpdate::$PATH = './'

protected

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

$updateMsg

string ilDBUpdate::$updateMsg

Definition at line 32 of file class.ilDBUpdate.php.

---

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

• Services/Database/classes/class.ilDBUpdate.php