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

Collaboration diagram for ilDBPdoReverse:

Public Member Functions
	__construct (\PDO $pdo, ilDBPdo $db_instance)
	ilDBPdoReverse constructor. More...
	getQueryUtils ()
	getTableFieldDefinition (string $table_name, string $field_name)
	getTableIndexDefinition (string $table, string $constraint_name)
	getTableConstraintDefinition (string $table, string $index_name)
	getTriggerDefinition (string $trigger)
	getTableFieldDefinition (string $table_name, string $field_name)
	getTableIndexDefinition (string $table, string $constraint_name)
	getTableConstraintDefinition (string $table, string $index_name)
	getTriggerDefinition (string $trigger)

Protected Attributes
PDO	$pdo
ilDBPdo	$db_instance
ilMySQLQueryUtils	$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 ilDBPdoReverse

Author

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

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

Constructor & Destructor Documentation

__construct()

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

ilDBPdoReverse constructor.

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

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

References $db_instance, and $pdo.

Member Function Documentation

getQueryUtils()

ilDBPdoReverse::getQueryUtils

(

)

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

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

References $query_utils.

getTableConstraintDefinition()

ilDBPdoReverse::getTableConstraintDefinition	(	string	$table,
		string	$index_name
	)

Returns

array<string, array<int|string, array<string, string|int>>&array>|array<string, bool>

Exceptions

ilDatabaseException

Implements ilDBReverse.

Definition at line 172 of file class.ilDBPdoReverse.php.

                                                                                   : array
    {
        $index_name = strtolower($index_name);
        $table = $this->db_instance->quoteIdentifier($table, true);
        $query = "SHOW INDEX FROM $table /*!50002 WHERE Key_name = %s */";
 
        if (strtolower($index_name) !== 'primary') {
            $constraint_name_pdo = $this->db_instance->getIndexName($index_name);
            $result = $this->db_instance->query(sprintf($query, $this->db_instance->quote($constraint_name_pdo)));
            $data = $this->db_instance->fetchAssoc($result);
            if ($data) {
                // apply 'idxname_format' only if the query succeeded, otherwise
                // fallback to the given $index_name, without transformation
                $index_name = strtolower($constraint_name_pdo);
            }
        }
 
        $result = $this->db_instance->query(sprintf($query, $this->db_instance->quote($index_name)));
 
        $colpos = 1;
        $definition = array();
        while (is_object($row = $result->fetchObject())) {
            $row = (array) $row;
            $row = array_change_key_case($row, CASE_LOWER);
            $key_name = $row['key_name'];
            if ($this->db_instance->options['portability'] ?? null) {
                $key_name = strtolower($key_name);
            }
            $key_name = strtolower($key_name); // FSX fix
            if ($index_name === $key_name) {
                if ($row['non_unique']) {
                    throw new ilDatabaseException(' is not an existing table constraint');
                }
                if (strtolower($row['key_name']) === 'primary') {
                    $definition['primary'] = true;
                } else {
                    $definition['unique'] = true;
                }
                $column_name = $row['column_name'];
                if ($this->db_instance->options['portability'] ?? null) {
                    if ($this->db_instance->options['field_case'] == CASE_LOWER) {
                        $column_name = strtolower($column_name);
                    } else {
                        $column_name = strtoupper($column_name);
                    }
                }
                $definition['fields'][$column_name] = array(
                    'position' => $colpos++,
                );
                if (!empty($row['collation'])) {
                    $definition['fields'][$column_name]['sorting'] = ($row['collation'] === 'A' ? 'ascending' : 'descending');
                }
            }
        }
 
        if (empty($definition['fields'])) {
            throw new ilDatabaseException(' is not an existing table constraint');
        }
 
        return $definition;
    }

References $data, and $query.

getTableFieldDefinition()

ilDBPdoReverse::getTableFieldDefinition	(	string	$table_name,
		string	$field_name
	)

Returns

array<int|string, array<string, mixed>>

Implements ilDBReverse.

