Class ilDbSetup. More...

Collaboration diagram for DBSetup:

Public Member Functions
	isConnectable ($keep_connection=false)

	createDatabase ($a_collation)

	provideGlobalDB ()

	revokeGlobalDB ()

	installDatabase ()

	isDatabaseExisting ()

	isDatabaseConnectable ()

	isDatabaseInstalled ()

	getClient ()

	setClient ($client)

	getStatus ()

	setStatus ($status)

	getSqlDumpFile ()

	setSqlDumpFile ($sql_dump_file)

	dropTables ()

	getIlDBInterface ()

	setIlDBInterface ($ilDBInterface)

Static Public Member Functions
static	getInstanceForClient (\ilClient $client)

static	getNewInstanceForClient (\ilClient $client)

static	getInstanceForNewClient ($client_name, $dbname, $host='localhost', $username='root', $password='', $type=ilDBConstants::TYPE_PDO_MYSQL_INNODB)

Data Fields
const	STATUS_OK = 1

const	STATUS_FAILURE = 2

Protected Member Functions
	__construct (\ilClient $client)
	ilDbSetup constructor. More...

	getline ($fp, $delim)

	readDump ()
	@description legacy version of readdump More...

	readDumpSmall ()
	@description legacy version of readdump More...

	readDumpUltraSmall ()

	canDatabaseBeInstalled ()

Protected Attributes
	$client

	$status = self::STATUS_FAILURE

	$ilDBInterface

	$sql_dump_file = './setup/sql/ilias3.sql'

Static Protected Attributes
static	$instances = array()

Detailed Description

Class ilDbSetup.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 10 of file class.ilDbSetup.php.

Constructor & Destructor Documentation

◆ __construct()

DBSetup::__construct ( \ilClient $client )

protected

ilDbSetup constructor.

Parameters

\ilClient $client

Definition at line 67 of file class.ilDbSetup.php.

    {
        $this->client = $client;
        $this->ilDBInterface = ilDBWrapperFactory::getWrapper($client->getDbType());
        $this->ilDBInterface->initFromIniFile($this->client->ini);
    }

References $client, ilDBWrapperFactory\getWrapper(), and ilDBInterface\initFromIniFile().

Here is the call graph for this function:

Member Function Documentation

◆ canDatabaseBeInstalled()

DBSetup::canDatabaseBeInstalled ( )

protected

Returns: bool

Definition at line 346 of file class.ilDbSetup.php.

    {
        $connectable = $this->isDatabaseConnectable();
        $installed = $this->isDatabaseInstalled();
 
        return ($connectable && !$installed);
    }

References isDatabaseConnectable(), and isDatabaseInstalled().

Referenced by installDatabase().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createDatabase()

DBSetup::createDatabase ( $a_collation )

Parameters

$a_collation

Returns: bool|mixed

Definition at line 129 of file class.ilDbSetup.php.

    {
        if ($this->isConnectable()) {
            switch ($this->ilDBInterface->getDBType()) {
                case ilDBConstants::TYPE_PDO_MYSQL_MYISAM:
                case ilDBConstants::TYPE_PDO_MYSQL_INNODB:
                case ilDBConstants::TYPE_MYSQL:
                case ilDBConstants::TYPE_GALERA:
                case ilDBConstants::TYPE_INNODB:
                case ilDBConstants::TYPE_PDO_POSTGRE:
                    $clientIniFile = $this->client->ini;
 
                    if (!$this->ilDBInterface->createDatabase($clientIniFile->readVariable("db", "name"), 'utf8', $a_collation)) {
                        return false;
                    }
                    $this->ilDBInterface->initFromIniFile($this->getClient()->ini);
 
                    return $this->ilDBInterface->connect();
                    break;
            }
        }
 
        return false;
    }

References ilDBInterface\connect(), ilDBInterface\createDatabase(), getClient(), ilDBInterface\getDBType(), ilDBInterface\initFromIniFile(), isConnectable(), ilDBConstants\TYPE_GALERA, ilDBConstants\TYPE_INNODB, ilDBConstants\TYPE_MYSQL, ilDBConstants\TYPE_PDO_MYSQL_INNODB, ilDBConstants\TYPE_PDO_MYSQL_MYISAM, and ilDBConstants\TYPE_PDO_POSTGRE.

Here is the call graph for this function:

◆ dropTables()

DBSetup::dropTables ( )

Definition at line 409 of file class.ilDbSetup.php.

    {
        foreach ($this->ilDBInterface->listTables() as $table) {
            $this->ilDBInterface->manipulate('DROP TABLE ' . $table);
        }
    }

