Inheritance diagram for ilDBPdoManager:

Collaboration diagram for ilDBPdoManager:

Public Member Functions
	__construct (protected \PDO $pdo, protected \ilDBPdo $db_instance)
	ilDBPdoManager constructor. More...

	getQueryUtils ()

	getDBInstance ()

	listTables (?string $database=null)

	listSequences (?string $database=null)

	createConstraint (string $table, string $name, array $definition)

	createSequence (string $seq_name, int $start=1, array $options=[])

	alterTable (string $name, array $changes, bool $check)

	createTable (string $name, array $fields, array $options=[])

	getIndexName (string $idx)

	getSequenceName (string $sqn)

	listTableFields (string $table)

	listTableConstraints (string $table)

	listTableIndexes (string $table)

	createIndex (string $table, string $name, array $definition)

	dropIndex (string $table, string $name)

	dropSequence (string $seq_name)

	getTableCreationQuery (string $name, array $fields, array $options=[])

	dropConstraint (string $table, string $name, bool $primary=false)

	dropTable (string $name)

	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)

Protected Member Functions
	fixSequenceName (string $sqn, bool $check=false)

	fixIndexName (string $idx)

Protected Attributes
ilQueryUtils	$query_utils = null

Detailed Description

Class ilDBPdoManager.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilDBPdoManager::__construct	(	protected \PDO	$pdo,
		protected \ilDBPdo	$db_instance
	)

ilDBPdoManager constructor.

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

33 {

34 }

Member Function Documentation

◆ addForeignKey()

ilDBPdoManager::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

Definition at line 476 of file class.ilDBPdoManager.php.

References null.

      : bool {
         $table = $this->db_instance->quoteIdentifier($table_name, true);
         $reference_table = $this->db_instance->quoteIdentifier($reference_table, true);
         $field_names = implode(",", $field_names);
         $field_names = $this->db_instance->quoteIdentifier($field_names, true);
         $reference_field_names = implode(",", $reference_field_names);
         $reference_field_names = $this->db_instance->quoteIdentifier($reference_field_names, true);
         $foreign_key_name = $this->db_instance->quoteIdentifier($foreign_key_name, true);
         $update = '';
         if ($on_update !== null) {
             $on_update = $on_update->value;
             $update = "ON UPDATE $on_update";
         }
         $delete = '';
         if ($on_delete !== null) {
             $on_delete = $on_delete->value;
             $delete = "ON DELETE $on_delete";
         }
         $query = "ALTER TABLE
                     $table ADD CONSTRAINT
                     $foreign_key_name FOREIGN KEY ($field_names)
                     REFERENCES $reference_table ($reference_field_names)
                     $update
                     $delete
                     ";
 
         return (bool) $this->pdo->exec($query);
     }

◆ alterTable()

ilDBPdoManager::alterTable	(	string	$name,
		array	$changes,
		bool	$check
	)

Exceptions

Implements ilDBManager.

Definition at line 179 of file class.ilDBPdoManager.php.

