ilDBPdoManager Class Reference

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 ($database=null)
	listSequences ($database=null)
	createConstraint ($table, $name, $definition)
	createSequence ($seq_name, $start=1, $options=array())
	alterTable ($name, $changes, $check)
	createTable ($name, $fields, $options=array())
	getIndexName ($idx)
	getSequenceName ($sqn)
	listTableFields ($table)
	listTableConstraints ($table)
	listTableIndexes ($table)
	createIndex ($table, $name, $definition)
	dropIndex ($table, $name)
	dropSequence ($table_name)
	getTableCreationQuery ($name, $fields, $options=array())
	dropConstraint ($table, $name, $primary=false)
	dropTable ($name)
	Parameters $name Table-name Returns mixed More...

Protected Member Functions
	fixSequenceName ($sqn, $check=false)
	fixIndexName ($idx)

Protected Attributes
	$pdo
	$db_instance
	$query_utils

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 24 of file class.ilDBPdoManager.php.

Constructor & Destructor Documentation

__construct()

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

ilDBPdoManager constructor.

Parameters

\PDO	$pdo
\ilDBPdo	$db_instance

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

References $db_instance, and $pdo.

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

Member Function Documentation

alterTable()

ilDBPdoManager::alterTable	(		$name,
			$changes,
			$check
	)

Parameters

$name
$changes
$check

Returns

bool

Exceptions

Implements ilDBManager.

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

References $db_instance, $name, and $query.

Referenced by ilDBPdoManagerPostgres\dropDatabase().

    {
        $db = $this->db_instance;

        foreach ($changes as $change_name => $change) {
            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 .= ', ';
                }
                $query .= 'ADD ' . $db->getFieldDefinition()->getDeclaration($field['type'], $field_name, $field);
            }
        }

        if (!empty($changes['remove']) && is_array($changes['remove'])) {
            foreach ($changes['remove'] as $field_name => $field) {
                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);
                $query .= "CHANGE $old_field_name " . $this->db_instance->getFieldDefinition()
                                                                        ->getDeclaration($field['definition']['type'], $field_name, $field['definition']);
            }
        }

        if (!empty($rename) && is_array($rename)) {
            foreach ($rename as $rename_name => $renamed_field) {
                if ($query) {
                    $query .= ', ';
                }
                $field = $changes['rename'][$renamed_field];
                $renamed_field = $db->quoteIdentifier($renamed_field);
                $query .= 'CHANGE ' . $renamed_field . ' ' . $this->db_instance->getFieldDefinition()
                                                                               ->getDeclaration($field['definition']['type'], $field['name'], $field['definition']);
            }
        }

        if (!$query) {
            return true;
        }

        $name = $db->quoteIdentifier($name, true);

        $statement = "ALTER TABLE $name $query";

        return $this->pdo->exec($statement);
    }

Here is the caller graph for this function:

createConstraint()

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

Parameters

$table
$name
$definition

Returns

mixed

Exceptions

Implements ilDBManager.

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

References $db_instance, $name, and $query.

    {
        $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 $this->pdo->exec($query);
    }

createIndex()

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

Parameters

$table
$name
$definition

Returns

mixed

Implements ilDBManager.

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

References $name, and $query.

    {
        $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 $this->pdo->exec($query);
    }

createSequence()

ilDBPdoManager::createSequence	(		$seq_name,
			$start = 1,
			$options = array()
	)

Parameters

	$seq_name
int	$start
array	$options

Returns

bool

Implements ilDBManager.

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

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

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

createTable()

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

Parameters

	$name
	$fields
array	$options

Returns

int

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

References $name, and getQueryUtils().

    {
        $options['type'] = $this->db_instance->getStorageEngine();

        return $this->pdo->exec($this->getQueryUtils()->createTable($name, $fields, $options));
    }

Here is the call graph for this function:

dropConstraint()

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

Parameters

	$table
	$name
bool	$primary

Returns

int

Implements ilDBManager.

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

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

    {
        $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 $this->pdo->exec($query);
    }

Here is the call graph for this function:

dropIndex()

ilDBPdoManager::dropIndex	(		$table,
			$name
	)

Parameters

$table
$name

Returns

mixed

Implements ilDBManager.

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

References $name.

    {
        $table = $this->db_instance->quoteIdentifier($table, true);
        $name = $this->db_instance->quoteIdentifier($this->db_instance->getIndexName($name), true);

        return $this->pdo->exec("DROP INDEX $name ON $table");
    }

dropSequence()

ilDBPdoManager::dropSequence

(

$table_name

)

Parameters

$table_name

Returns

int

Implements ilDBManager.

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

    {
        $sequence_name = $this->db_instance->quoteIdentifier($this->db_instance->getSequenceName($table_name));

        return $this->pdo->exec("DROP TABLE $sequence_name");
    }

dropTable()

ilDBPdoManager::dropTable

(

$name

)

Parameters

$name

Table-name

Returns

mixed

Implements ilDBManager.

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

References $name, and getDBInstance().

    {
        $db = $this->getDBInstance();

        $name = $db->quoteIdentifier($name, true);

        return $db->manipulate("DROP TABLE $name");
    }

Here is the call graph for this function:

fixIndexName()

ilDBPdoManager::fixIndexName (   $idx )

protected

Parameters