References ilDBInterface\listTables(), and ilDBInterface\manipulate().

Here is the call graph for this function:

◆ getClient()

DBSetup::getClient ( )

Returns: ilClient

Definition at line 358 of file class.ilDbSetup.php.

    {
        return $this->client;
    }

References $client.

Referenced by createDatabase(), and installDatabase().

Here is the caller graph for this function:

◆ getIlDBInterface()

DBSetup::getIlDBInterface ( )

Returns: \ilDBInterface

Definition at line 420 of file class.ilDbSetup.php.

    {
        return $this->ilDBInterface;
    }

References $ilDBInterface.

◆ getInstanceForClient()

static DBSetup::getInstanceForClient ( \ilClient $client )

static

Parameters

\ilClient $client

Returns: ilDbSetup

Definition at line 79 of file class.ilDbSetup.php.

    {
        if (empty(self::$instances[$client->getId()])) {
            self::$instances[$client->getId()] = new self($client);
        }
 
        return self::$instances[$client->getId()];
    }

References $client.

Referenced by getInstanceForNewClient().

Here is the caller graph for this function:

◆ getInstanceForNewClient()

static DBSetup::getInstanceForNewClient	(	$client_name,
		$dbname,
		$host = `'localhost'`,
		$username = `'root'`,
		$password = `''`,
		$type = `ilDBConstants::TYPE_PDO_MYSQL_INNODB`
	)

static

Parameters

	$client_name
	$dbname
string	$host
string	$username
string	$password
string	$type

Returns: \ilDbSetup

Definition at line 106 of file class.ilDbSetup.php.

    {
        require_once('./setup/classes/class.ilClient.php');
        require_once('./Services/Init/classes/class.ilIniFile.php');
        require_once('./setup/classes/class.ilDBConnections.php');
 
        $ilClient = new ilClient($client_name, new ilDBConnections());
        $ilClient->init();
        $ilClient->setDbHost($host);
        $ilClient->setDbName($dbname);
        $ilClient->setDbUser($username);
        $ilClient->setDbPass($password);
        $ilClient->setDbType($type);
        $ilClient->writeIni();
 
        return self::getInstanceForClient($ilClient);
    }

References $password, $type, and getInstanceForClient().

Here is the call graph for this function:

◆ getline()

DBSetup::getline	(	$fp,
		$delim
	)

protected

Parameters

$fp
$delim

Returns: string

Definition at line 181 of file class.ilDbSetup.php.

    {
        $result = "";
        while (!feof($fp)) {
            $tmp = fgetc($fp);
            if ($tmp == $delim) {
                return $result;
            }
            $result .= $tmp;
        }
 
        return $result;
    }

References $result.

Referenced by readDump().

Here is the caller graph for this function:

◆ getNewInstanceForClient()

static DBSetup::getNewInstanceForClient ( \ilClient $client )

static

Parameters

\ilClient $client

Returns: \ilDbSetup

Definition at line 92 of file class.ilDbSetup.php.

                                                                      : \ilDbSetup
    {
        return new self($client);
    }

References $client.

◆ getSqlDumpFile()

DBSetup::getSqlDumpFile ( )

Returns: string

Definition at line 394 of file class.ilDbSetup.php.

    {
        return $this->sql_dump_file;
    }

References $sql_dump_file.

Referenced by readDump(), readDumpSmall(), and readDumpUltraSmall().

Here is the caller graph for this function:

◆ getStatus()

DBSetup::getStatus ( )

Returns: mixed

Definition at line 376 of file class.ilDbSetup.php.

    {
        return $this->status;
    }

References $status.

◆ installDatabase()

DBSetup::installDatabase ( )

Returns: bool

Definition at line 265 of file class.ilDbSetup.php.

    {
        if ($this->canDatabaseBeInstalled()) {
            $this->provideGlobalDB();
            switch ($this->ilDBInterface->getDBType()) {
                case ilDBConstants::TYPE_PDO_MYSQL_MYISAM:
                case ilDBConstants::TYPE_MYSQL:
                    $this->ilDBInterface->connect();
                    //$this->dropTables();
                    //$this->readDump();
                    $this->readDumpUltraSmall();
                    $this->getClient()->db_installed = true;
 
                    return true;
 
                    break;
                case ilDBConstants::TYPE_PDO_MYSQL_INNODB:
                case ilDBConstants::TYPE_INNODB:
                case ilDBConstants::TYPE_GALERA:
                case ilDBConstants::TYPE_PDO_POSTGRE:
                case ilDBConstants::TYPE_POSTGRES:
                    include_once("./setup/sql/ilDBTemplate.php");
                    setupILIASDatabase();
 
                    return true;
                    break;
            }
        }
 
        return false;
    }