References null.

                                                                          : bool
     {
         $db = $this->db_instance;
 
         foreach (array_keys($changes) as $change_name) {
             switch ($change_name) {
                 case 'add':
                 case 'remove':
                 case 'change':
                 case 'rename':
                 case 'name':
                     break;
                 default:
                     throw new ilDatabaseException('change type "' . $change_name . '" not yet supported');
             }
         }
 
         if ($check) {
             return true;
         }
 
         $query = '';
         if (!empty($changes['name'])) {
             $change_name = $db->quoteIdentifier($changes['name']);
             $query .= 'RENAME TO ' . $change_name;
         }
 
         if (!empty($changes['add']) && is_array($changes['add'])) {
             foreach ($changes['add'] as $field_name => $field) {
                 if ($query !== '') {
                     $query .= ', ';
                 }
                 $fd = $db->getFieldDefinition();
                 if ($fd !== null) {
                     $query .= 'ADD ' . $fd->getDeclaration($field['type'], $field_name, $field);
                 }
             }
         }
 
         if (!empty($changes['remove']) && is_array($changes['remove'])) {
             foreach (array_keys($changes['remove']) as $field_name) {
                 if ($query !== '') {
                     $query .= ', ';
                 }
                 $field_name = $db->quoteIdentifier($field_name);
                 $query .= 'DROP ' . $field_name;
             }
         }
 
         $rename = [];
         if (!empty($changes['rename']) && is_array($changes['rename'])) {
             foreach ($changes['rename'] as $field_name => $field) {
                 $rename[$field['name']] = $field_name;
             }
         }
 
         if (!empty($changes['change']) && is_array($changes['change'])) {
             foreach ($changes['change'] as $field_name => $field) {
                 if ($query !== '') {
                     $query .= ', ';
                 }
                 if (isset($rename[$field_name])) {
                     $old_field_name = $rename[$field_name];
                     unset($rename[$field_name]);
                 } else {
                     $old_field_name = $field_name;
                 }
                 $old_field_name = $db->quoteIdentifier($old_field_name);
                 $fd = $this->db_instance->getFieldDefinition();
                 if ($fd !== null) {
                     $query .= "CHANGE $old_field_name " . $fd
                             ->getDeclaration(
                                 $field['definition']['type'],
                                 $field_name,
                                 $field['definition']
                             );
                 }
             }
         }
 
         if (!empty($rename) && is_array($rename)) {
             foreach ($rename as $renamed_field) {
                 if ($query !== '') {
                     $query .= ', ';
                 }
                 $field = $changes['rename'][$renamed_field];
                 $renamed_field = $db->quoteIdentifier($renamed_field);
                 $fd = $this->db_instance->getFieldDefinition();
                 if ($fd !== null) {
                     $query .= 'CHANGE ' . $renamed_field . ' ' . $fd
                             ->getDeclaration(
                                 $field['definition']['type'],
                                 $field['name'],
                                 $field['definition']
                             );
                 }
             }
         }
 
         if ($query === '') {
             return true;
         }
 
         $name = $db->quoteIdentifier($name, true);
 
         $statement = "ALTER TABLE $name $query";
 
         return (bool) $this->pdo->exec($statement);
     }

◆ createConstraint()

ilDBPdoManager::createConstraint	(	string	$table,
		string	$name,
		array	$definition
	)

Exceptions

Implements ilDBManager.

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

Referenced by ilDBPdo\addUniqueConstraint().

                                                                                     : bool
     {
         $db = $this->db_instance;
 
         $table = $db->quoteIdentifier($table, true);
         $name = $db->quoteIdentifier($db->getIndexName($name), true);
         $query = "ALTER TABLE $table ADD CONSTRAINT $name";
         if (!empty($definition['primary'])) {
             $query .= ' PRIMARY KEY';
         } elseif (!empty($definition['unique'])) {
             $query .= ' UNIQUE';
         }
         $fields = [];
         foreach (array_keys($definition['fields']) as $field) {
             $fields[] = $db->quoteIdentifier($field, true);
         }
         $query .= ' (' . implode(', ', $fields) . ')';
 
         return (bool) $this->pdo->exec($query);
     }

Here is the caller graph for this function:

◆ createIndex()

ilDBPdoManager::createIndex	(	string	$table,
		string	$name,
		array	$definition
	)

Implements ilDBManager.

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

                                                                                : bool
     {
         $table = $this->db_instance->quoteIdentifier($table, true);
         $name = $this->db_instance->quoteIdentifier($this->db_instance->getIndexName($name), true);
         $query = "CREATE INDEX $name ON $table";
         $fields = [];
         foreach ($definition['fields'] as $field => $fieldinfo) {
             if (!empty($fieldinfo['length'])) {
                 $fields[] = $this->db_instance->quoteIdentifier($field, true) . '(' . $fieldinfo['length'] . ')';
             } else {
                 $fields[] = $this->db_instance->quoteIdentifier($field, true);
             }
         }
         $query .= ' (' . implode(', ', $fields) . ')';
 
         return (bool) $this->pdo->exec($query);
     }

◆ createSequence()

ilDBPdoManager::createSequence	(	string	$seq_name,
		int	$start = `1`,
		array	$options = `[]`
	)

Implements ilDBManager.

Definition at line 133 of file class.ilDBPdoManager.php.

References ilDBConstants\SEQUENCE_COLUMNS_NAME.

                                                                                          : bool
     {
         $sequence_name = $this->db_instance->quoteIdentifier($this->db_instance->getSequenceName($seq_name));
         $seqcol_name = $this->db_instance->quoteIdentifier(ilDBConstants::SEQUENCE_COLUMNS_NAME);
 
         $options_strings = [];
 
         if (!empty($options['comment'])) {
             $options_strings['comment'] = 'COMMENT = ' . $this->db_instance->quote($options['comment'], 'text');
         }
 
         if (!empty($options['charset'])) {
             $options_strings['charset'] = 'DEFAULT CHARACTER SET ' . $options['charset'];
             if (!empty($options['collate'])) {
                 $options_strings['charset'] .= ' COLLATE ' . $options['collate'];
             }
         }
 
         $type = false;
         if (!empty($options['type'])) {
             $type = $options['type'];
         }
         if ($type) {
             $options_strings[] = "ENGINE = $type";
         }
 
         $query = "CREATE TABLE $sequence_name ($seqcol_name INT NOT NULL AUTO_INCREMENT, PRIMARY KEY ($seqcol_name))";
 
         if (!empty($options_strings)) {
             $query .= ' ' . implode(' ', $options_strings);
         }
         $this->pdo->exec($query);
 
         if ($start == 1) {
             return true;
         }
 
         $query = "INSERT INTO $sequence_name ($seqcol_name) VALUES (" . ($start - 1) . ')';
         $this->pdo->exec($query);
 
         return true;
     }