$idx

Returns

mixed

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

References ilDBPdoFieldDefinition\INDEX_FORMAT.

Referenced by listTableConstraints(), and listTableIndexes().

    {
        $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 (   $sqn,   $check = false  )

protected

Parameters

	$sqn
bool	$check

Returns

bool|mixed

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

References ilDBConstants\SEQUENCE_FORMAT.

Referenced by listSequences(), and ilDBPdoManagerPostgres\listSequences().

    {
        $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;
        }
        if ($check) {
            return false;
        }

        return $sqn;
    }

Here is the caller graph for this function:

getDBInstance()

ilDBPdoManager::getDBInstance

(

)

Returns

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

References $db_instance.

Referenced by ilDBPdoManagerPostgres\dropConstraint(), dropConstraint(), ilDBPdoManagerPostgres\dropIndex(), dropTable(), and listTableConstraints().

    {
        return $this->db_instance;
    }

Here is the caller graph for this function:

getIndexName()

ilDBPdoManager::getIndexName

(

$idx

)

Parameters

$idx

Returns

string

Implements ilDBPdoManagerInterface.

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

Referenced by ilDBPdoManagerPostgres\dropConstraint(), ilDBPdoManagerPostgres\dropDatabase(), and ilDBPdoManagerPostgres\dropIndex().

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

Here is the caller graph for this function:

getQueryUtils()

ilDBPdoManager::getQueryUtils

(

)

Returns

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

References $query_utils.

Referenced by createTable(), and getTableCreationQuery().

    {
        if (!$this->query_utils) {
            $this->query_utils = new ilMySQLQueryUtils($this->db_instance);
        }

        return $this->query_utils;
    }

Here is the caller graph for this function:

getSequenceName()

ilDBPdoManager::getSequenceName

(

$sqn

)

Parameters

$sqn

Returns

string

Implements ilDBPdoManagerInterface.

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

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

getTableCreationQuery()

ilDBPdoManager::getTableCreationQuery	(		$name,
			$fields,
			$options = array()
	)

Parameters

	$name
	$fields
array	$options

Returns

string

Exceptions

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

References $name, and getQueryUtils().

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

Here is the call graph for this function:

listSequences()

ilDBPdoManager::listSequences

(

$database = null

)

Parameters

null

$database

Returns

array

Implements ilDBManager.

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

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

    {
        $query = "SHOW TABLES";
        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;
    }

Here is the call graph for this function:

listTableConstraints()

ilDBPdoManager::listTableConstraints

(

$table

)

Parameters

$table

Returns

array

Exceptions

Implements ilDBManager.

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

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

    {
        $key_name = 'Key_name';
        $non_unique = 'Non_unique';

        $db = $this->getDBInstance();
        if ($db->options['portability'] ?? false) {
            if (($db->options['field_case'] ?? null) == 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]) {
                if ($index_data[$key_name] !== 'PRIMARY') {
                    $index = $this->fixIndexName($index_data[$key_name]);
                } else {
                    $index = 'PRIMARY';
                }
                if (!empty($index)) {
                    $index = strtolower($index);
                    $result[$index] = true;
                }
            }
        }

        if ($this->db_instance->options['portability'] ?? false) {
            $result = array_change_key_case($result, $this->db_instance->options['field_case'] ?? null);
        }

        return array_keys($result);
    }

Here is the call graph for this function:

listTableFields()

ilDBPdoManager::listTableFields

(

$table

)

Parameters

$table

Returns

array

Exceptions

Implements ilDBManager.

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

References $data, $query, and $result.

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

listTableIndexes()

ilDBPdoManager::listTableIndexes

(

$table

)

Parameters

$table

Returns

array

Exceptions

Implements ilDBManager.

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

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

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

Here is the call graph for this function:

listTables()

ilDBPdoManager::listTables

(

$database = null

)

Parameters

null

$database

Returns

array

Implements ilDBManager.

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

References $data.

    {
        $str = 'SHOW TABLES ' . ($database ? ' IN ' . $database : '');
        $r = $this->pdo->query($str);
        $tables = array();

        $sequence_identifier = "_seq";
        while ($data = $r->fetchColumn()) {
            if (!preg_match("/{$sequence_identifier}$/um", $data)) {
                $tables[] = $data;
            }
        }

        return $tables;
    }

Field Documentation

$db_instance

ilDBPdoManager::$db_instance

protected

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

Referenced by __construct(), alterTable(), createConstraint(), ilDBPdoManagerPostgres\createDatabase(), ilDBPdoManagerPostgres\createSequence(), ilDBPdoManagerPostgres\dropDatabase(), ilDBPdoManagerPostgres\dropIndex(), ilDBPdoManagerPostgres\dropSequence(), getDBInstance(), ilDBPdoManagerPostgres\listSequences(), ilDBPdoManagerPostgres\listTableConstraints(), ilDBPdoManagerPostgres\listTableFields(), ilDBPdoManagerPostgres\listTableIndexes(), and ilDBPdoManagerPostgres\listTables().

$pdo

ilDBPdoManager::$pdo

protected

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

Referenced by __construct().

$query_utils

ilDBPdoManager::$query_utils

protected

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

Referenced by ilDBPdoManagerPostgres\getQueryUtils(), and getQueryUtils().

---

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

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