References canDatabaseBeInstalled(), ilDBInterface\connect(), getClient(), ilDBInterface\getDBType(), provideGlobalDB(), readDumpUltraSmall(), ilDBConstants\TYPE_GALERA, ilDBConstants\TYPE_INNODB, ilDBConstants\TYPE_MYSQL, ilDBConstants\TYPE_PDO_MYSQL_INNODB, ilDBConstants\TYPE_PDO_MYSQL_MYISAM, ilDBConstants\TYPE_PDO_POSTGRE, and ilDBConstants\TYPE_POSTGRES.

Here is the call graph for this function:

◆ isConnectable()

DBSetup::isConnectable ( $keep_connection = false )

Returns: bool|mixed

Definition at line 18 of file class.ilDbSetup.php.

    {
        switch ($this->ilDBInterface->getDBType()) {
            default:
                try {
                    $connect = $this->ilDBInterface->connect();
                } catch (PDOException $e) {
                    $connect = ($e->getCode() == 1049);
                }
                break;
        }
        if ($keep_connection && $connect) {
            $this->provideGlobalDB();
        }
 
        if (!$connect) {
            $this->client->setError('Database can\'t be reached. Please check the credentials and if database exists');
        }
 
        return $connect;
    }

References Vendor\Package\$e, ilDBInterface\connect(), ilDBInterface\getDBType(), and provideGlobalDB().

Referenced by createDatabase(), isDatabaseConnectable(), and isDatabaseExisting().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isDatabaseConnectable()

DBSetup::isDatabaseConnectable ( )

Returns: bool

Definition at line 318 of file class.ilDbSetup.php.

    {
        if (!$this->isConnectable()) {
            return false;
        }
 
        return $this->ilDBInterface->connect(true);
    }

References ilDBInterface\connect(), and isConnectable().

Referenced by canDatabaseBeInstalled(), and isDatabaseExisting().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isDatabaseExisting()

DBSetup::isDatabaseExisting ( )

Returns: bool

Definition at line 301 of file class.ilDbSetup.php.

    {
        if (!$this->isConnectable()) {
            return false;
        }
        if (!$this->isDatabaseConnectable()) {
            return false;
        }
 
        return true;
    }

References isConnectable(), and isDatabaseConnectable().

Referenced by isDatabaseInstalled().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isDatabaseInstalled()

DBSetup::isDatabaseInstalled ( )

Returns: bool

Definition at line 331 of file class.ilDbSetup.php.

    {
        if (!$this->isDatabaseExisting()) {
            return false;
        }
 
        $target = array( 'usr_data', 'object_data', 'object_reference' );
 
        return count(array_intersect($this->ilDBInterface->listTables(), $target)) == count($target);
    }

References isDatabaseExisting(), and ilDBInterface\listTables().

Referenced by canDatabaseBeInstalled().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ provideGlobalDB()

DBSetup::provideGlobalDB ( )

Definition at line 155 of file class.ilDbSetup.php.

    {
        global $DIC;
 
        if ($DIC->offsetExists('ilDB')) {
            $DIC->offsetUnset('ilDB');
        }
 
        $GLOBALS["ilDB"] = $this->ilDBInterface;
        $DIC["ilDB"] = $this->ilDBInterface;
        $this->client->db = $this->ilDBInterface; // TODO ugly and dirty, but ilClient requires it
    }

References $DIC, $GLOBALS, and $ilDBInterface.

Referenced by installDatabase(), and isConnectable().

Here is the caller graph for this function:

◆ readDump()

DBSetup::readDump ( )

protected

@description legacy version of readdump

Deprecated:: use readDumpUltraSmall

Returns: bool

Definition at line 201 of file class.ilDbSetup.php.

    {
        $fp = fopen($this->getSqlDumpFile(), 'r');
        $q = '';
        while (!feof($fp)) {
            $line = trim($this->getline($fp, "\n"));
 
            if ($line != "" && substr($line, 0, 1) != "#" && substr($line, 0, 1) != "-") {
                if (substr($line, -1) == ";") {
                    //query is complete
                    $q .= " " . substr($line, 0, -1);
                    try {
                        $r = $this->ilDBInterface->query($q);
                    } catch (ilDatabaseException $e) {
                        return false;
                    }
 
                    unset($q);
                    unset($line);
                } else {
                    $q .= " " . $line;
                }
            }
        }
 
        fclose($fp);
    }

References Vendor\Package\$e, getline(), getSqlDumpFile(), and ilDBInterface\query().