◆ createTable()

ilDBPdoManager::createTable	(	string	$name,
		array	$fields,
		array	$options = `[]`
	)

Definition at line 289 of file class.ilDBPdoManager.php.

References getQueryUtils().

                                                                                  : bool
     {
         $options['type'] = $this->db_instance->getStorageEngine();
 
         return (bool) $this->pdo->exec($this->getQueryUtils()->createTable($name, $fields, $options));
     }

Here is the call graph for this function:

◆ dropConstraint()

ilDBPdoManager::dropConstraint	(	string	$table,
		string	$name,
		bool	$primary = `false`
	)

Implements ilDBManager.

Definition at line 450 of file class.ilDBPdoManager.php.

References getDBInstance().

                                                                                       : bool
     {
         $db = $this->getDBInstance();
         $table = $db->quoteIdentifier($table, true);
         if ($primary || strtolower($name) === 'primary') {
             $query = "ALTER TABLE $table DROP PRIMARY KEY";
         } else {
             $name = $db->quoteIdentifier($db->getIndexName($name), true);
             $query = "ALTER TABLE $table DROP INDEX $name";
         }
 
         return (bool) $this->pdo->exec($query);
     }

Here is the call graph for this function:

◆ dropForeignKey()

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

Definition at line 513 of file class.ilDBPdoManager.php.

                                                                                 : bool
     {
         $table = $this->db_instance->quoteIdentifier($table_name, true);
         $name = $this->db_instance->quoteIdentifier($foreign_key_name, true);
         $query = "ALTER TABLE $table DROP FOREIGN KEY $name;";
 
         return (bool) $this->pdo->exec($query);
     }

◆ dropIndex()

ilDBPdoManager::dropIndex	(	string	$table,
		string	$name
	)

Implements ilDBManager.

Definition at line 427 of file class.ilDBPdoManager.php.

                                                           : bool
     {
         $table = $this->db_instance->quoteIdentifier($table, true);
         $name = $this->db_instance->quoteIdentifier($this->db_instance->getIndexName($name), true);
 
         return (bool) $this->pdo->exec("DROP INDEX $name ON $table");
     }

◆ dropSequence()

ilDBPdoManager::dropSequence ( string $seq_name )

Implements ilDBManager.

Definition at line 435 of file class.ilDBPdoManager.php.

                                                   : bool
     {
         $sequence_name = $this->db_instance->quoteIdentifier($this->db_instance->getSequenceName($seq_name));
 
         return (bool) $this->pdo->exec("DROP TABLE $sequence_name");
     }

◆ dropTable()

ilDBPdoManager::dropTable ( string $name )

Parameters

$name string

Implements ilDBManager.

Definition at line 464 of file class.ilDBPdoManager.php.

References getDBInstance().

                                            : bool
     {
         $db = $this->getDBInstance();
         $name = $db->quoteIdentifier($name, true);
 
         return (bool) $this->pdo->exec("DROP TABLE $name");
     }

Here is the call graph for this function:

◆ fixIndexName()

ilDBPdoManager::fixIndexName ( string $idx )

protected

Definition at line 398 of file class.ilDBPdoManager.php.

References ilDBPdoFieldDefinition\INDEX_FORMAT.

Referenced by listTableConstraints(), and listTableIndexes().

                                                 : string
     {
         $idx_pattern = '/^' . preg_replace('/%s/', '([a-z0-9_]+)', ilDBPdoFieldDefinition::INDEX_FORMAT) . '$/i';
         $idx_name = preg_replace($idx_pattern, '\\1', $idx);
         if ($idx_name && !strcasecmp($idx, $this->db_instance->getIndexName($idx_name))) {
             return $idx_name;
         }
 
         return $idx;
     }

Here is the caller graph for this function:

◆ fixSequenceName()