Definition at line 52 of file class.ilDBPdoReverse.php.

                                                                                   : array
    {
        $table = $this->db_instance->quoteIdentifier($table_name);
        $query = "SHOW COLUMNS FROM $table LIKE " . $this->db_instance->quote($field_name);
        $res = $this->pdo->query($query);
        $columns = array();
        while ($data = $res->fetch(PDO::FETCH_ASSOC)) {
            $columns[] = $data;
        }
 
        $ilDBPdoFieldDefinition = $this->db_instance->getFieldDefinition();
 
        foreach ($columns as $column) {
            $column = array_change_key_case($column, CASE_LOWER);
            $column['name'] = $column['field'];
            unset($column['field']);
            $column = array_change_key_case($column, CASE_LOWER);
            if ($field_name === $column['name'] && $ilDBPdoFieldDefinition !== null) {
                [$types, $length, $unsigned, $fixed] = $ilDBPdoFieldDefinition->mapNativeDatatype($column);
                $notnull = false;
                if (empty($column['null']) || $column['null'] !== 'YES') {
                    $notnull = true;
                }
                $default = false;
                if (array_key_exists('default', $column)) {
                    $default = $column['default'];
                    if ($notnull && is_null($default)) {
                        $default = '';
                    }
                }
                $autoincrement = false;
                if (!empty($column['extra']) && $column['extra'] === 'auto_increment') {
                    $autoincrement = true;
                }
 
                $definition[0] = array(
                    'notnull' => $notnull,
                    'nativetype' => preg_replace('/^([a-z]+)[^a-z].*/i', '\\1', $column['type']),
                );
                if (!is_null($length)) {
                    $definition[0]['length'] = $length;
                }
                if (!is_null($unsigned)) {
                    $definition[0]['unsigned'] = $unsigned;
                }
                if (!is_null($fixed)) {
                    $definition[0]['fixed'] = $fixed;
                }
                if ($default !== false) {
                    $definition[0]['default'] = $default;
                }
                if ($autoincrement) {
                    $definition[0]['autoincrement'] = $autoincrement;
                }
                foreach ($types as $key => $type) {
                    $definition[$key] = $definition[0];
                    if ($type === 'clob' || $type === 'blob') {
                        unset($definition[$key]['default']);
                    }
                    $definition[$key]['type'] = $type;
                    $definition[$key]['mdb2type'] = $type;
                }
 
                return $definition;
            }
        }
 
        throw new ilDatabaseException('it was not specified an existing table column');
    }

References $data, ILIAS\LTI\ToolProvider\$key, $query, $res, and $type.

getTableIndexDefinition()

ilDBPdoReverse::getTableIndexDefinition	(	string	$table,
		string	$constraint_name
	)

Returns

array<string, array<int|string, array<string, string|int>>&array>

Exceptions

ilDatabaseException

Implements ilDBReverse.

Definition at line 126 of file class.ilDBPdoReverse.php.

                                                                                   : array
    {
        $table = $this->db_instance->quoteIdentifier($table, true);
        $query = "SHOW INDEX FROM $table /*!50002 WHERE Key_name = %s */";
        $index_name_pdo = $this->db_instance->getIndexName($constraint_name);
        $result = $this->db_instance->query(sprintf($query, $this->db_instance->quote($index_name_pdo)));
        $data = $this->db_instance->fetchAssoc($result);
 
        if ($data) {
            $constraint_name = $index_name_pdo;
        }
 
        $result = $this->db_instance->query(sprintf($query, $this->db_instance->quote($constraint_name)));
 
        $colpos = 1;
        $definition = array();
        while (is_object($row = $result->fetchObject())) {
            $row = array_change_key_case((array) $row, CASE_LOWER);
 
            $key_name = $row['key_name'];
 
            if ($constraint_name === $key_name) {
                if (!$row['non_unique']) {
                    throw new ilDatabaseException('it was not specified an existing table index');
                }
                $column_name = $row['column_name'];
                $definition['fields'][$column_name] = array(
                    'position' => $colpos++,
                );
                if (!empty($row['collation'])) {
                    $definition['fields'][$column_name]['sorting'] = ($row['collation'] === 'A' ? 'ascending' : 'descending');
                }
            }
        }
 
        if (empty($definition['fields'])) {
            throw new ilDatabaseException('it was not specified an existing table index (index does not exist)');
        }
 
        return $definition;
    }

References $data, and $query.

getTriggerDefinition()

ilDBPdoReverse::getTriggerDefinition

(

string

$trigger

)

Exceptions

ilDatabaseException

Implements ilDBReverse.

Definition at line 237 of file class.ilDBPdoReverse.php.

                                                         : array
    {
        throw new ilDatabaseException('not yet implemented ' . __METHOD__);
    }

Field Documentation

$db_instance

ilDBPdo ilDBPdoReverse::$db_instance

protected

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

Referenced by __construct().

$pdo

PDO ilDBPdoReverse::$pdo

protected

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

Referenced by __construct().

$query_utils

ilMySQLQueryUtils ilDBPdoReverse::$query_utils = null

protected

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

Referenced by getQueryUtils().

---

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

• Services/Database/classes/PDO/Reverse/class.ilDBPdoReverse.php