Here is the call graph for this function:

◆ readDumpSmall()

DBSetup::readDumpSmall ( )

protected

@description legacy version of readdump

Deprecated:: use readDumpUltraSmall

Returns: bool

Definition at line 235 of file class.ilDbSetup.php.

    {
        $sql = file_get_contents($this->getSqlDumpFile());
        $lines = explode(';', $sql);
        foreach ($lines as $line) {
            if (strlen($line) > 0) {
                $this->ilDBInterface->manipulate($line);
            }
        }
 
        return true;
    }

References getSqlDumpFile(), and ilDBInterface\manipulate().

Here is the call graph for this function:

◆ readDumpUltraSmall()

DBSetup::readDumpUltraSmall ( )

protected

Returns: bool

Definition at line 252 of file class.ilDbSetup.php.

    {
        $sql = file_get_contents($this->getSqlDumpFile());
        $re = $this->ilDBInterface->prepareManip($sql);
        $this->ilDBInterface->execute($re);
 
        return true;
    }

References ilDBInterface\execute(), getSqlDumpFile(), and ilDBInterface\prepareManip().

Referenced by installDatabase().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ revokeGlobalDB()

DBSetup::revokeGlobalDB ( )

Definition at line 169 of file class.ilDbSetup.php.

    {
        $GLOBALS["ilDB"] = null;
        $this->client->db = null; // TODO ugly and dirty, but ilClient requires it
    }

References $GLOBALS.

◆ setClient()

DBSetup::setClient ( $client )

Parameters

ilClient $client

Definition at line 367 of file class.ilDbSetup.php.

    {
        $this->client = $client;
    }

References $client.

◆ setIlDBInterface()

DBSetup::setIlDBInterface ( $ilDBInterface )

Parameters

\ilDBInterface $ilDBInterface

Definition at line 429 of file class.ilDbSetup.php.

    {
        $this->ilDBInterface = $ilDBInterface;
    }

References $ilDBInterface.

◆ setSqlDumpFile()

DBSetup::setSqlDumpFile ( $sql_dump_file )

Parameters

string $sql_dump_file

Definition at line 403 of file class.ilDbSetup.php.

    {
        $this->sql_dump_file = $sql_dump_file;
    }

References $sql_dump_file.

◆ setStatus()

DBSetup::setStatus ( $status )

Parameters

mixed $status

Definition at line 385 of file class.ilDbSetup.php.

    {
        $this->status = $status;
    }

References $status.

Field Documentation

◆ $client

DBSetup::$client

protected

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

Referenced by __construct(), getClient(), getInstanceForClient(), getNewInstanceForClient(), and setClient().

◆ $ilDBInterface

DBSetup::$ilDBInterface

protected

Definition at line 55 of file class.ilDbSetup.php.

Referenced by getIlDBInterface(), provideGlobalDB(), and setIlDBInterface().

◆ $instances

DBSetup::$instances = array()

staticprotected

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

◆ $sql_dump_file

DBSetup::$sql_dump_file = './setup/sql/ilias3.sql'

protected

Definition at line 59 of file class.ilDbSetup.php.

Referenced by getSqlDumpFile(), and setSqlDumpFile().

◆ $status

DBSetup::$status = self::STATUS_FAILURE

protected

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

Referenced by getStatus(), and setStatus().

◆ STATUS_FAILURE

const DBSetup::STATUS_FAILURE = 2

Definition at line 13 of file class.ilDbSetup.php.

◆ STATUS_OK

const DBSetup::STATUS_OK = 1

Definition at line 12 of file class.ilDbSetup.php.

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

Services/Database/classes/Setup/class.ilDbSetup.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ canDatabaseBeInstalled()

◆ createDatabase()

◆ dropTables()

◆ getClient()

◆ getIlDBInterface()

◆ getInstanceForClient()

◆ getInstanceForNewClient()

◆ getline()

◆ getNewInstanceForClient()

◆ getSqlDumpFile()

◆ getStatus()

◆ installDatabase()

◆ isConnectable()

◆ isDatabaseConnectable()

◆ isDatabaseExisting()

◆ isDatabaseInstalled()

◆ provideGlobalDB()

◆ readDump()

◆ readDumpSmall()

◆ readDumpUltraSmall()

◆ revokeGlobalDB()

◆ setClient()

◆ setIlDBInterface()

◆ setSqlDumpFile()

◆ setStatus()

Field Documentation

◆ $client

◆ $ilDBInterface

◆ $instances

◆ $sql_dump_file

◆ $status

◆ STATUS_FAILURE

◆ STATUS_OK