ilDBPdoManager::fixSequenceName	(	string	$sqn,
		bool	$check = `false`
	)

protected

Definition at line 69 of file class.ilDBPdoManager.php.

References ilDBConstants\SEQUENCE_FORMAT.

Referenced by listSequences().

                                                                         : string
     {
         $seq_pattern = '/^' . preg_replace('/%s/', '([a-z0-9_]+)', ilDBConstants::SEQUENCE_FORMAT) . '$/i';
         $seq_name = preg_replace($seq_pattern, '\\1', $sqn);
         if ($seq_name && !strcasecmp($sqn, $this->db_instance->getSequenceName($seq_name))) {
             return $seq_name;
         }
 
         return $sqn;
     }

Here is the caller graph for this function:

◆ foreignKeyExists()

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

Definition at line 522 of file class.ilDBPdoManager.php.

                                                                                   : bool
     {
         $query = "SELECT * FROM INFORMATION_SCHEMA.TABLE_CONSTRAINTS WHERE CONSTRAINT_TYPE='FOREIGN KEY';";
         $result_set = $this->db_instance->query($query);
         while ($foreign_data = $this->db_instance->fetchAssoc($result_set)) {
             if (array_key_exists(
                 'CONSTRAINT_NAME',
                 $foreign_data
             ) && $foreign_data['CONSTRAINT_NAME'] === $foreign_key_name) {
                 return true;
             }
         }
         return false;
     }

◆ getDBInstance()

ilDBPdoManager::getDBInstance ( )

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

Referenced by dropConstraint(), dropTable(), and listTableConstraints().

                                    : \ilDBPdo
     {
         return $this->db_instance;
     }

Here is the caller graph for this function:

◆ getIndexName()

ilDBPdoManager::getIndexName ( string $idx )

Implements ilDBPdoManagerInterface.

Definition at line 296 of file class.ilDBPdoManager.php.

                                              : string
     {
         return $this->db_instance->getIndexName($idx);
     }

◆ getQueryUtils()

ilDBPdoManager::getQueryUtils ( )

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

References $query_utils, and null.

Referenced by createTable(), and getTableCreationQuery().

                                    : \ilQueryUtils
     {
         if ($this->query_utils === null) {
             $this->query_utils = new ilMySQLQueryUtils($this->db_instance);
         }
 
         return $this->query_utils;
     }

Here is the caller graph for this function:

◆ getSequenceName()

ilDBPdoManager::getSequenceName ( string $sqn )

Implements ilDBPdoManagerInterface.

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

                                                 : string
     {
         return $this->db_instance->getSequenceName($sqn);
     }

◆ getTableCreationQuery()

ilDBPdoManager::getTableCreationQuery	(	string	$name,
		array	$fields,
		array	$options = `[]`
	)

Exceptions

Definition at line 445 of file class.ilDBPdoManager.php.

References getQueryUtils().

                                                                                            : string
     {
         return $this->getQueryUtils()->createTable($name, $fields, $options);
     }

Here is the call graph for this function:

◆ listSequences()

ilDBPdoManager::listSequences ( ?string $database = null )

Returns: string[]

Implements ilDBManager.

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

References $res, fixSequenceName(), and null.

                                                            : array
     {
         $query = "SHOW TABLES LIKE '%_seq'";
         if (!is_null($database)) {
             $query .= " FROM $database";
         }
 
         $res = $this->db_instance->query($query);
 
         $result = [];
         while ($table_name = $this->db_instance->fetchAssoc($res)) {
             $sqn = $this->fixSequenceName(reset($table_name), true);
             if ($sqn !== '' && $sqn !== '0') {
                 $result[] = $sqn;
             }
         }
         if ($this->db_instance->options['portability'] ?? null) {
             return array_map(
                 ($this->db_instance->options['field_case'] === CASE_LOWER ? 'strtolower' : 'strtoupper'),
                 $result
             );
         }
 
         return $result;
     }

Here is the call graph for this function:

◆ listTableConstraints()

ilDBPdoManager::listTableConstraints ( string $table )

Returns: string[]

Implements ilDBManager.

Definition at line 322 of file class.ilDBPdoManager.php.

