Database Update class. More...

Inheritance diagram for ilPluginDBUpdate:

Collaboration diagram for ilPluginDBUpdate:

Public Member Functions
	__construct (\ilDBInterface $db, \ilPluginInfo $plugin)
	constructor MagicMethodsValidityInspection More...

	getFileForStep (int $a_version)
	FROM ilDBUpdate. More...

	getCurrentVersion ()
	Get current DB version. More...

	setCurrentVersion (int $a_version)
	Set current DB version. More...

	loadXMLInfo ()

	checkQuery (string $q)
	This is a very simple check. More...

	getDBUpdateScriptName ()

Public Member Functions inherited from ilDBUpdate
	__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...

Protected Member Functions
	getTablePrefix ()

Protected Attributes
const	PLUGIN_UPDATE_FILE = "/sql/dbupdate.php"

ilDBInterface	$db

ilPluginInfo	$plugin

Protected Attributes inherited from ilDBUpdate
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

Additional Inherited Members
Data Fields inherited from ilDBUpdate
string	$DB_UPDATE_FILE

int	$currentVersion = null

int	$fileVersion = null

string	$updateMsg

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 28 of file class.ilPluginDBUpdate.php.

Constructor & Destructor Documentation

◆ __construct()

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

constructor MagicMethodsValidityInspection

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ checkQuery()

ilPluginDBUpdate::checkQuery ( string $q )

This is a very simple check.

Could be done better.

Definition at line 93 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 ( )

Get current DB version.

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

References ilDBUpdate\$currentVersion.

                                        : int
     {
         return $this->currentVersion;
     }

◆ getDBUpdateScriptName()

ilPluginDBUpdate::getDBUpdateScriptName ( )

Definition at line 104 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:

◆ getFileForStep()

ilPluginDBUpdate::getFileForStep ( int $a_version )

FROM ilDBUpdate.

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

Referenced by __construct().

                                                     : string
     {
         return "dbupdate.php";
     }

Here is the caller graph for this function:

◆ getTablePrefix()

ilPluginDBUpdate::getTablePrefix ( )

protected

Definition at line 109 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:

◆ loadXMLInfo()

ilPluginDBUpdate::loadXMLInfo ( )

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

                                  : bool
     {
         return true;
     }

◆ setCurrentVersion()

ilPluginDBUpdate::setCurrentVersion ( int $a_version )

Set current DB version.

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

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

Field Documentation

◆ $db

ilDBInterface ilPluginDBUpdate::$db

protected

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

Referenced by __construct().

◆ $plugin

ilPluginInfo ilPluginDBUpdate::$plugin

protected

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

Referenced by __construct().

◆ PLUGIN_UPDATE_FILE

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

protected

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

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

Services/Component/classes/class.ilPluginDBUpdate.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkQuery()

◆ getCurrentVersion()

◆ getDBUpdateScriptName()

◆ getFileForStep()

◆ getTablePrefix()

◆ loadXMLInfo()

◆ setCurrentVersion()

Field Documentation

◆ $db

◆ $plugin

◆ PLUGIN_UPDATE_FILE