Collaboration diagram for ilDbSetup:

Public Member Functions
	createDatabase ($a_collation)

	provideGlobalDB ()

	revokeGlobalDB ()

	installDatabase ()

	isDatabaseExisting ()

	isConnectable ($keep_connection=false)

	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 ()
	legacy version of readdump More...

	readDumpSmall ()
	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()

ilDbSetup::__construct ( \ilClient $client )

protected

ilDbSetup constructor.

Parameters

\ilClient $client

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

References $client, and ilClient\getDbType().

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

Here is the call graph for this function:

Member Function Documentation

◆ canDatabaseBeInstalled()

ilDbSetup::canDatabaseBeInstalled ( )

protected

Returns: bool

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

References isDatabaseConnectable(), and isDatabaseInstalled().

Referenced by installDatabase().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createDatabase()

ilDbSetup::createDatabase ( $a_collation )

Parameters

$a_collation

Returns: bool|mixed

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

References getClient(), 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.

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

Here is the call graph for this function:

◆ dropTables()

ilDbSetup::dropTables ( )

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

References $table.

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

◆ getClient()

ilDbSetup::getClient ( )

Returns: ilClient

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

References $client.

Referenced by createDatabase(), and installDatabase().

     {
         return $this->client;
     }

Here is the caller graph for this function:

◆ getIlDBInterface()

ilDbSetup::getIlDBInterface ( )

Returns

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

References $ilDBInterface.

     {
         return $this->ilDBInterface;
     }

◆ getInstanceForClient()

static ilDbSetup::getInstanceForClient ( \ilClient $client )

static

Parameters

\ilClient $client

Returns: ilDbSetup

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

References $client, and ilClient\getId().

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

Here is the call graph for this function:

◆ getInstanceForNewClient()

static ilDbSetup::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

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

References $password, and $type.

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

◆ getline()

ilDbSetup::getline	(	$fp,
		$delim
	)

protected

Parameters

$fp
$delim

Returns: string

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

References $result.

Referenced by readDump().

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

Here is the caller graph for this function:

◆ getNewInstanceForClient()

static ilDbSetup::getNewInstanceForClient ( \ilClient $client )

static

Parameters

\ilClient $client

Returns

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

References $client.

Referenced by ilClient\getDBSetup().

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

Here is the caller graph for this function:

◆ getSqlDumpFile()

ilDbSetup::getSqlDumpFile ( )

Returns: string

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

References $sql_dump_file.

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

     {
         return $this->sql_dump_file;
     }

Here is the caller graph for this function:

◆ getStatus()

ilDbSetup::getStatus ( )

Returns: mixed

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

References $status.

     {
         return $this->status;
     }

◆ installDatabase()

ilDbSetup::installDatabase ( )

Returns: bool

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

References canDatabaseBeInstalled(), getClient(), 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.

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

Here is the call graph for this function:

◆ isConnectable()

ilDbSetup::isConnectable ( $keep_connection = false )

Returns: bool|mixed

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

References provideGlobalDB().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isDatabaseConnectable()

ilDbSetup::isDatabaseConnectable ( )

Returns: bool

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

References isConnectable().

Referenced by canDatabaseBeInstalled(), and isDatabaseExisting().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isDatabaseExisting()

ilDbSetup::isDatabaseExisting ( )

Returns: bool

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

References isConnectable(), and isDatabaseConnectable().

Referenced by isDatabaseInstalled().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isDatabaseInstalled()

ilDbSetup::isDatabaseInstalled ( )

Returns: bool

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

References $target, and isDatabaseExisting().

Referenced by canDatabaseBeInstalled().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ provideGlobalDB()

ilDbSetup::provideGlobalDB ( )

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

References $DIC, $GLOBALS, and $ilDBInterface.

Referenced by installDatabase(), and isConnectable().

     {
         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
     }

Here is the caller graph for this function:

◆ readDump()

ilDbSetup::readDump ( )

protected

legacy version of readdump

Deprecated:: use readDumpUltraSmall

Returns: bool

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

References $r, getline(), and getSqlDumpFile().

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

Here is the call graph for this function:

◆ readDumpSmall()

ilDbSetup::readDumpSmall ( )

protected

legacy version of readdump

Deprecated:: use readDumpUltraSmall

Returns: bool

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

References getSqlDumpFile().

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

Here is the call graph for this function:

◆ readDumpUltraSmall()

ilDbSetup::readDumpUltraSmall ( )

protected

Returns: bool

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

References getSqlDumpFile().

Referenced by installDatabase().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ revokeGlobalDB()

ilDbSetup::revokeGlobalDB ( )

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

References $GLOBALS.

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

◆ setClient()

ilDbSetup::setClient ( $client )

Parameters

ilClient $client

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

References $client.

     {
         $this->client = $client;
     }

◆ setIlDBInterface()

ilDbSetup::setIlDBInterface ( $ilDBInterface )

Parameters

\ilDBInterface $ilDBInterface

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

References $ilDBInterface.

     {
         $this->ilDBInterface = $ilDBInterface;
     }

◆ setSqlDumpFile()

ilDbSetup::setSqlDumpFile ( $sql_dump_file )

Parameters

string $sql_dump_file

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

References $sql_dump_file.

     {
         $this->sql_dump_file = $sql_dump_file;
     }

◆ setStatus()

ilDbSetup::setStatus ( $status )

Parameters

mixed $status

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

References $status.

     {
         $this->status = $status;
     }

Field Documentation

◆ $client

ilDbSetup::$client

protected

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

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

◆ $ilDBInterface

ilDbSetup::$ilDBInterface

protected

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

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

◆ $instances

ilDbSetup::$instances = array()

staticprotected

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

◆ $sql_dump_file

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

protected

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

Referenced by getSqlDumpFile(), and setSqlDumpFile().

◆ $status

ilDbSetup::$status = self::STATUS_FAILURE

protected

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

Referenced by getStatus(), and setStatus().

◆ STATUS_FAILURE

const ilDbSetup::STATUS_FAILURE = 2

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

◆ STATUS_OK

const ilDbSetup::STATUS_OK = 1

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

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

setup/classes/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