References fixIndexName(), getDBInstance(), and null.

                                                        : array
     {
         $key_name = 'Key_name';
         $non_unique = 'Non_unique';
 
         $db = $this->getDBInstance();
         if ($db->options['portability'] ?? null) {
             if ($db->options['field_case'] == CASE_LOWER) {
                 $key_name = strtolower($key_name);
                 $non_unique = strtolower($non_unique);
             } else {
                 $key_name = strtoupper($key_name);
                 $non_unique = strtoupper($non_unique);
             }
         }
 
         $table = $this->db_instance->quoteIdentifier($table);
         $query = "SHOW INDEX FROM $table";
         $result_set = $this->db_instance->query($query);
 
         $result = [];
         while ($index_data = $this->db_instance->fetchAssoc($result_set)) {
             if (!$index_data[$non_unique]) {
                 $index = $index_data[$key_name] !== 'PRIMARY' ? $this->fixIndexName($index_data[$key_name]) : 'PRIMARY';
                 if (!empty($index)) {
                     $index = strtolower($index);
                     $result[$index] = true;
                 }
             }
         }
 
         if ($this->db_instance->options['portability'] ?? null) {
             $result = array_change_key_case($result, $this->db_instance->options['field_case']);
         }
 
         return array_keys($result);
     }

Here is the call graph for this function:

◆ listTableFields()

ilDBPdoManager::listTableFields ( string $table )

Returns: string[]

Implements ilDBManager.

Definition at line 306 of file class.ilDBPdoManager.php.

References $data.

                                                   : array
     {
         $table = $this->db_instance->quoteIdentifier($table);
         $query = "SHOW COLUMNS FROM $table";
         $result = $this->db_instance->query($query);
         $return = [];
         while ($data = $this->db_instance->fetchObject($result)) {
             $return[] = $data->Field;
         }
 
         return $return;
     }

◆ listTableIndexes()

ilDBPdoManager::listTableIndexes ( string $table )

Returns: string[]

Implements ilDBManager.

Definition at line 363 of file class.ilDBPdoManager.php.

References fixIndexName(), and null.

                                                    : array
     {
         $key_name = 'Key_name';
         $non_unique = 'Non_unique';
         if ($this->db_instance->options['portability'] ?? null) {
             if ($this->db_instance->options['field_case'] == CASE_LOWER) {
                 $key_name = strtolower($key_name);
                 $non_unique = strtolower($non_unique);
             } else {
                 $key_name = strtoupper($key_name);
                 $non_unique = strtoupper($non_unique);
             }
         }
 
         $table = $this->db_instance->quoteIdentifier($table);
         $query = "SHOW INDEX FROM $table";
         $result_set = $this->db_instance->query($query);
         $indexes = [];
         while ($index_data = $this->db_instance->fetchAssoc($result_set)) {
             $indexes[] = $index_data;
         }
         $result = [];
         foreach ($indexes as $index_data) {
             if ($index_data[$non_unique] && ($index = $this->fixIndexName($index_data[$key_name]))) {
                 $result[$index] = true;
             }
         }
 
         if ($this->db_instance->options['portability'] ?? null) {
             $result = array_change_key_case($result, $this->db_instance->options['field_case']);
         }
 
         return array_keys($result);
     }

Here is the call graph for this function:

◆ listTables()

ilDBPdoManager::listTables ( ?string $database = null )

Returns: int[]|string[]

Implements ilDBManager.

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

References $data, and $r.

Referenced by ilDBPdoMySQL\migrateAllTablesToCollation().

                                                         : array
     {
         $str = 'SHOW TABLES ' . ($database ? ' IN ' . $database : '');
         $r = $this->pdo->query($str);
         $tables = [];
 
         $sequence_identifier = "_seq";
         while ($data = $r->fetchColumn()) {
             if (!preg_match("/$sequence_identifier$/um", $data)) {
                 $tables[] = $data;
             }
         }
 
         return $tables;
     }

Here is the caller graph for this function:

Field Documentation

◆ $query_utils

ilQueryUtils ilDBPdoManager::$query_utils = null

protected

Definition at line 27 of file class.ilDBPdoManager.php.

Referenced by getQueryUtils().

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

components/ILIAS/Database/classes/PDO/Manager/class.ilDBPdoManager.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addForeignKey()

◆ alterTable()

◆ createConstraint()

◆ createIndex()

◆ createSequence()

◆ createTable()

◆ dropConstraint()

◆ dropForeignKey()

◆ dropIndex()

◆ dropSequence()

◆ dropTable()

◆ fixIndexName()

◆ fixSequenceName()

◆ foreignKeyExists()

◆ getDBInstance()

◆ getIndexName()

◆ getQueryUtils()

◆ getSequenceName()

◆ getTableCreationQuery()

◆ listSequences()

◆ listTableConstraints()

◆ listTableFields()

◆ listTableIndexes()

◆ listTables()

Field Documentation

◆ $query_utils