Class pdoDB. More...

Inheritance diagram for ilDBPdo:

Collaboration diagram for ilDBPdo:

Public Member Functions

connect (bool $return_false_for_error=false)

initHelpers ()

getFieldDefinition ()

setFieldDefinition (\ilDBPdoFieldDefinition $field_definition)

createDatabase (string $a_name, string $a_charset="utf8", string $a_collation="")

getLastErrorCode ()

initFromIniFile (?ilIniFile $ini=null)

generateDSN ()

quoteIdentifier (string $identifier, bool $check_option=false)

nextId (string $table_name)

createTable (string $table_name, array $fields, bool $drop_table=false, bool $ignore_erros=false)

checkColumnName (string $a_name)

addPrimaryKey (string $table_name, array $primary_keys)

dropIndexByFields (string $table_name, array $fields)

getPrimaryKeyIdentifier ()

createSequence (string $table_name, int $start=1)

tableExists (string $table_name)

tableColumnExists (string $table_name, string $column_name)

addTableColumn (string $table_name, string $column_name, array $attributes)

dropTable (string $table_name, bool $error_if_not_existing=true)

query (string $query)

fetchAll (ilDBStatement $statement, int $fetch_mode=ilDBConstants::FETCHMODE_ASSOC)

dropSequence (string $table_name)

dropTableColumn (string $table_name, string $column_name)

renameTableColumn (string $table_name, string $column_old_name, string $column_new_name)

insert (string $table_name, array $values)

fetchObject (ilDBStatement $query_result)

update (string $table_name, array $columns, array $where)

$where MUST contain existing columns only. More...

manipulate (string $query)

fetchAssoc (ilDBStatement $statement)

numRows (ilDBStatement $statement)

quote ($value, ?string $type=null)

indexExistsByFields (string $table_name, array $fields)

addIndex (string $table_name, array $fields, string $index_name='', bool $fulltext=false)

addFulltextIndex (string $table, array $fields, string $a_name="in")

dropFulltextIndex (string $a_table, string $a_name)

Drop fulltext index. More...

isFulltextIndex (string $a_table, string $a_name)

Is index a fulltext index? More...

getIndexName (string $index_name_base)

getSequenceName (string $table_name)

constraintName (string $a_table, string $a_constraint)

Determine contraint name by table name and constraint name. More...

getDSN ()

Get DSN. More...

getDBType ()

Get DSN. More...

setDBType (string $type)

lockTables (array $tables)

unlockTables ()

in (string $field, array $values, bool $negate=false, string $type="")

queryF (string $query, array $types, array $values)

manipulateF (string $query, array $types, array $values)

useSlave (bool $bool)

TODO. More...

setLimit (int $limit, int $offset=0)

Set the Limit for the next Query. More...

like (string $column, string $type, string $value="?", bool $case_insensitive=true)

now ()

replace (string $table, array $primary_keys, array $other_columns)

Replace into method. More...

equals (string $columns, $value, string $type, bool $emptyOrNull=false)

getHost ()

setHost (string $host)

getDbname ()

setDbname (string $dbname)

getCharset ()

setCharset (string $charset)

getUsername ()

setUsername (string $username)

getPassword ()

setPassword (string $password)

getPort ()

setPort (int $port)

setDBUser (string $user)

setDBPort (int $port)

setDBPassword (string $password)

setDBHost (string $host)

upper (string $expression)

lower (string $expression)

substr (string $a_exp, int $a_pos=1, int $a_len=-1)

prepareManip (string $query, ?array $types=null)

prepare (string $query, ?array $types=null, ?array $result_types=null)

enableResultBuffering (bool $a_status)

supportsSlave ()

supportsFulltext ()

supportsTransactions ()

supports (string $feature)

listTables ()

loadModule (string $module)

getAllowedAttributes ()

Returns: string[]

More...

sequenceExists (string $sequence)

listSequences ()

concat (array $values, bool $allow_null=true)

locate (string $needle, string $string, int $start_pos=1)

modifyTableColumn (string $table, string $column, array $attributes)

free (ilDBStatement $a_st)

renameTable (string $name, string $new_name)

checkTableName (string $a_name)

beginTransaction ()

commit ()

rollback ()

dropIndex (string $a_table, string $a_name="i1")

setStorageEngine (string $storage_engine)

getStorageEngine ()

queryCol (string $query, int $type=PDO::FETCH_ASSOC, int $colnum=0)

queryRow (string $query, ?array $types=null, int $fetchmode=ilDBConstants::FETCHMODE_DEFAULT)

getServerVersion (bool $native=false)

escape (string $value, bool $escape_wildcards=false)

escapePattern (string $text)

migrateAllTablesToEngine (string $engine=ilDBConstants::MYSQL_ENGINE_INNODB)

migrateAllTablesToCollation (string $collation=ilDBConstants::MYSQL_COLLATION_UTF8MB4)

supportsCollationMigration ()

supportsEngineMigration ()

checkIndexName (string $name)

addUniqueConstraint (string $table, array $fields, string $name="con")

dropUniqueConstraint (string $table, string $name="con")

dropUniqueConstraintByFields (string $table, array $fields)

getLastInsertId ()

buildAtomQuery ()

uniqueConstraintExists (string $table, array $fields)

dropPrimaryKey (string $table_name)

executeMultiple (ilDBStatement $stmt, array $data)

fromUnixtime (string $expr, bool $to_text=true)

unixTimestamp ()

getDBVersion ()

sanitizeMB4StringIfNotSupported (string $query)

Parameters

$query string to sanitize, all MB4-Characters like emojis will re replaced with ???

Returns: string sanitized query

More...

doesCollationSupportMB4Strings ()

groupConcat (string $a_field_name, string $a_seperator=",", ?string $a_order=null)

cast (string $a_field_name, string $a_dest_type)

addForeignKey (string $foreign_key_name, array $field_names, string $table_name, array $reference_field_names, string $reference_table, ?ForeignKeyConstraints $on_update=null, ?ForeignKeyConstraints $on_delete=null)

dropForeignKey (string $foreign_key_name, string $table_name)

foreignKeyExists (string $foreign_key_name, string $table_name)

buildIntegrityAnalyser ()

primaryExistsByFields (string $table_name, array $fields)

Public Member Functions inherited from ilDBInterface

quote ($value, string $type)

substr (string $expression)

prepare (string $a_query, array $a_types=null, array $a_result_types=null)

Prepare a query (SELECT) statement to be used with execute. More...

execute (ilDBStatement $stmt, array $data=[])

Public Member Functions inherited from ilDBPdoInterface

migrateTableToEngine (string $table_name, string $engine=ilDBConstants::MYSQL_ENGINE_INNODB)

migrateTableCollation (string $table_name, string $collation=ilDBConstants::MYSQL_COLLATION_UTF8MB4)

Static Public Member Functions
static	isReservedWord (string $a_word)

Static Public Member Functions inherited from ilDBInterface
static	getReservedWords ()
	Get reserved words. More...

Data Fields
array	$options = []

const	FEATURE_TRANSACTIONS = 'transactions'

const	FEATURE_FULLTEXT = 'fulltext'

const	FEATURE_SLAVE = 'slave'

Protected Member Functions
	initSQLMode ()

	getAttributes ()

	getAdditionalAttributes ()

	checkTableColumns (array $a_cols)

	checkColumn (string $a_col, array $a_def)

	checkColumnDefinition (array $a_def, bool $a_modify_mode=false)

	appendLimit (string $query)

Protected Attributes
string	$host = ''

string	$dbname = ''

string	$charset = 'utf8'

string	$username = ''

string	$password = ''

int	$port = 3306

PDO	$pdo = null

ilDBPdoManager	$manager

ilDBPdoReverse	$reverse

int	$limit = null

int	$offset = null

string	$storage_engine = 'InnoDB'

string	$dsn = ''

array	$attributes

string	$db_type = ''

int	$error_code = 0

ilDBPdoFieldDefinition	$field_definition = null

Detailed Description

Class pdoDB.

Author: Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Member Function Documentation

◆ addForeignKey()

ilDBPdo::addForeignKey	(	string	$foreign_key_name,
		array	$field_names,
		string	$table_name,
		array	$reference_field_names,
		string	$reference_table,
		?ForeignKeyConstraints	$on_update = `null`,
		?ForeignKeyConstraints	$on_delete = `null`
	)

Parameters

string[]	$field_names
string[]	$reference_field_names

Implements ilDBInterface.

Definition at line 1508 of file class.ilDBPdo.php.

      : bool {
         return $this->manager->addForeignKey($foreign_key_name, $field_names, $table_name, $reference_field_names, $reference_table, $on_update, $on_delete);
     }

◆ addFulltextIndex()

ilDBPdo::addFulltextIndex	(	string	$table,
		array	$fields,
		string	$a_name = `"in"`
	)

Exceptions

Implements ilDBInterface.

Definition at line 663 of file class.ilDBPdo.php.

References $q, constraintName(), and query().

