This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilDBPdoManager:

Collaboration diagram for ilDBPdoManager:

Public Member Functions
	__construct (\PDO $pdo, 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=array())

	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)

Public Member Functions inherited from ilDBManager
	listTables (?string $database=null)

	listSequences (?string $database=null)

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

	listTableFields (string $table)

	listTableConstraints (string $table)

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

	listTableIndexes (string $table)

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

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

	dropIndex (string $table, string $name)

	dropSequence (string $seq_name)

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

	dropTable (string $name)

	getIndexName (string $idx)

	getSequenceName (string $sqn)

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

	fixIndexName (string $idx)

Protected Attributes
PDO	$pdo

ilDBPdo	$db_instance

ilQueryUtils	$query_utils = null

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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	(	\PDO	$pdo,
		ilDBPdo	$db_instance
	)

ilDBPdoManager constructor.

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

    {
        $this->pdo = $pdo;
        $this->db_instance = $db_instance;
    }

References $db_instance, and $pdo.

Member Function Documentation

◆ alterTable()

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

Exceptions

ilDatabaseException

Implements ilDBManager.

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

                                                                         : 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 = array();
        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);
    }

References $check, $db_instance, $name, and $query.

◆ createConstraint()

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

Exceptions

ilDatabaseException

Implements ilDBManager.

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

                                                                                    : 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 = array();
        foreach (array_keys($definition['fields']) as $field) {
            $fields[] = $db->quoteIdentifier($field, true);
        }
        $query .= ' (' . implode(', ', $fields) . ')';
 
        return (bool) $this->pdo->exec($query);
    }

References $db_instance, $name, $query, and ilDBPdo\quoteIdentifier().

Referenced by ilDBPdo\addUniqueConstraint().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createIndex()

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

Implements ilDBManager.

Definition at line 412 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 = array();
        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);
    }

References $name, and $query.

◆ createSequence()

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

Implements ilDBManager.

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

                                                                                         : 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 = array();
 
        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;
    }

References $query, $type, and ilDBConstants\SEQUENCE_COLUMNS_NAME.

◆ createTable()

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

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

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

References createTable(), and getQueryUtils().

Referenced by createTable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dropConstraint()

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

Implements ilDBManager.

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

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

References $name, $query, and getDBInstance().

Here is the call graph for this function:

◆ dropIndex()

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

Implements ilDBManager.

Definition at line 430 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");
    }

References $name.

◆ dropSequence()

ilDBPdoManager::dropSequence ( string $seq_name )

Implements ilDBManager.

Definition at line 438 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 467 of file class.ilDBPdoManager.php.

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

References $name, and getDBInstance().

Here is the call graph for this function:

◆ fixIndexName()

ilDBPdoManager::fixIndexName ( string $idx )

protected

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

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

References ilDBPdoFieldDefinition\INDEX_FORMAT.

Referenced by listTableConstraints(), and listTableIndexes().

Here is the caller graph for this function:

◆ fixSequenceName()

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

protected

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

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

References ilDBConstants\SEQUENCE_FORMAT.

Referenced by listSequences().

Here is the caller graph for this function:

◆ getDBInstance()

ilDBPdoManager::getDBInstance ( )

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

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

References $db_instance.

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

Here is the caller graph for this function:

◆ getIndexName()

ilDBPdoManager::getIndexName ( string $idx )

Implements ilDBPdoManagerInterface.

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

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

◆ getQueryUtils()

ilDBPdoManager::getQueryUtils ( )

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

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

References $query_utils.

Referenced by createTable(), and getTableCreationQuery().

Here is the caller graph for this function:

◆ getSequenceName()

ilDBPdoManager::getSequenceName ( string $sqn )

Implements ilDBPdoManagerInterface.

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

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

◆ getTableCreationQuery()

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

Exceptions

ilDatabaseException

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

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

References getQueryUtils().

Here is the call graph for this function:

◆ listSequences()

ilDBPdoManager::listSequences ( string $database = null )

Returns: string[]

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

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

References $query, $res, and fixSequenceName().

Here is the call graph for this function:

◆ listTableConstraints()

ilDBPdoManager::listTableConstraints ( string $table )

Returns: string[]

Implements ilDBManager.

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

                                                       : 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 = array();
        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);
    }

References $index, $query, fixIndexName(), and getDBInstance().

Here is the call graph for this function:

◆ listTableFields()

ilDBPdoManager::listTableFields ( string $table )

Returns: string[]

Implements ilDBManager.

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

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

References $data, and $query.

◆ listTableIndexes()

ilDBPdoManager::listTableIndexes ( string $table )

Returns: string[]

Implements ilDBManager.

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

                                                   : 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 = array();
        while ($index_data = $this->db_instance->fetchAssoc($result_set)) {
            $indexes[] = $index_data;
        }
        $result = array();
        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);
    }

References $index, $query, and fixIndexName().

Here is the call graph for this function:

◆ listTables()

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

Returns: int[]|string[]

Implements ilDBManager.

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

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

References $data.

Field Documentation

◆ $db_instance

ilDBPdo ilDBPdoManager::$db_instance

protected

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

Referenced by __construct(), alterTable(), createConstraint(), and getDBInstance().

◆ $pdo

PDO ilDBPdoManager::$pdo

protected

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

Referenced by __construct().

◆ $query_utils

ilQueryUtils ilDBPdoManager::$query_utils = null

protected

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

Referenced by getQueryUtils().

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

Services/Database/classes/PDO/Manager/class.ilDBPdoManager.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ alterTable()

◆ createConstraint()

◆ createIndex()

◆ createSequence()

◆ createTable()

◆ dropConstraint()

◆ dropIndex()

◆ dropSequence()

◆ dropTable()

◆ fixIndexName()

◆ fixSequenceName()

◆ getDBInstance()

◆ getIndexName()

◆ getQueryUtils()

◆ getSequenceName()

◆ getTableCreationQuery()

◆ listSequences()

◆ listTableConstraints()

◆ listTableFields()

◆ listTableIndexes()

◆ listTables()

Field Documentation

◆ $db_instance

◆ $pdo

◆ $query_utils