ilPluginDBUpdate Class Reference

Database Update class. More...

Inheritance diagram for ilPluginDBUpdate:

Collaboration diagram for ilPluginDBUpdate:

Public Member Functions
	__construct (\ilDBInterface $db, \ilPluginInfo $plugin)
	constructor MagicMethodsValidityInspection More...
	getCurrentVersion ()
	applyUpdate ()
	Apply update. More...
Public Member Functions inherited from ilDBUpdate
	__construct (ilDBInterface $a_db_handler, ilIniFile $client_ini=null)
	getCustomUpdatesCurrentVersion ()
	getCustomUpdatesFileVersion ()
	applyCustomUpdates ()

Protected Member Functions
	setCurrentVersion (?int $a_version)
	checkQuery (string $q)
Protected Member Functions inherited from ilDBUpdate
	checkQuery (string $q)
	initGlobalsRequiredForUpdateSteps (?ilCtrlStructureReader &$ilCtrlStructureReader, ?ilDBInterface &$ilDB)
	applyUpdateNr (int $nr, bool $custom_update=false)
	Apply a custom database update or a plugin update. More...
	setCurrentVersion (?int $a_version)

Protected Attributes
const	PLUGIN_UPDATE_FILE = "/sql/dbupdate.php"
string	$error = ''
Protected Attributes inherited from ilDBUpdate
string	$updateMsg
ilDBInterface	$db
ilIniFile	$client_ini = null
Iterator	$ctrl_structure_iterator
string	$error
string	$PATH = './'
array	$filecontent

Private Member Functions
	readDBUpdateFile ()
	readFileVersion ()
	getTablePrefix ()
	getDBUpdateScriptName ()

Private Attributes
ilPluginInfo	$plugin
string	$db_update_file
int	$current_version
int	$file_version = null

Detailed Description

Database Update class.

Author

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

Richard Klees richa.nosp@m.rd.k.nosp@m.lees@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

Version

Id

class.ilDBUpdate.php 15875 2008-02-03 13:56:32Z akill

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

Constructor & Destructor Documentation

__construct()

ilPluginDBUpdate::__construct	(	\ilDBInterface	$db,
		\ilPluginInfo	$plugin
	)

constructor MagicMethodsValidityInspection

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

References ilDBUpdate\$db, $plugin, ilPluginInfo\getCurrentDBVersion(), getDBUpdateScriptName(), readDBUpdateFile(), and readFileVersion().

      {
        $this->client_ini = null;
        $this->db = $db;
        $this->plugin = $plugin;

        $this->db_update_file = $this->getDBUpdateScriptName();

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

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

        $class_map = require ILIAS_ABSOLUTE_PATH . '/vendor/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

applyUpdate()

ilPluginDBUpdate::applyUpdate

(

)

Apply update.

Returns

false|void

Definition at line 128 of file class.ilPluginDBUpdate.php.

References $current_version, $file_version, $ilDB, ilDBUpdate\applyUpdateNr(), and ilDBUpdate\initGlobalsRequiredForUpdateSteps().

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

        $file_version = $this->file_version;
        $current_version = $this->current_version;

        $this->updateMsg = 'no_changes';
        if ($current_version < $file_version) {
            $msg = [];
            for ($i = ($current_version + 1); $i <= $file_version; $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);
        }
    }

Here is the call graph for this function:

checkQuery()

ilPluginDBUpdate::checkQuery ( string  $q )

protected

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

References getTablePrefix().

                                            : 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;
    }

Here is the call graph for this function:

getCurrentVersion()

ilPluginDBUpdate::getCurrentVersion

(

)

Definition at line 91 of file class.ilPluginDBUpdate.php.

References $current_version.

                                       : int
    {
        return $this->current_version;
    }

getDBUpdateScriptName()

ilPluginDBUpdate::getDBUpdateScriptName ( )

private

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

Referenced by __construct().

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

Here is the caller graph for this function:

getTablePrefix()

ilPluginDBUpdate::getTablePrefix ( )

private

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

Referenced by checkQuery().

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

Here is the caller graph for this function:

readDBUpdateFile()

ilPluginDBUpdate::readDBUpdateFile ( )

private

Definition at line 65 of file class.ilPluginDBUpdate.php.

Referenced by __construct().

                                       : void
    {
        if (!file_exists($this->db_update_file)) {
            $this->error = 'no_db_update_file';
            $this->filecontent = [];
            return;
        }

        $this->filecontent = @file($this->db_update_file);
    }

Here is the caller graph for this function:

readFileVersion()

ilPluginDBUpdate::readFileVersion ( )

private

Definition at line 76 of file class.ilPluginDBUpdate.php.

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

Referenced by __construct().

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

        $this->file_version = (int) $version;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setCurrentVersion()

ilPluginDBUpdate::setCurrentVersion ( ?int  $a_version )

protected

Definition at line 96 of file class.ilPluginDBUpdate.php.

                                                         : void
    {
        $this->current_version = $a_version;
    }

Field Documentation

$current_version

int ilPluginDBUpdate::$current_version

private

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

Referenced by applyUpdate(), and getCurrentVersion().

$db_update_file

string ilPluginDBUpdate::$db_update_file

private

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

$error

string ilPluginDBUpdate::$error = ''

protected

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

$file_version

int ilPluginDBUpdate::$file_version = null

private

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

Referenced by applyUpdate().

$plugin

ilPluginInfo ilPluginDBUpdate::$plugin

private

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

Referenced by __construct().

PLUGIN_UPDATE_FILE

const ilPluginDBUpdate::PLUGIN_UPDATE_FILE = "/sql/dbupdate.php"

protected

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

---

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

• components/ILIAS/Component/classes/class.ilPluginDBUpdate.php