Referenced by addIndex().

                                                                                          : bool
     {
         $i_name = $this->constraintName($table, $a_name) . "_idx";
         $f_str = implode(",", $fields);
         $q = "ALTER TABLE $table ADD FULLTEXT $i_name ($f_str)";
         $this->query($q);
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addIndex()

ilDBPdo::addIndex	(	string	$table_name,
		array	$fields,
		string	$index_name = `''`,
		bool	$fulltext = `false`
	)

Implements ilDBInterface.

Definition at line 637 of file class.ilDBPdo.php.

References Vendor\Package\$f, addFulltextIndex(), constraintName(), and supportsFulltext().

                                                                                                                 : bool
     {
         assert(is_array($fields));
         $this->field_definition->checkIndexName($index_name);
 
         $definition_fields = array();
         foreach ($fields as $f) {
             $definition_fields[$f] = array();
         }
         $definition = array(
             'fields' => $definition_fields,
         );
 
         if (!$fulltext) {
             $this->manager->createIndex($table_name, $this->constraintName($table_name, $index_name), $definition);
         } elseif ($this->supportsFulltext()) {
             $this->addFulltextIndex($table_name, $fields, $index_name);
             // TODO
         }
 
         return true;
     }

Here is the call graph for this function:

◆ addPrimaryKey()

ilDBPdo::addPrimaryKey	(	string	$table_name,
		array	$primary_keys
	)

Exceptions

Implements ilDBInterface.

Definition at line 236 of file class.ilDBPdo.php.

References Vendor\Package\$f, constraintName(), and getPrimaryKeyIdentifier().

                                                                           : bool
     {
         assert(is_array($primary_keys));
 
         $fields = array();
         foreach ($primary_keys as $f) {
             $fields[$f] = array();
         }
         $definition = array(
             'primary' => true,
             'fields' => $fields,
         );
         $this->manager->createConstraint(
             $table_name,
             $this->constraintName($table_name, $this->getPrimaryKeyIdentifier()),
             $definition
         );
 
         return true;
     }

Here is the call graph for this function:

◆ addTableColumn()

ilDBPdo::addTableColumn	(	string	$table_name,
		string	$column_name,
		array	$attributes
	)

Exceptions

Implements ilDBInterface.

Definition at line 305 of file class.ilDBPdo.php.

References checkColumnDefinition(), and checkColumnName().

                                                                                               : bool
     {
         if (!$this->checkColumnName($column_name)) {
             throw new ilDatabaseException("ilDB Error: addTableColumn(" . $table_name . ", " . $column_name . ")");
         }
         if (!$this->checkColumnDefinition($attributes)) {
             throw new ilDatabaseException("ilDB Error: addTableColumn(" . $table_name . ", " . $column_name . ")");
         }
 
         $changes = array(
             "add" => array(
                 $column_name => $attributes,
             ),
         );
 
         return $this->manager->alterTable($table_name, $changes, false);
     }

Here is the call graph for this function:

◆ addUniqueConstraint()

ilDBPdo::addUniqueConstraint	(	string	$table,
		array	$fields,
		string	$name = `"con"`
	)

Exceptions

Implements ilDBPdoInterface.

Definition at line 1349 of file class.ilDBPdo.php.

References Vendor\Package\$f, $manager, checkIndexName(), constraintName(), and ilDBPdoManager\createConstraint().

                                                                                            : bool
     {
         assert(is_array($fields));
         $manager = $this->manager;
 
         // check index name
         if (!$this->checkIndexName($name)) {
             throw new ilDatabaseException("ilDB Error: addUniqueConstraint(" . $table . "," . $name . ")");
         }
 
         $fields_corrected = array();
         foreach ($fields as $f) {
             $fields_corrected[$f] = array();
         }
         $definition = array(
             'unique' => true,
             'fields' => $fields_corrected,
         );
 
         return $manager->createConstraint($table, $this->constraintName($table, $name), $definition);
     }

Here is the call graph for this function:

◆ appendLimit()

ilDBPdo::appendLimit ( string $query )

protected

Definition at line 1092 of file class.ilDBPdo.php.

References $limit.

Referenced by query().

                                                  : string
     {
         if ($this->limit !== null && $this->offset !== null) {
             $query .= ' LIMIT ' . $this->offset . ', ' . $this->limit;
             $this->limit = null;
             $this->offset = null;
 
             return $query;
         }
 
         return $query;
     }

Here is the caller graph for this function:

◆ beginTransaction()

ilDBPdo::beginTransaction ( )

Exceptions

Implements ilDBInterface.

Definition at line 1208 of file class.ilDBPdo.php.

References supports().

                                       : bool
     {
         if (!$this->supports(self::FEATURE_TRANSACTIONS)) {
             throw new ilDatabaseException("ilDB::beginTransaction: Transactions are not supported.");
         }
 
         return $this->pdo->beginTransaction();
     }

Here is the call graph for this function:

◆ buildAtomQuery()

ilDBPdo::buildAtomQuery ( )

Implements ilDBInterface.

Definition at line 1402 of file class.ilDBPdo.php.

                                     : ilAtomQuery
     {
         return new ilAtomQueryLock($this);
     }

◆ buildIntegrityAnalyser()

ilDBPdo::buildIntegrityAnalyser ( )

Implements ilDBInterface.

Definition at line 1530 of file class.ilDBPdo.php.

                                             : Integrity
     {
         return new Integrity($this);
     }

◆ cast()

ilDBPdo::cast	(	string	$a_field_name,
		string	$a_dest_type
	)

Implements ilDBInterface.

Definition at line 1503 of file class.ilDBPdo.php.

                                                                    : string
     {
         return $this->manager->getQueryUtils()->cast($a_field_name, $a_dest_type);
     }

◆ checkColumn()

ilDBPdo::checkColumn	(	string	$a_col,
		array	$a_def
	)

protected

Definition at line 215 of file class.ilDBPdo.php.

References checkColumnDefinition(), and checkColumnName().

Referenced by checkTableColumns().

                                                                : bool
     {
         if (!$this->checkColumnName($a_col)) {
             return false;
         }
         return $this->checkColumnDefinition($a_def);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkColumnDefinition()

ilDBPdo::checkColumnDefinition	(	array	$a_def,
		bool	$a_modify_mode = `false`
	)

protected

Definition at line 223 of file class.ilDBPdo.php.

Referenced by addTableColumn(), checkColumn(), and modifyTableColumn().

                                                                                        : bool
     {
         return $this->field_definition->checkColumnDefinition($a_def);
     }

Here is the caller graph for this function:

◆ checkColumnName()

ilDBPdo::checkColumnName ( string $a_name )

Definition at line 228 of file class.ilDBPdo.php.

Referenced by addTableColumn(), checkColumn(), and renameTableColumn().

                                                    : bool
     {
         return $this->field_definition->checkColumnName($a_name);
     }

Here is the caller graph for this function:

◆ checkIndexName()

ilDBPdo::checkIndexName ( string $name )

Exceptions

Implements ilDBPdoInterface.

Definition at line 1337 of file class.ilDBPdo.php.

References getFieldDefinition().

Referenced by addUniqueConstraint().

                                                 : bool
     {
         $fd = $this->getFieldDefinition();
         if ($fd !== null) {
             return $fd->checkIndexName($name);
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkTableColumns()

ilDBPdo::checkTableColumns ( array $a_cols )

protected

Definition at line 204 of file class.ilDBPdo.php.

References checkColumn().

Referenced by createTable().

                                                        : bool
     {
         foreach ($a_cols as $col => $def) {
             if (!$this->checkColumn($col, $def)) {
                 return false;
             }
         }
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkTableName()

ilDBPdo::checkTableName ( string $a_name )

Exceptions

Implements ilDBInterface.

Definition at line 1194 of file class.ilDBPdo.php.

Referenced by createTable(), and renameTable().

                                                   : bool
     {
         return $this->field_definition->checkTableName($a_name);
     }

Here is the caller graph for this function:

◆ commit()

ilDBPdo::commit ( )

Exceptions

Implements ilDBInterface.

Definition at line 1220 of file class.ilDBPdo.php.

References supports().

                             : bool
     {
         if (!$this->supports(self::FEATURE_TRANSACTIONS)) {
             throw new ilDatabaseException("ilDB::beginTransaction: Transactions are not supported.");
         }
 
         return $this->pdo->commit();
     }

Here is the call graph for this function:

◆ concat()

ilDBPdo::concat	(	array	$values,
		bool	$allow_null = `true`
	)

Implements ilDBInterface.

Definition at line 1087 of file class.ilDBPdo.php.

                                                                   : string
     {
         return $this->manager->getQueryUtils()->concat($values, $allow_null);
     }

◆ connect()

ilDBPdo::connect ( bool $return_false_for_error = false )

Exceptions

Implements ilDBInterface.

Definition at line 62 of file class.ilDBPdo.php.

References Vendor\Package\$e, generateDSN(), getAttributes(), getDSN(), getPassword(), getUsername(), initHelpers(), and initSQLMode().

Referenced by createDatabase().

                                                                  : ?bool
     {
         $this->generateDSN();
         try {
             $options = $this->getAttributes();
             $this->pdo = new PDO($this->getDSN(), $this->getUsername(), $this->getPassword(), $options);
             $this->initHelpers();
             $this->initSQLMode();
         } catch (Exception $e) {
             $this->error_code = $e->getCode();
             if ($return_false_for_error) {
                 return false;
             }
             throw $e;
         }
 
         return ($this->pdo->errorCode() === PDO::ERR_NONE);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ constraintName()

ilDBPdo::constraintName	(	string	$a_table,
		string	$a_constraint
	)

Determine contraint name by table name and constraint name.

In MySQL these are "unique" per table

Implements ilDBInterface.

Definition at line 711 of file class.ilDBPdo.php.

Referenced by addFulltextIndex(), addIndex(), addPrimaryKey(), addUniqueConstraint(), dropFulltextIndex(), and dropUniqueConstraint().

                                                                          : string
     {
         return $a_constraint;
     }

Here is the caller graph for this function:

◆ createDatabase()

ilDBPdo::createDatabase	(	string	$a_name,
		string	$a_charset = `"utf8"`,
		string	$a_collation = `""`
	)

Implements ilDBInterface.

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

References Vendor\Package\$e, connect(), generateDSN(), query(), and setDbname().

                                                                                                         : bool
     {
         $this->setDbname('');
         $this->generateDSN();
         $this->connect(true);
         try {
             $this->query($this->manager->getQueryUtils()->createDatabase($a_name, $a_charset, $a_collation));
             return true;
         } catch (PDOException $e) {
             return false;
         }
     }

Here is the call graph for this function:

◆ createSequence()

ilDBPdo::createSequence	(	string	$table_name,
		int	$start = `1`
	)

Implements ilDBInterface.

Definition at line 279 of file class.ilDBPdo.php.

                                                                       : bool
     {
         $this->manager->createSequence($table_name, $start);
         return true;
     }

◆ createTable()

ilDBPdo::createTable	(	string	$table_name,
		array	$fields,
		bool	$drop_table = `false`,
		bool	$ignore_erros = `false`
	)

Exceptions

Implements ilDBInterface.

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

References checkTableColumns(), checkTableName(), and dropTable().

      : bool {
         // check table name
         if (!$ignore_erros && !$this->checkTableName($table_name)) {
             throw new ilDatabaseException("ilDB Error: createTable(" . $table_name . ")");
         }
 
         // check definition array
         if (!$ignore_erros && !$this->checkTableColumns($fields)) {
             throw new ilDatabaseException("ilDB Error: createTable(" . $table_name . ")");
         }
 
         if ($drop_table) {
             $this->dropTable($table_name, false);
         }
 
         return $this->manager->createTable($table_name, $fields, array());
     }

Here is the call graph for this function:

◆ doesCollationSupportMB4Strings()

ilDBPdo::doesCollationSupportMB4Strings ( )

Implements ilDBInterface.

Definition at line 1487 of file class.ilDBPdo.php.

Referenced by sanitizeMB4StringIfNotSupported().

                                                     : bool
     {
         return false;
     }

Here is the caller graph for this function:

◆ dropForeignKey()

ilDBPdo::dropForeignKey	(	string	$foreign_key_name,
		string	$table_name
	)

Implements ilDBInterface.

Definition at line 1520 of file class.ilDBPdo.php.

                                                                                 : bool
     {
         return $this->manager->dropForeignKey($foreign_key_name, $table_name);
     }

◆ dropFulltextIndex()

ilDBPdo::dropFulltextIndex	(	string	$a_table,
		string	$a_name
	)

Drop fulltext index.

Implements ilDBInterface.

Definition at line 675 of file class.ilDBPdo.php.

References constraintName(), and query().

                                                                       : bool
     {
         $i_name = $this->constraintName($a_table, $a_name) . "_idx";
         $this->query("ALTER TABLE $a_table DROP FULLTEXT $i_name");
         return true;
     }

Here is the call graph for this function:

◆ dropIndex()

ilDBPdo::dropIndex	(	string	$a_table,
		string	$a_name = `"i1"`
	)

Implements ilDBInterface.

Definition at line 1241 of file class.ilDBPdo.php.

Referenced by dropIndexByFields().

                                                                      : bool
     {
         return $this->manager->dropIndex($a_table, $a_name);
     }

Here is the caller graph for this function:

◆ dropIndexByFields()

ilDBPdo::dropIndexByFields	(	string	$table_name,
		array	$fields
	)

Exceptions

Implements ilDBInterface.

Definition at line 260 of file class.ilDBPdo.php.

References dropIndex().

                                                                         : bool
     {
         foreach ($this->manager->listTableIndexes($table_name) as $idx_name) {
             $def = $this->reverse->getTableIndexDefinition($table_name, $idx_name);
             $idx_fields = array_keys($def['fields']);
 
             if ($idx_fields === $fields) {
                 return $this->dropIndex($table_name, $idx_name);
             }
         }
 
         return false;
     }

Here is the call graph for this function:

◆ dropPrimaryKey()

ilDBPdo::dropPrimaryKey ( string $table_name )

Implements ilDBPdoInterface.

Definition at line 1428 of file class.ilDBPdo.php.

                                                       : bool
     {
         return $this->manager->dropConstraint($table_name, "PRIMARY", true);
     }

◆ dropSequence()

ilDBPdo::dropSequence ( string $table_name )

Implements ilDBInterface.

Definition at line 391 of file class.ilDBPdo.php.

                                                     : bool
     {
         $this->manager->dropSequence($table_name);
         return true;
     }

◆ dropTable()

ilDBPdo::dropTable	(	string	$table_name,
		bool	$error_if_not_existing = `true`
	)

Exceptions

Implements ilDBInterface.

Definition at line 326 of file class.ilDBPdo.php.

References loadModule(), and ilDBConstants\MODULE_MANAGER.

Referenced by createTable().

                                                                                      : bool
     {
         $ilDBPdoManager = $this->loadModule(ilDBConstants::MODULE_MANAGER);
         $tables = $ilDBPdoManager->listTables();
         $table_exists = in_array($table_name, $tables);
         if (!$table_exists && $error_if_not_existing) {
             throw new ilDatabaseException("Table $table_name does not exist");
         }
 
         // drop sequence
         $sequences = $ilDBPdoManager->listSequences();
         if (in_array($table_name, $sequences)) {
             $ilDBPdoManager->dropSequence($table_name);
         }
 
         // drop table
         if ($table_exists) {
             $ilDBPdoManager->dropTable($table_name);
         }
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dropTableColumn()

ilDBPdo::dropTableColumn	(	string	$table_name,
		string	$column_name
	)

Exceptions

Implements ilDBInterface.

Definition at line 400 of file class.ilDBPdo.php.

                                                                             : bool
     {
         $changes = array(
             "remove" => array(
                 $column_name => array(),
             ),
         );
 
         return $this->manager->alterTable($table_name, $changes, false);
     }

◆ dropUniqueConstraint()

ilDBPdo::dropUniqueConstraint	(	string	$table,
		string	$name = `"con"`
	)

Implements ilDBPdoInterface.

Definition at line 1371 of file class.ilDBPdo.php.

References constraintName().

Referenced by dropUniqueConstraintByFields().

                                                                              : bool
     {
         return $this->manager->dropConstraint($table, $this->constraintName($table, $name), false);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dropUniqueConstraintByFields()

ilDBPdo::dropUniqueConstraintByFields	(	string	$table,
		array	$fields
	)

Implements ilDBPdoInterface.

Definition at line 1376 of file class.ilDBPdo.php.

References Vendor\Package\$c, Vendor\Package\$f, and dropUniqueConstraint().

                                                                               : bool
     {
         $analyzer = new ilDBAnalyzer();
         $cons = $analyzer->getConstraintsInformation($table);
         foreach ($cons as $c) {
             if ($c["type"] === "unique" && count($fields) === count($c["fields"])) {
                 $all_in = true;
                 foreach ($fields as $f) {
                     if (!isset($c["fields"][$f])) {
                         $all_in = false;
                     }
                 }
                 if ($all_in) {
                     return $this->dropUniqueConstraint($table, $c['name']);
                 }
             }
         }
 
         return false;
     }

Here is the call graph for this function:

◆ enableResultBuffering()

ilDBPdo::enableResultBuffering ( bool $a_status )

Implements ilDBInterface.

Definition at line 998 of file class.ilDBPdo.php.

References $data, ilDBStatement\execute(), and ilDBInterface\execute().

                                                          : void
     {
         $this->pdo->setAttribute(PDO::MYSQL_ATTR_USE_BUFFERED_QUERY, $a_status);
     }

Here is the call graph for this function:

◆ equals()

ilDBPdo::equals	(	string	$columns,
			$value,
		string	$type,
		bool	$emptyOrNull = `false`
	)

Parameters

mixed $value

Implements ilDBInterface.

Definition at line 874 of file class.ilDBPdo.php.

References quote().

                                                                                             : string
     {
         if (!$emptyOrNull || $value != "") {
             return $columns . " = " . $this->quote($value, $type);
         }
 
         return "(" . $columns . " = '' OR $columns IS NULL)";
     }

Here is the call graph for this function:

◆ escape()

ilDBPdo::escape	(	string	$value,
		bool	$escape_wildcards = `false`
	)

Implements ilDBPdoInterface.

Definition at line 1298 of file class.ilDBPdo.php.

                                                                          : string
     {
         return $value;
     }

◆ escapePattern()

ilDBPdo::escapePattern ( string $text )

Implements ilDBPdoInterface.

Definition at line 1303 of file class.ilDBPdo.php.

                                                : string
     {
         return $text;
     }

◆ executeMultiple()

ilDBPdo::executeMultiple	(	ilDBStatement	$stmt,
		array	$data
	)

Parameters

ilDBStatement[] $stmt

Returns: string[]

Implements ilDBPdoInterface.

Definition at line 1433 of file class.ilDBPdo.php.

References ilDBInterface\execute().

                                                                      : array
     {
         foreach ($data as $set) {
             $this->execute($stmt, $set);
         }
         return [];
     }

Here is the call graph for this function:

◆ fetchAll()

ilDBPdo::fetchAll	(	ilDBStatement	$statement,
		int	$fetch_mode = `ilDBConstants::FETCHMODE_ASSOC`
	)

Implements ilDBInterface.

Definition at line 381 of file class.ilDBPdo.php.

References $data, and ilDBStatement\fetch().

                                                                                                       : array
     {
         $return = [];
         while ($data = $statement->fetch($fetch_mode)) {
             $return[] = $data;
         }
 
         return $return;
     }

Here is the call graph for this function:

◆ fetchAssoc()

ilDBPdo::fetchAssoc ( ilDBStatement $statement )

Implements ilDBInterface.

Definition at line 571 of file class.ilDBPdo.php.

References $res, and ilDBStatement\fetch().

Referenced by isFulltextIndex().

                                                         : ?array
     {
         $res = $statement->fetch(PDO::FETCH_ASSOC);
         if ($res === null || $res === false) {
             $statement->closeCursor();
 
             return null;
         }
 
         return $res;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fetchObject()

ilDBPdo::fetchObject ( ilDBStatement $query_result )

Implements ilDBInterface.

Definition at line 458 of file class.ilDBPdo.php.

References $res, and ilDBStatement\fetchObject().

Referenced by getDBVersion().

                                                             : ?stdClass
     {
         $res = $query_result->fetchObject();
         if ($res === null) {
             $query_result->closeCursor();
 
             return null;
         }
 
         return $res;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ foreignKeyExists()

ilDBPdo::foreignKeyExists	(	string	$foreign_key_name,
		string	$table_name
	)

Implements ilDBInterface.

Definition at line 1525 of file class.ilDBPdo.php.

                                                                                   : bool
     {
         return $this->manager->foreignKeyExists($foreign_key_name, $table_name);
     }

◆ free()

ilDBPdo::free ( ilDBStatement $a_st )

Implements ilDBInterface.

Definition at line 1155 of file class.ilDBPdo.php.

Referenced by update().

                                              : void
     {
         $a_st->closeCursor();
     }

Here is the caller graph for this function:

◆ fromUnixtime()

ilDBPdo::fromUnixtime	(	string	$expr,
		bool	$to_text = `true`
	)

Implements ilDBPdoInterface.

Definition at line 1441 of file class.ilDBPdo.php.

                                                                     : string
     {
         return "FROM_UNIXTIME(" . $expr . ")";
     }

◆ generateDSN()

ilDBPdo::generateDSN ( )

Definition at line 159 of file class.ilDBPdo.php.

References $charset, getCharset(), getDbname(), getHost(), and getPort().

Referenced by connect(), createDatabase(), and initFromIniFile().

     {
         $port = $this->getPort() !== 0 ? ";port=" . $this->getPort() : "";
         $dbname = $this->getDbname() !== '' ? ';dbname=' . $this->getDbname() : '';
         $host = $this->getHost();
         $charset = ';charset=' . $this->getCharset();
         $this->dsn = 'mysql:host=' . $host . $port . $dbname . $charset;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAdditionalAttributes()

ilDBPdo::getAdditionalAttributes ( )

protected

Definition at line 97 of file class.ilDBPdo.php.

Referenced by getAttributes().

                                                 : array
     {
         return array();
     }

Here is the caller graph for this function:

◆ getAllowedAttributes()

ilDBPdo::getAllowedAttributes ( )

Returns: string[]

Implements ilDBInterface.

Definition at line 1072 of file class.ilDBPdo.php.

                                           : array
     {
         return $this->field_definition->getAllowedAttributes();
     }

◆ getAttributes()

ilDBPdo::getAttributes ( )

protected

Definition at line 87 of file class.ilDBPdo.php.

References $attributes, $options, and getAdditionalAttributes().

Referenced by connect().

                                       : array
     {
         $options = $this->attributes;
         foreach ($this->getAdditionalAttributes() as $k => $v) {
             $options[$k] = $v;
         }
 
         return $options;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCharset()

ilDBPdo::getCharset ( )

Definition at line 903 of file class.ilDBPdo.php.

References $charset.

Referenced by generateDSN().

                                 : string
     {
         return $this->charset;
     }

Here is the caller graph for this function:

◆ getDbname()

ilDBPdo::getDbname ( )

Definition at line 893 of file class.ilDBPdo.php.

References $dbname.

Referenced by generateDSN().

                                : string
     {
         return $this->dbname;
     }

Here is the caller graph for this function:

◆ getDBType()

ilDBPdo::getDBType ( )

Get DSN.

This must be overwritten in DBMS specific class.

Implements ilDBInterface.

Definition at line 721 of file class.ilDBPdo.php.

References $db_type.

                                : string
     {
         return $this->db_type;
     }

◆ getDBVersion()

ilDBPdo::getDBVersion ( )

Exceptions

ilDatabaseException

Implements ilDBPdoInterface.

Definition at line 1455 of file class.ilDBPdo.php.

References Vendor\Package\$d, fetchObject(), and query().

                                   : string
     {
         $d = $this->fetchObject($this->query("SELECT VERSION() AS version"));
 
         if ($d !== null && $d->version) {
             return $d->version;
         }
         return 'Unknown';
     }

Here is the call graph for this function:

◆ getDSN()

ilDBPdo::getDSN ( )

Get DSN.

This must be overwritten in DBMS specific class.

Implements ilDBInterface.

Definition at line 716 of file class.ilDBPdo.php.

References $dsn.

Referenced by connect().

                             : string
     {
         return $this->dsn;
     }

Here is the caller graph for this function:

◆ getFieldDefinition()

ilDBPdo::getFieldDefinition ( )

Definition at line 102 of file class.ilDBPdo.php.

References $field_definition.

Referenced by checkIndexName().

                                         : ?\ilDBPdoFieldDefinition
     {
         return $this->field_definition;
     }

Here is the caller graph for this function:

◆ getHost()

ilDBPdo::getHost ( )

Definition at line 883 of file class.ilDBPdo.php.

References $host.

Referenced by generateDSN().

                              : string
     {
         return $this->host;
     }

Here is the caller graph for this function:

◆ getIndexName()

ilDBPdo::getIndexName ( string $index_name_base )

Definition at line 697 of file class.ilDBPdo.php.

References ilDBPdoFieldDefinition\INDEX_FORMAT.

                                                          : string
     {
         return sprintf(ilDBPdoFieldDefinition::INDEX_FORMAT, preg_replace('/[^a-z0-9_\$]/i', '_', $index_name_base));
     }

◆ getLastErrorCode()

ilDBPdo::getLastErrorCode ( )

Returns: string|int|null

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

References $error_code.

     {
         if ($this->pdo instanceof PDO) {
             return $this->pdo->errorCode();
         }
 
         return $this->error_code;
     }

◆ getLastInsertId()

ilDBPdo::getLastInsertId ( )

Implements ilDBPdoInterface.

Definition at line 1397 of file class.ilDBPdo.php.

                                      : int
     {
         return (int) $this->pdo->lastInsertId();
     }

◆ getPassword()

ilDBPdo::getPassword ( )

Definition at line 923 of file class.ilDBPdo.php.

References $password.

Referenced by connect().

                                  : string
     {
         return $this->password;
     }

Here is the caller graph for this function:

◆ getPort()

ilDBPdo::getPort ( )

Definition at line 933 of file class.ilDBPdo.php.

References $port.

Referenced by generateDSN().

                              : int
     {
         return $this->port;
     }

Here is the caller graph for this function:

◆ getPrimaryKeyIdentifier()

ilDBPdo::getPrimaryKeyIdentifier ( )

Implements ilDBInterface.

Definition at line 274 of file class.ilDBPdo.php.

Referenced by addPrimaryKey().

                                              : string
     {
         return "PRIMARY";
     }

Here is the caller graph for this function:

◆ getSequenceName()

ilDBPdo::getSequenceName ( string $table_name )

Implements ilDBInterface.

Definition at line 702 of file class.ilDBPdo.php.

References ilDBPdoFieldDefinition\SEQUENCE_FORMAT.

Referenced by ilDBPdoMySQL\nextId(), and renameTable().

                                                        : string
     {
         return sprintf(ilDBPdoFieldDefinition::SEQUENCE_FORMAT, preg_replace('/[^a-z0-9_\$.]/i', '_', $table_name));
     }

Here is the caller graph for this function:

◆ getServerVersion()

ilDBPdo::getServerVersion ( bool $native = false )

Implements ilDBPdoInterface.

Definition at line 1293 of file class.ilDBPdo.php.

                                                           : int
     {
         return $this->pdo->query('SELECT VERSION()')->fetchColumn();
     }

◆ getStorageEngine()

ilDBPdo::getStorageEngine ( )

Implements ilDBInterface.

Definition at line 1251 of file class.ilDBPdo.php.

References $storage_engine.

                                       : string
     {
         return $this->storage_engine;
     }

◆ getUsername()

ilDBPdo::getUsername ( )

Definition at line 913 of file class.ilDBPdo.php.

References $username.

Referenced by connect().

                                  : string
     {
         return $this->username;
     }

Here is the caller graph for this function:

◆ groupConcat()

ilDBPdo::groupConcat	(	string	$a_field_name,
		string	$a_seperator = `","`,
		?string	$a_order = `null`
	)

Implements ilDBInterface.

Definition at line 1495 of file class.ilDBPdo.php.

                                                                                                          : string
     {
         return $this->manager->getQueryUtils()->groupConcat($a_field_name, $a_seperator, $a_order);
     }

◆ in()

ilDBPdo::in	(	string	$field,
		array	$values,
		bool	$negate = `false`,
		string	$type = `""`
	)

Implements ilDBInterface.

Definition at line 770 of file class.ilDBPdo.php.

                                                                                              : string
     {
         return $this->manager->getQueryUtils()->in($field, $values, $negate, $type);
     }

◆ indexExistsByFields()

ilDBPdo::indexExistsByFields	(	string	$table_name,
		array	$fields
	)

Implements ilDBInterface.

Definition at line 623 of file class.ilDBPdo.php.

                                                                           : bool
     {
         foreach ($this->manager->listTableIndexes($table_name) as $idx_name) {
             $def = $this->reverse->getTableIndexDefinition($table_name, $idx_name);
             $idx_fields = array_keys($def['fields']);
 
             if ($idx_fields === $fields) {
                 return true;
             }
         }
 
         return false;
     }

◆ initFromIniFile()

ilDBPdo::initFromIniFile ( ?ilIniFile $ini = null )

Implements ilDBInterface.

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

References $DIC, $ini, generateDSN(), setDbname(), setDBType(), setHost(), setPassword(), setPort(), and setUsername().

                                                            : void
     {
         global $DIC;
 
         if ($ini instanceof ilIniFile) {
             $clientIniFile = $ini;
         } elseif ($DIC->offsetExists('ilClientIniFile')) {
             $clientIniFile = $DIC['ilClientIniFile'];
         } else {
             throw new InvalidArgumentException('$tmpClientIniFile is not an instance of ilIniFile');
         }
 
         $this->setUsername($clientIniFile->readVariable("db", "user"));
         $this->setHost($clientIniFile->readVariable("db", "host"));
         $this->setPort((int) $clientIniFile->readVariable("db", "port"));
         $this->setPassword((string) $clientIniFile->readVariable("db", "pass"));
         $this->setDbname($clientIniFile->readVariable("db", "name"));
         $this->setDBType($clientIniFile->readVariable("db", "type"));
 
         $this->generateDSN();
     }

Here is the call graph for this function:

◆ initHelpers()

ilDBPdo::initHelpers ( )

abstract

Referenced by connect().

Here is the caller graph for this function:

◆ initSQLMode()

ilDBPdo::initSQLMode ( )

protected

Definition at line 83 of file class.ilDBPdo.php.

Referenced by connect().

                                     : void
     {
     }

Here is the caller graph for this function:

◆ insert()

ilDBPdo::insert	(	string	$table_name,
		array	$values
	)

Returns: int The number of rows affected by the manipulation

Implements ilDBInterface.

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

References ILIAS\LTI\ToolProvider\$key, quote(), quoteIdentifier(), and sanitizeMB4StringIfNotSupported().

                                                              : int
     {
         $real = array();
         $fields = array();
         foreach ($values as $key => $val) {
             $real[] = $this->quote($val[1], $val[0]);
             $fields[] = $this->quoteIdentifier($key);
         }
         $values_string = implode(",", $real);
         $fields_string = implode(",", $fields);
         $query = "INSERT INTO " . $this->quoteIdentifier($table_name) . " (" . $fields_string . ") VALUES (" . $values_string . ")";
 
         $query = $this->sanitizeMB4StringIfNotSupported($query);
 
         return (int) $this->pdo->exec($query);
     }

Here is the call graph for this function:

◆ isFulltextIndex()

ilDBPdo::isFulltextIndex	(	string	$a_table,
		string	$a_name
	)

Is index a fulltext index?

Implements ilDBInterface.

Definition at line 685 of file class.ilDBPdo.php.

References fetchAssoc(), and query().

                                                                     : bool
     {
         $set = $this->query("SHOW INDEX FROM " . $a_table);
         while ($rec = $this->fetchAssoc($set)) {
             if ($rec["Key_name"] === $a_name && $rec["Index_type"] === "FULLTEXT") {
                 return true;
             }
         }
 
         return false;
     }

Here is the call graph for this function:

◆ isReservedWord()

static ilDBPdo::isReservedWord ( string $a_word )

static

Implements ilDBInterface.

Definition at line 1199 of file class.ilDBPdo.php.

References $DIC.

                                                          : bool
     {
         global $DIC;
         return (new ilDBPdoMySQLFieldDefinition($DIC->database()))->isReserved($a_word);
     }

◆ like()

ilDBPdo::like	(	string	$column,
		string	$type,
		string	$value = `"?"`,
		bool	$case_insensitive = `true`
	)

Exceptions

Implements ilDBInterface.

Definition at line 831 of file class.ilDBPdo.php.

                                                                                                           : string
     {
         return $this->manager->getQueryUtils()->like($column, $type, $value, $case_insensitive);
     }

◆ listSequences()

ilDBPdo::listSequences ( )

Returns: string[]

Implements ilDBInterface.

Definition at line 1082 of file class.ilDBPdo.php.

Referenced by sequenceExists().

                                    : array
     {
         return $this->manager->listSequences();
     }

Here is the caller graph for this function:

◆ listTables()

ilDBPdo::listTables ( )

Returns: int[]|string[]

Implements ilDBInterface.

Definition at line 1050 of file class.ilDBPdo.php.

Referenced by ilDBPdoMySQL\migrateAllTablesToEngine().

                                 : array
     {
         return $this->manager->listTables();
     }

Here is the caller graph for this function:

◆ loadModule()

ilDBPdo::loadModule ( string $module )

Returns: |

Implements ilDBInterface.

Definition at line 1058 of file class.ilDBPdo.php.

References $manager, $reverse, ilDBConstants\MODULE_MANAGER, and ilDBConstants\MODULE_REVERSE.

Referenced by dropTable(), ilDBPdoMySQL\migrateAllTablesToCollation(), and tableColumnExists().

     {
         switch ($module) {
             case ilDBConstants::MODULE_MANAGER:
                 return $this->manager;
             case ilDBConstants::MODULE_REVERSE:
                 return $this->reverse;
         }
         throw new LogicException('module "' . $module . '" not available');
     }

Here is the caller graph for this function:

◆ locate()

ilDBPdo::locate	(	string	$needle,
		string	$string,
		int	$start_pos = `1`
	)

Implements ilDBInterface.

Definition at line 1105 of file class.ilDBPdo.php.

                                                                               : string
     {
         return $this->manager->getQueryUtils()->locate($needle, $string, $start_pos);
     }

◆ lockTables()

ilDBPdo::lockTables ( array $tables )

Deprecated:: Use ilAtomQuery instead

Implements ilDBInterface.

Definition at line 754 of file class.ilDBPdo.php.

                                              : void
     {
         assert(is_array($tables));
         $lock = $this->manager->getQueryUtils()->lock($tables);
         $this->pdo->exec($lock);
     }

◆ lower()

ilDBPdo::lower ( string $expression )

Parameters

string $a_exp

Implements ilDBInterface.

Definition at line 974 of file class.ilDBPdo.php.

                                              : string
     {
         return " LOWER(" . $expression . ") ";
     }

◆ manipulate()

ilDBPdo::manipulate ( string $query )

Exceptions

ilDatabaseException

Implements ilDBInterface.

Definition at line 551 of file class.ilDBPdo.php.

References $DIC, Vendor\Package\$e, ILIAS\Repository\int(), and sanitizeMB4StringIfNotSupported().

Referenced by manipulateF().

                                              : int
     {
         global $DIC;
         $ilBench = $DIC['ilBench'] ?? null;
         try {
             $query = $this->sanitizeMB4StringIfNotSupported($query);
             if ($ilBench instanceof ilBenchmark) {
                 $ilBench->startDbBench($query);
             }
             $num_affected_rows = $this->pdo->exec($query);
             if ($ilBench instanceof ilBenchmark) {
                 $ilBench->stopDbBench();
             }
         } catch (PDOException $e) {
             throw new ilDatabaseException($e->getMessage() . ' QUERY: ' . $query, (int) $e->getCode());
         }
 
         return (int) $num_affected_rows;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ manipulateF()

ilDBPdo::manipulateF	(	string	$query,
		array	$types,
		array	$values
	)

Parameters

string[] $types

Exceptions

ilDatabaseException

Implements ilDBInterface.

Definition at line 797 of file class.ilDBPdo.php.

References manipulate(), and quote().

Referenced by replace(), and update().

                                                                            : int
     {
         if (!is_array($types) || !is_array($values) || count($types) !== count($values)) {
             throw new ilDatabaseException("ilDB::manipulateF: types and values must be arrays of same size. ($query)");
         }
         $quoted_values = array();
         foreach ($types as $k => $t) {
             $quoted_values[] = $this->quote($values[$k], $t);
         }
         $query = vsprintf($query, $quoted_values);
 
         return $this->manipulate($query);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ migrateAllTablesToCollation()

ilDBPdo::migrateAllTablesToCollation ( string $collation = ilDBConstants::MYSQL_COLLATION_UTF8MB4 )

Implements ilDBPdoInterface.

Definition at line 1316 of file class.ilDBPdo.php.

                                                                                                          : array
     {
         return array();
     }

◆ migrateAllTablesToEngine()

ilDBPdo::migrateAllTablesToEngine ( string $engine = ilDBConstants::MYSQL_ENGINE_INNODB )

Returns: array of failed tables

Implements ilDBPdoInterface.

Definition at line 1308 of file class.ilDBPdo.php.

                                                                                                : array
     {
         return array();
     }

◆ modifyTableColumn()

ilDBPdo::modifyTableColumn	(	string	$table,
		string	$column,
		array	$attributes
	)

Exceptions

Implements ilDBInterface.

Definition at line 1113 of file class.ilDBPdo.php.

References Vendor\Package\$a, $field_definition, and checkColumnDefinition().

                                                                                        : bool
     {
         $def = $this->reverse->getTableFieldDefinition($table, $column);
 
         $analyzer = new ilDBAnalyzer($this);
         $best_alt = $analyzer->getBestDefinitionAlternative($def);
         $def = $def[$best_alt];
         unset($def["nativetype"], $def["mdb2type"]);
 
         // check attributes
         $ilDBPdoFieldDefinition = $this->field_definition;
 
         $type = $attributes["type"] ?? $def["type"];
 
         foreach (array_keys($def) as $k) {
             if ($k !== "type" && !$ilDBPdoFieldDefinition->isAllowedAttribute($k, $type)) {
                 unset($def[$k]);
             }
         }
         $check_array = $def;
         foreach ($attributes as $k => $v) {
             $check_array[$k] = $v;
         }
         if (!$this->checkColumnDefinition($check_array, true)) {
             throw new ilDatabaseException("ilDB Error: modifyTableColumn(" . $table . ", " . $column . ")");
         }
 
         foreach ($attributes as $a => $v) {
             $def[$a] = $v;
         }
 
         $attributes["definition"] = $def;
 
         $changes = array(
             "change" => array(
                 $column => $attributes,
             ),
         );
 
         return $this->manager->alterTable($table, $changes, false);
     }

Here is the call graph for this function:

◆ nextId()

ilDBPdo::nextId ( string $table_name )

abstract

Parameters

$table_name string

Implements ilDBInterface.

Referenced by quoteIdentifier().

Here is the caller graph for this function:

◆ now()

ilDBPdo::now ( )

Returns: string the now statement

Implements ilDBInterface.

Definition at line 839 of file class.ilDBPdo.php.

Referenced by quote().

                          : string
     {
         return $this->manager->getQueryUtils()->now();
     }

Here is the caller graph for this function:

◆ numRows()

ilDBPdo::numRows ( ilDBStatement $statement )

Implements ilDBInterface.

Definition at line 583 of file class.ilDBPdo.php.

References ilDBStatement\rowCount().

                                                      : int
     {
         return $statement->rowCount();
     }

Here is the call graph for this function:

◆ prepare()

ilDBPdo::prepare	(	string	$query,
		?array	$types = `null`,
		?array	$result_types = `null`
	)

Definition at line 993 of file class.ilDBPdo.php.

                                                                                              : ilDBStatement
     {
         return new ilPDOStatement($this->pdo->prepare($query));
     }

◆ prepareManip()

ilDBPdo::prepareManip	(	string	$query,
		?array	$types = `null`
	)

Implements ilDBInterface.

Definition at line 988 of file class.ilDBPdo.php.

Referenced by update().

                                                                      : ilDBStatement
     {
         return new ilPDOStatement($this->pdo->prepare($query));
     }

Here is the caller graph for this function:

◆ primaryExistsByFields()

ilDBPdo::primaryExistsByFields	(	string	$table_name,
		array	$fields
	)

Implements ilDBInterface.

Definition at line 1535 of file class.ilDBPdo.php.

                                                                             : bool
     {
         $constraints = $this->manager->listTableConstraints($table_name);
 
         if (in_array('primary', $constraints)) {
             $definitions = $this->reverse->getTableConstraintDefinition($table_name, 'primary');
             $primary_fields = array_keys($definitions['fields']);
             sort($primary_fields);
             sort($fields);
 
             return $primary_fields === $fields;
         }
         return false;
     }

◆ query()

ilDBPdo::query ( string $query )

Exceptions

ilDatabaseException

Implements ilDBInterface.

Definition at line 352 of file class.ilDBPdo.php.

References $DIC, Vendor\Package\$e, $res, appendLimit(), and ILIAS\Repository\int().

Referenced by addFulltextIndex(), createDatabase(), dropFulltextIndex(), getDBVersion(), isFulltextIndex(), ilDBPdoMySQL\nextId(), and queryF().

                                         : ilDBStatement
     {
         global $DIC;
         $ilBench = $DIC['ilBench'] ?? null;
 
         $query = $this->appendLimit($query);
 
         try {
             if ($ilBench instanceof ilBenchmark) {
                 $ilBench->startDbBench($query);
             }
             $res = $this->pdo->query($query);
             if ($ilBench instanceof ilBenchmark) {
                 $ilBench->stopDbBench();
             }
         } catch (PDOException $e) {
             throw new ilDatabaseException($e->getMessage() . ' QUERY: ' . $query, (int) $e->getCode());
         }
 
         $err = $this->pdo->errorCode();
         if ($err !== PDO::ERR_NONE) {
             $info = $this->pdo->errorInfo();
             $info_message = $info[2];
             throw new ilDatabaseException($info_message . ' QUERY: ' . $query);
         }
 
         return new ilPDOStatement($res);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ queryCol()

ilDBPdo::queryCol	(	string	$query,
		int	$type = `PDO::FETCH_ASSOC`,
		int	$colnum = `0`
	)

Implements ilDBPdoInterface.

Definition at line 1256 of file class.ilDBPdo.php.

References ilDBConstants\FETCHMODE_ASSOC, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilDBPdoMySQL\migrateAllTablesToEngine().

                                                                                         : array
     {
         switch ($type) {
             case ilDBConstants::FETCHMODE_ASSOC:
                 $type = PDO::FETCH_ASSOC;
                 break;
             case ilDBConstants::FETCHMODE_OBJECT:
                 $type = PDO::FETCH_OBJ;
                 break;
             default:
                 $type = PDO::FETCH_ASSOC;
                 break;
         }
 
         return $this->pdo->query($query, PDO::FETCH_ASSOC)->fetchAll(PDO::FETCH_COLUMN, $colnum);
     }

Here is the caller graph for this function:

◆ queryF()

ilDBPdo::queryF	(	string	$query,
		array	$types,
		array	$values
	)

Parameters

string[] $types

Exceptions

Implements ilDBInterface.

Definition at line 779 of file class.ilDBPdo.php.

References query(), and quote().

                                                                       : ilDBStatement
     {
         if (!is_array($types) || !is_array($values) || count($types) !== count($values)) {
             throw new ilDatabaseException("ilDB::queryF: Types and values must be arrays of same size. ($query)");
         }
         $quoted_values = array();
         foreach ($types as $k => $t) {
             $quoted_values[] = $this->quote($values[$k], $t);
         }
         $query = vsprintf($query, $quoted_values);
 
         return $this->query($query);
     }

Here is the call graph for this function:

◆ queryRow()

ilDBPdo::queryRow	(	string	$query,
		?array	$types = `null`,
		int	$fetchmode = `ilDBConstants::FETCHMODE_DEFAULT`
	)

Implements ilDBPdoInterface.

Definition at line 1273 of file class.ilDBPdo.php.

References ilDBConstants\FETCHMODE_ASSOC, and ilDBConstants\FETCHMODE_OBJECT.

      : array {
         switch ($fetchmode) {
             case ilDBConstants::FETCHMODE_ASSOC:
                 $type = PDO::FETCH_ASSOC;
                 break;
             case ilDBConstants::FETCHMODE_OBJECT:
                 $type = PDO::FETCH_OBJ;
                 break;
             default:
                 $type = PDO::FETCH_ASSOC;
                 break;
         }
 
         return $this->pdo->query($query, $type)->fetch();
     }

◆ quote()

ilDBPdo::quote	(		$value,
		?string	$type = `null`
	)

Definition at line 588 of file class.ilDBPdo.php.

References ILIAS\Repository\int(), now(), ilDBConstants\T_DATE, ilDBConstants\T_DATETIME, ilDBConstants\T_FLOAT, ilDBConstants\T_INTEGER, ilDBConstants\T_TEXT, and ilDBConstants\T_TIMESTAMP.

Referenced by equals(), insert(), manipulateF(), queryF(), and update().

                                                        : string
     {
         if ($value === null) {
             return 'NULL';
         }
 
         $pdo_type = PDO::PARAM_STR;
         switch ($type) {
             case ilDBConstants::T_TIMESTAMP:
             case ilDBConstants::T_DATETIME:
             case ilDBConstants::T_DATE:
                 if ($value === '') {
                     return 'NULL';
                 }
                 if ($value === $this->now()) {
                     return $value;
                 }
                 $value = (string) $value;
                 break;
             case ilDBConstants::T_INTEGER:
                 return (string) (int) $value;
             case ilDBConstants::T_FLOAT:
                 $pdo_type = PDO::PARAM_INT;
                 $value = (string) $value;
                 break;
             case ilDBConstants::T_TEXT:
             default:
                 $value = (string) $value;
                 $pdo_type = PDO::PARAM_STR;
                 break;
         }
 
         return $this->pdo->quote((string) $value, $pdo_type);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ quoteIdentifier()

ilDBPdo::quoteIdentifier	(	string	$identifier,
		bool	$check_option = `false`
	)

Implements ilDBInterface.

Definition at line 168 of file class.ilDBPdo.php.

References ILIAS\Repository\int(), and nextId().

Referenced by ilDBPdoManager\createConstraint(), insert(), ilDBPdoMySQL\nextId(), replace(), and update().

                                                                                    : string
     {
         return '`' . preg_replace('/[^a-zA-Z0-9_$]/', '', $identifier) . '`';
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renameTable()

ilDBPdo::renameTable	(	string	$name,
		string	$new_name
	)

Exceptions

Implements ilDBInterface.

Definition at line 1163 of file class.ilDBPdo.php.

References Vendor\Package\$e, checkTableName(), getSequenceName(), and sequenceExists().

                                                                : bool
     {
         // check table name
         try {
             $this->checkTableName($new_name);
         } catch (ilDatabaseException $e) {
             throw new ilDatabaseException(
                 "ilDB Error: renameTable(" . $name . "," . $new_name . ")<br />" . $e->getMessage(),
                 $e->getCode()
             );
         }
 
         $this->manager->alterTable($name, ["name" => $new_name], false);
         if ($this->sequenceExists($name)) {
             $this->manager->alterTable(
                 $this->getSequenceName($name),
                 ["name" => $this->getSequenceName($new_name)],
                 false
             );
         }
         // The abstraction_progress is no longer used in ILIAS, see http://www.ilias.de/mantis/view.php?id=19513
         //              $query = "UPDATE abstraction_progress " . "SET table_name = " . $this->quote($a_new_name, 'text') . " " . "WHERE table_name = "
         //                       . $this->quote($a_name, 'text');
         //              $this->pdo->query($query);
 
         return true;
     }

Here is the call graph for this function:

◆ renameTableColumn()

ilDBPdo::renameTableColumn	(	string	$table_name,
		string	$column_old_name,
		string	$column_new_name
	)

Exceptions

Implements ilDBInterface.

Definition at line 414 of file class.ilDBPdo.php.

References Vendor\Package\$f, and checkColumnName().

                                                                                                            : bool
     {
         // check table name
         if (!$this->checkColumnName($column_new_name)) {
             throw new ilDatabaseException("ilDB Error: renameTableColumn(" . $table_name . "," . $column_old_name . "," . $column_new_name . ")");
         }
 
         $def = $this->reverse->getTableFieldDefinition($table_name, $column_old_name);
 
         $analyzer = new ilDBAnalyzer($this);
         $best_alt = $analyzer->getBestDefinitionAlternative($def);
         $def = $def[$best_alt];
         unset($def["nativetype"]);
         unset($def["mdb2type"]);
 
         $f["definition"] = $def;
         $f["name"] = $column_new_name;
 
         $changes = array(
             "rename" => array(
                 $column_old_name => $f,
             ),
         );
 
         return $this->manager->alterTable($table_name, $changes, false);
     }

Here is the call graph for this function:

◆ replace()

ilDBPdo::replace	(	string	$table,
		array	$primary_keys,
		array	$other_columns
	)

Replace into method.

Parameters

string	table name
array	primary key values: array("field1" => array("text", $name), "field2" => ...)
array	other values: array("field1" => array("text", $name), "field2" => ...)

Returns: int The number of rows affected by the manipulation

Implements ilDBInterface.

Definition at line 844 of file class.ilDBPdo.php.

References $q, ILIAS\Repository\int(), manipulateF(), and quoteIdentifier().

                                                                                      : int
     {
         $a_columns = array_merge($primary_keys, $other_columns);
         $fields = [];
         $placeholders = [];
         $types = [];
         $values = [];
 
         foreach ($a_columns as $k => $col) {
             $fields[] = $this->quoteIdentifier($k);
             $placeholders[] = "%s";
             $placeholders2[] = ":$k";
             $types[] = $col[0];
 
             // integer auto-typecast (this casts bool values to integer)
             if ($col[0] === 'integer' && !is_null($col[1])) {
                 $col[1] = (int) $col[1];
             }
 
             $values[] = $col[1];
         }
 
         $q = "REPLACE INTO " . $table . " (" . implode(",", $fields) . ") VALUES (" . implode(",", $placeholders) . ")";
 
         return $this->manipulateF($q, $types, $values);
     }

Here is the call graph for this function:

◆ rollback()

ilDBPdo::rollback ( )

Exceptions

Implements ilDBInterface.

Definition at line 1232 of file class.ilDBPdo.php.

References supports().

                               : bool
     {
         if (!$this->supports(self::FEATURE_TRANSACTIONS)) {
             throw new ilDatabaseException("ilDB::beginTransaction: Transactions are not supported.");
         }
 
         return $this->pdo->rollBack();
     }

Here is the call graph for this function:

◆ sanitizeMB4StringIfNotSupported()

ilDBPdo::sanitizeMB4StringIfNotSupported ( string $query )

Parameters

$query string to sanitize, all MB4-Characters like emojis will re replaced with ???

Returns: string sanitized query

Implements ilDBInterface.

Definition at line 1468 of file class.ilDBPdo.php.

References doesCollationSupportMB4Strings(), and ilDBConstants\MB4_REPLACEMENT.

Referenced by insert(), manipulate(), and update().

                                                                   : string
     {
         if (!$this->doesCollationSupportMB4Strings()) {
             $query_replaced = preg_replace(
                 '/[\x{10000}-\x{10FFFF}]/u',
                 ilDBConstants::MB4_REPLACEMENT,
                 $query
             );
             if (!empty($query_replaced)) {
                 return $query_replaced;
             }
         }
 
         return $query;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sequenceExists()

ilDBPdo::sequenceExists ( string $sequence )

Implements ilDBInterface.

Definition at line 1077 of file class.ilDBPdo.php.

References listSequences().

Referenced by ilDBPdoMySQL\migrateAllTablesToEngine(), ilDBPdoMySQL\migrateTableToEngine(), and renameTable().

                                                     : bool
     {
         return in_array($sequence, $this->listSequences(), true);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCharset()

ilDBPdo::setCharset ( string $charset )

Definition at line 908 of file class.ilDBPdo.php.

References $charset.

                                                : void
     {
         $this->charset = $charset;
     }

◆ setDBHost()

ilDBPdo::setDBHost ( string $host )

Implements ilDBInterface.

Definition at line 958 of file class.ilDBPdo.php.

References setHost().

                                            : void
     {
         $this->setHost($host);
     }

Here is the call graph for this function:

◆ setDbname()

ilDBPdo::setDbname ( string $dbname )

Definition at line 898 of file class.ilDBPdo.php.

References $dbname.

Referenced by createDatabase(), and initFromIniFile().

                                              : void
     {
         $this->dbname = $dbname;
     }

Here is the caller graph for this function:

◆ setDBPassword()

ilDBPdo::setDBPassword ( string $password )

Implements ilDBInterface.

Definition at line 953 of file class.ilDBPdo.php.

References setPassword().

                                                    : void
     {
         $this->setPassword($password);
     }

Here is the call graph for this function:

◆ setDBPort()

ilDBPdo::setDBPort ( int $port )

Implements ilDBInterface.

Definition at line 948 of file class.ilDBPdo.php.

References setPort().

                                         : void
     {
         $this->setPort($port);
     }

Here is the call graph for this function:

◆ setDBType()

ilDBPdo::setDBType ( string $type )

Definition at line 726 of file class.ilDBPdo.php.

References $DIC, $ilDB, and ilDBInterface\getReservedWords().

Referenced by initFromIniFile().

                                            : void
     {
         $this->db_type = $type;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDBUser()

ilDBPdo::setDBUser ( string $user )

Implements ilDBInterface.

Definition at line 943 of file class.ilDBPdo.php.

References setUsername().

                                            : void
     {
         $this->setUsername($user);
     }

Here is the call graph for this function:

◆ setFieldDefinition()

ilDBPdo::setFieldDefinition ( \ilDBPdoFieldDefinition $field_definition )

Definition at line 107 of file class.ilDBPdo.php.

References $field_definition.

                                                                                  : void
     {
         $this->field_definition = $field_definition;
     }

◆ setHost()

ilDBPdo::setHost ( string $host )

Definition at line 888 of file class.ilDBPdo.php.

References $host.

Referenced by initFromIniFile(), and setDBHost().

                                          : void
     {
         $this->host = $host;
     }

Here is the caller graph for this function:

◆ setLimit()

ilDBPdo::setLimit	(	int	$limit,
		int	$offset = `0`
	)

Set the Limit for the next Query.

Implements ilDBInterface.

Definition at line 822 of file class.ilDBPdo.php.

References $limit, and $offset.

                                                          : void
     {
         $this->limit = $limit;
         $this->offset = $offset;
     }

◆ setPassword()

ilDBPdo::setPassword ( string $password )

Definition at line 928 of file class.ilDBPdo.php.

References $password.

Referenced by initFromIniFile(), and setDBPassword().

                                                  : void
     {
         $this->password = $password;
     }

Here is the caller graph for this function:

◆ setPort()

ilDBPdo::setPort ( int $port )

Definition at line 938 of file class.ilDBPdo.php.

References $port.

Referenced by initFromIniFile(), and setDBPort().

                                       : void
     {
         $this->port = $port;
     }

Here is the caller graph for this function:

◆ setStorageEngine()

ilDBPdo::setStorageEngine ( string $storage_engine )

Implements ilDBInterface.

Definition at line 1246 of file class.ilDBPdo.php.

References $storage_engine.

                                                             : void
     {
         $this->storage_engine = $storage_engine;
     }

◆ setUsername()

ilDBPdo::setUsername ( string $username )

Definition at line 918 of file class.ilDBPdo.php.

References $username.

Referenced by initFromIniFile(), and setDBUser().

                                                  : void
     {
         $this->username = $username;
     }

Here is the caller graph for this function:

◆ substr()

ilDBPdo::substr	(	string	$a_exp,
		int	$a_pos = `1`,
		int	$a_len = `-1`
	)

Definition at line 979 of file class.ilDBPdo.php.

                                                                           : string
     {
         $lenstr = "";
         if ($a_len > -1) {
             $lenstr = ", " . $a_len;
         }
         return " SUBSTR(" . $a_exp . ", " . $a_pos . $lenstr . ") ";
     }

◆ supports()

ilDBPdo::supports ( string $feature )

Implements ilDBInterface.

Definition at line 1033 of file class.ilDBPdo.php.

References supportsFulltext(), supportsSlave(), and supportsTransactions().

Referenced by beginTransaction(), commit(), and rollback().

                                              : bool
     {
         switch ($feature) {
             case self::FEATURE_TRANSACTIONS:
                 return $this->supportsTransactions();
             case self::FEATURE_FULLTEXT:
                 return $this->supportsFulltext();
             case self::FEATURE_SLAVE:
                 return $this->supportsSlave();
             default:
                 return false;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ supportsCollationMigration()

ilDBPdo::supportsCollationMigration ( )

Implements ilDBPdoInterface.

Definition at line 1324 of file class.ilDBPdo.php.

                                                 : bool
     {
         return false;
     }

◆ supportsEngineMigration()

ilDBPdo::supportsEngineMigration ( )

Implements ilDBPdoInterface.

Definition at line 1329 of file class.ilDBPdo.php.

                                              : bool
     {
         return false;
     }

◆ supportsFulltext()

ilDBPdo::supportsFulltext ( )

Implements ilDBInterface.

Definition at line 1023 of file class.ilDBPdo.php.

Referenced by addIndex(), and supports().

                                       : bool
     {
         return false;
     }

Here is the caller graph for this function:

◆ supportsSlave()

ilDBPdo::supportsSlave ( )

Implements ilDBInterface.

Definition at line 1018 of file class.ilDBPdo.php.

Referenced by supports().

                                    : bool
     {
         return false;
     }

Here is the caller graph for this function:

◆ supportsTransactions()

ilDBPdo::supportsTransactions ( )

Implements ilDBInterface.

Definition at line 1028 of file class.ilDBPdo.php.

Referenced by supports().

                                           : bool
     {
         return false;
     }

Here is the caller graph for this function:

◆ tableColumnExists()

ilDBPdo::tableColumnExists	(	string	$table_name,
		string	$column_name
	)

Implements ilDBInterface.

Definition at line 295 of file class.ilDBPdo.php.

References loadModule(), and ilDBConstants\MODULE_MANAGER.

                                                                               : bool
     {
         $fields = $this->loadModule(ilDBConstants::MODULE_MANAGER)->listTableFields($table_name);
 
         return in_array($column_name, $fields, true);
     }

Here is the call graph for this function:

◆ tableExists()

ilDBPdo::tableExists ( string $table_name )

Implements ilDBInterface.

Definition at line 285 of file class.ilDBPdo.php.

                                                    : bool
     {
         $result = $this->pdo->prepare("SHOW TABLES LIKE :table_name");
         $result->execute(array('table_name' => $table_name));
         $return = $result->rowCount();
         $result->closeCursor();
 
         return $return > 0;
     }

◆ uniqueConstraintExists()

ilDBPdo::uniqueConstraintExists	(	string	$table,
		array	$fields
	)

Implements ilDBPdoInterface.

Definition at line 1407 of file class.ilDBPdo.php.

References Vendor\Package\$c, and Vendor\Package\$f.

                                                                         : bool
     {
         $analyzer = new ilDBAnalyzer();
         $cons = $analyzer->getConstraintsInformation($table);
         foreach ($cons as $c) {
             if ($c["type"] === "unique" && count($fields) === count($c["fields"])) {
                 $all_in = true;
                 foreach ($fields as $f) {
                     if (!isset($c["fields"][$f])) {
                         $all_in = false;
                     }
                 }
                 if ($all_in) {
                     return true;
                 }
             }
         }
 
         return false;
     }

◆ unixTimestamp()

ilDBPdo::unixTimestamp ( )

Implements ilDBPdoInterface.

Definition at line 1446 of file class.ilDBPdo.php.

                                    : string
     {
         return "UNIX_TIMESTAMP()";
     }

◆ unlockTables()

ilDBPdo::unlockTables ( )

Exceptions

Implements ilDBInterface.

Definition at line 765 of file class.ilDBPdo.php.

                                   : void
     {
         $this->pdo->exec($this->manager->getQueryUtils()->unlock());
     }

◆ update()

ilDBPdo::update	(	string	$table_name,
		array	$values,
		array	$where
	)

$where MUST contain existing columns only.

statements like [1 => ['integer', 1]] will not work, use a full query and

See also: manipulate() instead in that case.

Returns: int The number of rows affected by the manipulation

Implements ilDBInterface.

Definition at line 470 of file class.ilDBPdo.php.

References $q, $r, ilDBInterface\execute(), free(), ILIAS\Repository\int(), manipulateF(), prepareManip(), quote(), quoteIdentifier(), and sanitizeMB4StringIfNotSupported().

                                                                             : int
     {
         $fields = array();
         $field_values = array();
         $placeholders = array();
         $placeholders_full = array();
         $types = array();
         $values = array();
         $lobs = false;
         $lob = array();
         foreach ($columns as $k => $col) {
             $field_value = $col[1];
             $fields[] = $k;
             $placeholders[] = "%s";
             $placeholders_full[] = ":$k";
             $types[] = $col[0];
 
             if (($col[0] === "blob" || $col[0] === "clob" || $col[0] === 'text') && is_string($field_value)) {
                 $field_value = $this->sanitizeMB4StringIfNotSupported($field_value);
             }
 
             // integer auto-typecast (this casts bool values to integer)
             if ($col[0] === 'integer' && !is_null($field_value)) {
                 $field_value = (int) $field_value;
             }
 
             $values[] = $field_value;
             $field_values[$k] = $field_value;
             if ($col[0] === "blob" || $col[0] === "clob") {
                 $lobs = true;
             }
         }
 
         if ($lobs) {
             $q = "UPDATE " . $this->quoteIdentifier($table_name) . " SET ";
             $lim = "";
             foreach ($fields as $k => $field) {
                 $q .= $lim . $this->quoteIdentifier($field) . " = " . $placeholders_full[$k];
                 $lim = ", ";
             }
             $q .= " WHERE ";
             $lim = "";
             foreach ($where as $k => $col) {
                 $q .= $lim . $this->quoteIdentifier($k) . " = " . $this->quote($col[1], $col[0]);
                 $lim = " AND ";
             }
 
             $r = $this->prepareManip($q, $types);
             $this->execute($r, $field_values);
 
             $num_affected_rows = $r->rowCount();
 
             $this->free($r);
         } else {
             foreach ($where as $k => $col) {
                 $types[] = $col[0];
                 $values[] = $col[1];
                 $field_values[$k] = $col;
             }
             $q = "UPDATE " . $this->quoteIdentifier($table_name) . " SET ";
             $lim = "";
             foreach ($fields as $k => $field) {
                 $q .= $lim . $this->quoteIdentifier($field) . " = " . $placeholders[$k];
                 $lim = ", ";
             }
             $q .= " WHERE ";
             $lim = "";
             foreach (array_keys($where) as $k) {
                 $q .= $lim . $this->quoteIdentifier($k) . " = %s";
                 $lim = " AND ";
             }
 
             $num_affected_rows = $this->manipulateF($q, $types, $values);
         }
 
         return $num_affected_rows;
     }

Here is the call graph for this function:

◆ upper()

ilDBPdo::upper ( string $expression )

Parameters

string $a_exp

Implements ilDBInterface.

Definition at line 966 of file class.ilDBPdo.php.

                                              : string
     {
         return " UPPER(" . $expression . ") ";
     }

◆ useSlave()

ilDBPdo::useSlave ( bool $bool )

TODO.

Implements ilDBInterface.

Definition at line 814 of file class.ilDBPdo.php.

                                         : bool
     {
         return false;
     }

Field Documentation

◆ $attributes

array ilDBPdo::$attributes

protected

Initial value:

= array(
        
        PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION,
    )

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

Referenced by getAttributes().

◆ $charset

string ilDBPdo::$charset = 'utf8'

protected

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

Referenced by generateDSN(), getCharset(), and setCharset().

◆ $db_type

string ilDBPdo::$db_type = ''

protected

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

Referenced by getDBType().

◆ $dbname

string ilDBPdo::$dbname = ''

protected

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

Referenced by getDbname(), and setDbname().

◆ $dsn

string ilDBPdo::$dsn = ''

protected

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

Referenced by getDSN().

◆ $error_code

int ilDBPdo::$error_code = 0

protected

Definition at line 56 of file class.ilDBPdo.php.

Referenced by getLastErrorCode().

◆ $field_definition

ilDBPdoFieldDefinition ilDBPdo::$field_definition = null

protected

Definition at line 57 of file class.ilDBPdo.php.

Referenced by getFieldDefinition(), modifyTableColumn(), and setFieldDefinition().

◆ $host

string ilDBPdo::$host = ''

protected

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

Referenced by getHost(), and setHost().

◆ $limit

int ilDBPdo::$limit = null

protected

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

Referenced by appendLimit(), and setLimit().

◆ $manager

ilDBPdoManager ilDBPdo::$manager

protected

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

Referenced by addUniqueConstraint(), loadModule(), and ilDBPdoMySQL\migrateAllTablesToCollation().

◆ $offset

int ilDBPdo::$offset = null

protected

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

Referenced by setLimit().

◆ $options

array ilDBPdo::$options = []

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

Referenced by getAttributes().

◆ $password

string ilDBPdo::$password = ''

protected

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

Referenced by getPassword(), and setPassword().

◆ $pdo

PDO ilDBPdo::$pdo = null

protected

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

◆ $port

int ilDBPdo::$port = 3306

protected

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

Referenced by getPort(), and setPort().

◆ $reverse

ilDBPdoReverse ilDBPdo::$reverse

protected

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

Referenced by loadModule().

◆ $storage_engine

string ilDBPdo::$storage_engine = 'InnoDB'

protected

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

Referenced by getStorageEngine(), and setStorageEngine().

◆ $username

string ilDBPdo::$username = ''

protected

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

Referenced by getUsername(), and setUsername().

◆ FEATURE_FULLTEXT

const ilDBPdo::FEATURE_FULLTEXT = 'fulltext'

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

◆ FEATURE_SLAVE

const ilDBPdo::FEATURE_SLAVE = 'slave'

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

◆ FEATURE_TRANSACTIONS

const ilDBPdo::FEATURE_TRANSACTIONS = 'transactions'

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

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

Services/Database/classes/PDO/class.ilDBPdo.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ addForeignKey()

◆ addFulltextIndex()

◆ addIndex()

◆ addPrimaryKey()

◆ addTableColumn()

◆ addUniqueConstraint()

◆ appendLimit()

◆ beginTransaction()

◆ buildAtomQuery()

◆ buildIntegrityAnalyser()

◆ cast()

◆ checkColumn()

◆ checkColumnDefinition()

◆ checkColumnName()

◆ checkIndexName()

◆ checkTableColumns()

◆ checkTableName()

◆ commit()

◆ concat()

◆ connect()

◆ constraintName()

◆ createDatabase()

◆ createSequence()

◆ createTable()

◆ doesCollationSupportMB4Strings()

◆ dropForeignKey()

◆ dropFulltextIndex()

◆ dropIndex()

◆ dropIndexByFields()

◆ dropPrimaryKey()

◆ dropSequence()

◆ dropTable()

◆ dropTableColumn()

◆ dropUniqueConstraint()

◆ dropUniqueConstraintByFields()

◆ enableResultBuffering()

◆ equals()

◆ escape()

◆ escapePattern()

◆ executeMultiple()

◆ fetchAll()

◆ fetchAssoc()

◆ fetchObject()

◆ foreignKeyExists()

◆ free()

◆ fromUnixtime()

◆ generateDSN()

◆ getAdditionalAttributes()

◆ getAllowedAttributes()

◆ getAttributes()

◆ getCharset()

◆ getDbname()

◆ getDBType()

◆ getDBVersion()

◆ getDSN()

◆ getFieldDefinition()

◆ getHost()

◆ getIndexName()

◆ getLastErrorCode()

◆ getLastInsertId()

◆ getPassword()

◆ getPort()

◆ getPrimaryKeyIdentifier()

◆ getSequenceName()

◆ getServerVersion()

◆ getStorageEngine()

◆ getUsername()

◆ groupConcat()

◆ in()

◆ indexExistsByFields()

◆ initFromIniFile()

◆ initHelpers()

◆ initSQLMode()