Class ilDBPdoMySQLFieldDefinition. More...

Inheritance diagram for ilDBPdoMySQLFieldDefinition:

Collaboration diagram for ilDBPdoMySQLFieldDefinition:

Public Member Functions
	__construct (protected \ilDBInterface $db_instance)

	checkTableName (string $table_name)

	isReserved (string $table_name)

	getAllReserved ()

	getReservedMysql ()

	setReservedMysql (array $reserved_mysql)

	checkColumnName (string $column_name)

	checkIndexName (string $a_name)

	checkColumnDefinition (array $a_def)

	isAllowedAttribute (string $attribute, string $type)

	getAvailableTypes ()

	setAvailableTypes (array $available_types)

	getAllowedAttributes ()

	setAllowedAttributes (array $allowed_attributes)

	getMaxLength ()

	setMaxLength (array $max_length)

	getValidTypes ()

	getDeclaration (string $type, string $name, array $field)

	compareDefinition (array $current, array $previous)

	quote ($value, ?string $type=null, bool $quote=true, bool $escape_wildcards=false)

	writeLOBToFile ($lob, string $file)

	destroyLOB ($lob)

	matchPattern (array $pattern, $operator=null, $field=null)

	patternEscapeString ()

	mapNativeDatatype (array $field)

	mapPrepareDatatype (string $type)

	getTypeDeclaration (array $field)

	checkTableName (string $table_name)

	isReserved (string $table_name)

	getAllReserved ()

	getReservedMysql ()

	setReservedMysql (array $reserved_mysql)

	checkColumnName (string $column_name)

	checkIndexName (string $a_name)

	checkColumnDefinition (array $a_def)

	isAllowedAttribute (string $attribute, string $type)

	getAvailableTypes ()

	setAvailableTypes (array $available_types)

	getAllowedAttributes ()

	setAllowedAttributes (array $allowed_attributes)

	getMaxLength ()

	setMaxLength (array $max_length)

	getValidTypes ()

	getDeclaration (string $type, string $name, array $field)

	getTypeDeclaration (array $field)

	compareDefinition (array $current, array $previous)

	quote ($value, ?string $type=null, bool $quote=true, bool $escape_wildcards=false)

	writeLOBToFile ($lob, string $file)

	destroyLOB ($lob)

	matchPattern (array $pattern, $operator=null, $field=null)

	patternEscapeString ()

	mapNativeDatatype (array $field)

	mapPrepareDatatype (string $type)

Data Fields
array	$lobs

const	DEFAULT_DECIMAL_PLACES = 2

const	DEFAULT_TEXT_LENGTH = 4000

const	DEFINITION_COLUMN_NAME = "/^[a-z]+[_a-z0-9]*$/"

const	DEFINITION_TABLE_NAME = "/^[a-z]+[_a-z0-9]*$/"

array	$allowed_attributes_old

array	$allowed_attributes

Data Fields inherited from ILIAS\Database\FieldDefinition
const	INDEX_FORMAT = '%s_idx'

const	SEQUENCE_COLUMNS_NAME = 'sequence'

const	SEQUENCE_FORMAT = '%s_seq'

const	T_BLOB = 'blob'

const	T_CLOB = 'clob'

const	T_DATE = 'date'

const	T_DATETIME = 'datetime'

const	T_FLOAT = 'float'

const	T_INTEGER = 'integer'

const	T_TEXT = 'text'

const	T_TIME = 'time'

const	T_TIMESTAMP = 'timestamp'

Protected Attributes
array	$max_length

array	$available_types

array	$reserved_mysql

array	$reserved_postgres

ilMySQLQueryUtils	$query_utils = null

array	$valid_default_values

Static Protected Attributes
static self	$instance

Private Member Functions
	getDBInstance ()

	getDeclarationOptions (array $field)

	mapNativeDatatypeInternal (array $field)

Private Attributes
const	MAX_TABLE_IDENTIFIER_LENGTH = 63

Detailed Description

Class ilDBPdoMySQLFieldDefinition.

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

Definition at line 28 of file ilDBPdoMySQLFieldDefinition.php.

Constructor & Destructor Documentation

◆ __construct()

ilDBPdoMySQLFieldDefinition::__construct ( protected \ilDBInterface $db_instance )

Definition at line 815 of file ilDBPdoMySQLFieldDefinition.php.

816 {

817 }

Member Function Documentation

◆ checkColumnDefinition()

ilDBPdoMySQLFieldDefinition::checkColumnDefinition ( array $a_def )

Exceptions

ilDatabaseException

Implements ILIAS\Database\FieldDefinition.

Definition at line 935 of file ilDBPdoMySQLFieldDefinition.php.

                                                       : bool
    {
        // check valid type
        if (!in_array($a_def["type"], $this->getAvailableTypes(), true)) {
            switch ($a_def["type"]) {
                case "boolean":
                    throw new ilDatabaseException("Invalid column type '" . $a_def["type"] . "'. Use integer(1) instead.");
 
                case "decimal":
                    throw new ilDatabaseException("Invalid column type '" . $a_def["type"] . "'. Use float or integer instead.");
 
                default:
                    throw new ilDatabaseException("Invalid column type '" . $a_def["type"] . "'. Allowed types are: "
                        . implode(', ', $this->getAvailableTypes()));
            }
        }
 
        // check used attributes
        $allowed_attributes = $this->getAllowedAttributes();
        foreach (array_keys($a_def) as $k) {
            if ($k !== "type" && !in_array($k, $allowed_attributes[$a_def["type"]], true)) {
                throw new ilDatabaseException("Attribute '" . $k . "' is not allowed for column type '" . $a_def["type"] . "'.");
            }
        }
 
        // type specific checks
        $max_length = $this->getMaxLength();
        switch ($a_def["type"]) {
            case self::T_TEXT:
                if ((!isset($a_def["length"]) || $a_def["length"] < 1 || $a_def["length"] > $max_length[self::T_TEXT]) && isset($a_def["length"])) {
                    throw new ilDatabaseException("Invalid length '" . $a_def["length"] . "' for type text." . " Length must be >=1 and <= "
                        . $max_length[self::T_TEXT] . ".");
                }
                break;
 
            case self::T_INTEGER:
                if (isset($a_def["length"]) && !in_array((int) $a_def["length"], $max_length[self::T_INTEGER], true)) {
                    throw new ilDatabaseException("Invalid length '" . $a_def["length"] . "' for type integer." . " Length must be "
                        . implode(', ', $max_length[self::T_INTEGER]) . " (bytes).");
                }
                if ($a_def["unsigned"] ?? null) {
                    throw new ilDatabaseException("Unsigned attribut must not be true for type integer.");
                }
                break;
        }
 
        return true;
    }

References $allowed_attributes, $max_length, getAllowedAttributes(), getAvailableTypes(), getMaxLength(), ILIAS\Database\FieldDefinition\T_INTEGER, and ILIAS\Database\FieldDefinition\T_TEXT.

Here is the call graph for this function:

◆ checkColumnName()

ilDBPdoMySQLFieldDefinition::checkColumnName ( string $column_name )

Exceptions

ilDatabaseException

Implements ILIAS\Database\FieldDefinition.

Definition at line 890 of file ilDBPdoMySQLFieldDefinition.php.

                                                        : bool
    {
        if (!preg_match("/^[a-z]+[_a-z0-9]*$/", $column_name)) {
            throw new ilDatabaseException("Invalid column name '" . $column_name
                . "'. Column name must only contain _a-z0-9 and must start with a-z.");
        }
 
        if ($this->isReserved($column_name)) {
            throw new ilDatabaseException("Invalid column name '" . $column_name . "' (Reserved Word).");
        }
 
        if (stripos($column_name, "sys_") === 0) {
            throw new ilDatabaseException("Invalid column name '" . $column_name . "'. Name must not start with 'sys_'.");
        }
 
        if (strlen($column_name) > 30) {
            throw new ilDatabaseException("Invalid column name '" . $column_name . "'. Maximum column identifer length is 30 bytes.");
        }
 
        return true;
    }

References isReserved().

Here is the call graph for this function:

◆ checkIndexName()

ilDBPdoMySQLFieldDefinition::checkIndexName ( string $a_name )

Exceptions

ilDatabaseException

Implements ILIAS\Database\FieldDefinition.

Definition at line 915 of file ilDBPdoMySQLFieldDefinition.php.

                                                  : bool
    {
        if (!preg_match("/^[a-z]+[_a-z0-9]*$/", $a_name)) {
            throw new ilDatabaseException("Invalid column name '" . $a_name . "'. Column name must only contain _a-z0-9 and must start with a-z.");
        }
 
        if ($this->isReserved($a_name)) {
            throw new ilDatabaseException("Invalid column name '" . $a_name . "' (Reserved Word).");
        }
 
        if (strlen($a_name) > 3) {
            throw new ilDatabaseException("Invalid index name '" . $a_name . "'. Maximum index identifer length is 3 bytes.");
        }
 
        return true;
    }

References isReserved().

Here is the call graph for this function:

◆ checkTableName()

ilDBPdoMySQLFieldDefinition::checkTableName ( string $table_name )

Exceptions

ilDatabaseException

Implements ILIAS\Database\FieldDefinition.

Definition at line 835 of file ilDBPdoMySQLFieldDefinition.php.

                                                      : bool
    {
        if (!preg_match(self::DEFINITION_TABLE_NAME, $table_name)) {
            throw new ilDatabaseException('Table name must only contain _a-z0-9 and must start with a-z.');
        }
 
        if ($this->isReserved($table_name)) {
            throw new ilDatabaseException("Invalid table name '" . $table_name . "' (Reserved Word).");
        }
 
        if (stripos($table_name, "sys_") === 0) {
            throw new ilDatabaseException("Invalid table name '" . $table_name . "'. Name must not start with 'sys_'.");
        }
 
        if (strlen($table_name) > self::MAX_TABLE_IDENTIFIER_LENGTH) {
            throw new ilDatabaseException("Invalid table name '" . $table_name
                . "'. Maximum table identifer length is " . self::MAX_TABLE_IDENTIFIER_LENGTH . " bytes.");
        }
 
        return true;
    }

References isReserved().

Here is the call graph for this function:

◆ compareDefinition()

ilDBPdoMySQLFieldDefinition::compareDefinition	(	array	$current,
		array	$previous
	)

Exceptions

ilDatabaseException

Returns: array<string, bool>

Implements ILIAS\Database\FieldDefinition.

Definition at line 1142 of file ilDBPdoMySQLFieldDefinition.php.

                                                                      : array
    {
        $type = empty($current['type']) ? null : $current['type'];
 
        if (!method_exists($this, "compare{$type}Definition")) {
            $db = $this->getDBInstance();
 
            if (!empty($db->options['datatype_map_callback'][$type])) {
                $parameter = ['current' => $current, 'previous' => $previous];
 
                return call_user_func_array(
                    $db->options['datatype_map_callback'][$type],
                    [&$db, __FUNCTION__, $parameter]
                );
            }
 
            throw new ilDatabaseException('type "' . $current['type'] . '" is not yet supported');
        }
 
        if (empty($previous['type']) || $previous['type'] != $type) {
            return $current;
        }
 
        $change = $this->{"compare{$type}Definition"}($current, $previous);
 
        if ($previous['type'] != $type) {
            $change['type'] = true;
        }
 
        $previous_notnull = empty($previous['notnull']) ? false : $previous['notnull'];
        $notnull = empty($current['notnull']) ? false : $current['notnull'];
        if ($previous_notnull !== $notnull) {
            $change['notnull'] = true;
        }
 
        $alt = $previous_notnull ? '' : null;
        $previous_default = array_key_exists(
            'default',
            $previous
        ) ? $previous['default'] : $alt;
        $alt = $notnull ? '' : null;
        $default = array_key_exists('default', $current) ? $current['default'] : $alt;
        if ($previous_default !== $default) {
            $change['default'] = true;
        }
 
        return $change;
    }

References getDBInstance().

Here is the call graph for this function:

◆ destroyLOB()

ilDBPdoMySQLFieldDefinition::destroyLOB ( $lob )

Parameters

resource $lob

Implements ILIAS\Database\FieldDefinition.

Definition at line 1230 of file ilDBPdoMySQLFieldDefinition.php.

                                    : bool
    {
        $lob_data = stream_get_meta_data($lob);
        $lob_index = $lob_data['wrapper_data']->lob_index;
        fclose($lob);
        if (isset($this->lobs[$lob_index])) {
            unset($this->lobs[$lob_index]);
        }
 
        return true;
    }

◆ getAllowedAttributes()

ilDBPdoMySQLFieldDefinition::getAllowedAttributes ( )

Returns: array<string, string[]>

Implements ILIAS\Database\FieldDefinition.

Definition at line 1008 of file ilDBPdoMySQLFieldDefinition.php.

                                          : array
    {
        return $this->allowed_attributes;
    }

References $allowed_attributes.

Referenced by checkColumnDefinition().

Here is the caller graph for this function:

◆ getAllReserved()

ilDBPdoMySQLFieldDefinition::getAllReserved ( )

Returns: string[]

Implements ILIAS\Database\FieldDefinition.

Definition at line 865 of file ilDBPdoMySQLFieldDefinition.php.

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

References getReservedMysql().

Here is the call graph for this function:

◆ getAvailableTypes()

ilDBPdoMySQLFieldDefinition::getAvailableTypes ( )

Returns: string[]

Implements ILIAS\Database\FieldDefinition.

Definition at line 992 of file ilDBPdoMySQLFieldDefinition.php.

                                       : array
    {
        return $this->available_types;
    }

References $available_types.

Referenced by checkColumnDefinition().

Here is the caller graph for this function:

◆ getDBInstance()

ilDBPdoMySQLFieldDefinition::getDBInstance ( )

private

Definition at line 1031 of file ilDBPdoMySQLFieldDefinition.php.

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

Referenced by compareDefinition(), getDeclaration(), getDeclarationOptions(), getTypeDeclaration(), getValidTypes(), mapNativeDatatype(), mapPrepareDatatype(), matchPattern(), quote(), and writeLOBToFile().

Here is the caller graph for this function:

◆ getDeclaration()

ilDBPdoMySQLFieldDefinition::getDeclaration	(	string	$type,
		string	$name,
		array	$field
	)

Returns: mixed

Exceptions

ilDatabaseException

Implements ILIAS\Database\FieldDefinition.

Definition at line 1068 of file ilDBPdoMySQLFieldDefinition.php.

    {
        $db = $this->getDBInstance();
 
        if (!empty($db->options['datatype_map'][$type])) {
            $type = $db->options['datatype_map'][$type];
            if (!empty($db->options['datatype_map_callback'][$type])) {
                $parameter = ['type' => $type, 'name' => $name, 'field' => $field];
 
                return call_user_func_array(
                    $db->options['datatype_map_callback'][$type],
                    [&$db, __FUNCTION__, $parameter]
                );
            }
            $field['type'] = $type;
        }
 
        if (!array_key_exists($type, $this->getValidTypes())) {
            throw new ilDatabaseException('type not defined: ' . $type);
        }
 
        $quoted_name = $db->quoteIdentifier($name, true);
        $type_declaration = $this->getTypeDeclaration($field);
 
        if ($type === 'clob' || $type === 'blob') {
            $notnull = empty($field['notnull']) ? '' : ' NOT NULL';
            return $quoted_name . ' ' . $type_declaration . $notnull;
        }
 
        return $quoted_name . ' ' . $type_declaration . $this->getDeclarationOptions($field);
    }

References getDBInstance(), getDeclarationOptions(), getTypeDeclaration(), and getValidTypes().

Here is the call graph for this function:

◆ getDeclarationOptions()

ilDBPdoMySQLFieldDefinition::getDeclarationOptions ( array $field )

private

Definition at line 1100 of file ilDBPdoMySQLFieldDefinition.php.

                                                        : string
    {
        $charset = empty($field['charset']) ? '' : ' ' . $field['charset'];
 
        $default = '';
        if (array_key_exists('default', $field)) {
            if ($field['default'] === '') {
                $db = $this->getDBInstance();
 
                if (empty($field['notnull'])) {
                    $field['default'] = null;
                } else {
                    $valid_default_values = $this->getValidTypes();
                    $field['default'] = $valid_default_values[$field['type']];
                }
                if ($field['default'] === ''
                    && isset($db->options['portability'])
                    && ($db->options['portability'] & 32)
                ) {
                    $field['default'] = ' ';
                }
            }
            $default = ' DEFAULT ' . $this->quote($field['default'], $field['type']);
        } elseif (empty($field['notnull'])) {
            $default = ' DEFAULT NULL';
        }
 
        $notnull = empty($field['notnull']) ? '' : ' NOT NULL';
        if (isset($field['notnull']) && $field['notnull'] === false) {
            $notnull = ' NULL';
        }
 
        $collation = empty($field['collation']) ? '' : ' ' . $field['collation'];
 
        return $charset . $default . $notnull . $collation;
    }

References $valid_default_values, getDBInstance(), getValidTypes(), and quote().

Referenced by getDeclaration().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMaxLength()

ilDBPdoMySQLFieldDefinition::getMaxLength ( )

Implements ILIAS\Database\FieldDefinition.

Definition at line 1021 of file ilDBPdoMySQLFieldDefinition.php.

                                  : array
    {
        return $this->max_length;
    }

References $max_length.

Referenced by checkColumnDefinition().

Here is the caller graph for this function:

◆ getReservedMysql()

ilDBPdoMySQLFieldDefinition::getReservedMysql ( )

Returns: string[]

Implements ILIAS\Database\FieldDefinition.

Definition at line 873 of file ilDBPdoMySQLFieldDefinition.php.

                                      : array
    {
        return $this->reserved_mysql;
    }

References $reserved_mysql.

Referenced by getAllReserved().

Here is the caller graph for this function:

◆ getTypeDeclaration()

ilDBPdoMySQLFieldDefinition::getTypeDeclaration ( array $field )

Implements ILIAS\Database\FieldDefinition.

Definition at line 1331 of file ilDBPdoMySQLFieldDefinition.php.

                                                    : string
    {
        $db = $this->getDBInstance();
 
        switch ($field['type']) {
            case 'text':
                if (empty($field['length']) && array_key_exists('default', $field)) {
                    $field['length'] = $db->varchar_max_length ?? null;
                }
                $length = empty($field['length']) ? false : $field['length'];
                $fixed = empty($field['fixed']) ? false : $field['fixed'];
                if ($fixed) {
                    return $length ? 'CHAR(' . $length . ')' : 'CHAR(255)';
                }
                return $length ? 'VARCHAR(' . $length . ')' : 'TEXT';
 
            case 'clob':
                if (!empty($field['length'])) {
                    $length = $field['length'];
                    if ($length <= 255) {
                        return 'TINYTEXT';
                    }
 
                    if ($length <= 65532) {
                        return 'TEXT';
                    }
 
                    if ($length <= 16_777_215) {
                        return 'MEDIUMTEXT';
                    }
                }
 
                return 'LONGTEXT';
            case 'blob':
                if (!empty($field['length'])) {
                    $length = $field['length'];
                    if ($length <= 255) {
                        return 'TINYBLOB';
                    }
 
                    if ($length <= 65532) {
                        return 'BLOB';
                    }
 
                    if ($length <= 16_777_215) {
                        return 'MEDIUMBLOB';
                    }
                }
 
                return 'LONGBLOB';
            case 'integer':
                if (!empty($field['length'])) {
                    $length = $field['length'];
                    if ($length <= 1) {
                        return 'TINYINT';
                    }
 
                    if ($length === 2) {
                        return 'SMALLINT';
                    }
 
                    if ($length === 3) {
                        return 'MEDIUMINT';
                    }
 
                    if ($length === 4) {
                        return 'INT';
                    }
 
                    if ($length > 4) {
                        return 'BIGINT';
                    }
                }
 
                return 'INT';
            case 'boolean':
                return 'TINYINT(1)';
            case 'date':
                return 'DATE';
            case 'time':
                return 'TIME';
            case 'timestamp':
                return 'DATETIME';
            case 'float':
                return 'DOUBLE';
            case 'decimal':
                $length = empty($field['length']) ? 18 : $field['length'];
                // @Todo: Change property access to method call.
                $scale = empty($field['scale']) ? $db->options['decimal_places'] : $field['scale'];
 
                return 'DECIMAL(' . $length . ',' . $scale . ')';
        }
 
        return '';
    }

References getDBInstance().

Referenced by getDeclaration().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValidTypes()

ilDBPdoMySQLFieldDefinition::getValidTypes ( )

Returns: string[]

Implements ILIAS\Database\FieldDefinition.

Definition at line 1039 of file ilDBPdoMySQLFieldDefinition.php.

                                   : array
    {
        $types = $this->valid_default_values;
        $db = $this->getDBInstance();
 
        if (!empty($db->options['datatype_map'])) {
            foreach ($db->options['datatype_map'] as $type => $mapped_type) {
                if (array_key_exists($mapped_type, $types)) {
                    $types[$type] = $types[$mapped_type];
                } elseif (!empty($db->options['datatype_map_callback'][$type])) {
                    $parameter = ['type' => $type, 'mapped_type' => $mapped_type];
                    $default = call_user_func_array(
                        $db->options['datatype_map_callback'][$type],
                        [&$db, __FUNCTION__, $parameter]
                    );
                    $types[$type] = $default;
                }
            }
        }
 
        return $types;
    }

References $valid_default_values, and getDBInstance().

Referenced by getDeclaration(), and getDeclarationOptions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isAllowedAttribute()

ilDBPdoMySQLFieldDefinition::isAllowedAttribute	(	string	$attribute,
		string	$type
	)

Implements ILIAS\Database\FieldDefinition.

Definition at line 984 of file ilDBPdoMySQLFieldDefinition.php.

                                                                       : bool
    {
        return in_array($attribute, $this->allowed_attributes[$type], true);
    }

◆ isReserved()

ilDBPdoMySQLFieldDefinition::isReserved ( string $table_name )

Implements ILIAS\Database\FieldDefinition.

Definition at line 857 of file ilDBPdoMySQLFieldDefinition.php.

                                                  : bool
    {
        return false;
    }

Referenced by checkColumnName(), checkIndexName(), and checkTableName().

Here is the caller graph for this function:

◆ mapNativeDatatype()

ilDBPdoMySQLFieldDefinition::mapNativeDatatype ( array $field )

Returns: mixed

Implements ILIAS\Database\FieldDefinition.

Definition at line 1297 of file ilDBPdoMySQLFieldDefinition.php.

    {
        $db = $this->getDBInstance();
        $db_type = strtok($field['type'], '(), ');
        if (!empty($db->options['nativetype_map_callback'][$db_type])) {
            return call_user_func_array($db->options['nativetype_map_callback'][$db_type], [$db, $field]);
        }
 
        return $this->mapNativeDatatypeInternal($field);
    }

References getDBInstance(), and mapNativeDatatypeInternal().

Here is the call graph for this function:

◆ mapNativeDatatypeInternal()

ilDBPdoMySQLFieldDefinition::mapNativeDatatypeInternal ( array $field )

private

Exceptions

ilDatabaseException

Definition at line 1430 of file ilDBPdoMySQLFieldDefinition.php.

                                                            : array
    {
        $db_type = strtolower((string) $field['type']);
        $db_type = strtok($db_type, '(), ');
        if ($db_type === 'national') {
            $db_type = strtok('(), ');
        }
        if (!empty($field['length'])) {
            $length = strtok($field['length'], ', ');
            $decimal = strtok(', ');
        } else {
            $length = strtok('(), ');
            $decimal = strtok('(), ');
        }
        $type = [];
        $unsigned = $fixed = null;
        switch ($db_type) {
            case 'tinyint':
                $type[] = 'integer';
                $type[] = 'boolean';
                if (preg_match('/^(is|has)/', (string) $field['name'])) {
                    $type = array_reverse($type);
                }
                $unsigned = preg_match('/ unsigned/i', (string) $field['type']);
                $length = 1;
                break;
            case 'smallint':
                $type[] = 'integer';
                $unsigned = preg_match('/ unsigned/i', (string) $field['type']);
                $length = 2;
                break;
            case 'mediumint':
                $type[] = 'integer';
                $unsigned = preg_match('/ unsigned/i', (string) $field['type']);
                $length = 3;
                break;
            case 'int':
            case 'integer':
                $type[] = 'integer';
                $unsigned = preg_match('/ unsigned/i', (string) $field['type']);
                $length = 4;
                break;
            case 'bigint':
                $type[] = 'integer';
                $unsigned = preg_match('/ unsigned/i', (string) $field['type']);
                $length = 8;
                break;
            case 'tinytext':
            case 'mediumtext':
            case 'longtext':
            case 'text':
            case 'varchar':
                $fixed = false;
                // no break
            case 'string':
            case 'char':
                $type[] = 'text';
                if ($length == '1') {
                    $type[] = 'boolean';
                    if (preg_match('/^(is|has)/', (string) $field['name'])) {
                        $type = array_reverse($type);
                    }
                } elseif (str_contains($db_type, 'text')) {
                    $type[] = 'clob';
                    if ($decimal === 'binary') {
                        $type[] = 'blob';
                    }
                }
                if ($fixed !== false) {
                    $fixed = true;
                }
                break;
            case 'enum':
                $type[] = 'text';
                preg_match_all('/\'.+\'/U', (string) $field['type'], $matches);
                $length = 0;
                $fixed = false;
                if (is_array($matches)) {
                    foreach ($matches[0] as $value) {
                        $length = max($length, strlen($value) - 2);
                    }
                    if ($length == '1' && count($matches[0]) === 2) {
                        $type[] = 'boolean';
                        if (preg_match('/^(is|has)/', (string) $field['name'])) {
                            $type = array_reverse($type);
                        }
                    }
                }
                $type[] = 'integer';
                // no break
            case 'set':
                $fixed = false;
                $type[] = 'text';
                $type[] = 'integer';
                break;
            case 'date':
                $type[] = 'date';
                $length = null;
                break;
            case 'datetime':
            case 'timestamp':
                $type[] = 'timestamp';
                $length = null;
                break;
            case 'time':
                $type[] = 'time';
                $length = null;
                break;
            case 'float':
            case 'double':
            case 'real':
                $type[] = 'float';
                $unsigned = preg_match('/ unsigned/i', (string) $field['type']);
                break;
            case 'unknown':
            case 'decimal':
            case 'numeric':
                $type[] = 'decimal';
                $unsigned = preg_match('/ unsigned/i', (string) $field['type']);
                if ($decimal !== false) {
                    $length = $length . ',' . $decimal;
                }
                break;
            case 'tinyblob':
            case 'mediumblob':
            case 'longblob':
            case 'blob':
                $type[] = 'blob';
                $length = null;
                break;
            case 'binary':
            case 'varbinary':
                $type[] = 'blob';
                break;
            case 'year':
                $type[] = 'integer';
                $type[] = 'date';
                $length = null;
                break;
            default:
                throw new ilDatabaseException('unknown database attribute type: ' . $db_type);
        }
 
        if ((int) $length <= 0) {
            $length = null;
        }
 
        return [ $type, $length, $unsigned, $fixed ];
    }

Referenced by mapNativeDatatype().

Here is the caller graph for this function:

◆ mapPrepareDatatype()

ilDBPdoMySQLFieldDefinition::mapPrepareDatatype ( string $type )

Returns: mixed

Implements ILIAS\Database\FieldDefinition.

Definition at line 1311 of file ilDBPdoMySQLFieldDefinition.php.

    {
        $db = $this->getDBInstance();
 
        if (!empty($db->options['datatype_map'][$type])) {
            $type = $db->options['datatype_map'][$type];
            if (!empty($db->options['datatype_map_callback'][$type])) {
                $parameter = ['type' => $type];
 
                return call_user_func_array(
                    $db->options['datatype_map_callback'][$type],
                    [&$db, __FUNCTION__, $parameter]
                );
            }
        }
 
        return $type;
    }

References getDBInstance().

Here is the call graph for this function:

◆ matchPattern()

ilDBPdoMySQLFieldDefinition::matchPattern	(	array	$pattern,
			$operator = `null`,
			$field = `null`
	)

Exceptions

ilDatabaseException

Implements ILIAS\Database\FieldDefinition.

Definition at line 1246 of file ilDBPdoMySQLFieldDefinition.php.

                                                                                 : string
    {
        $db = $this->getDBInstance();
 
        $match = '';
        if (!is_null($operator)) {
            $operator = strtoupper((string) $operator);
            switch ($operator) {
                // case insensitive
                case 'ILIKE':
                    if (is_null($field)) {
                        throw new ilDatabaseException('case insensitive LIKE matching requires passing the field name');
                    }
                    $db->loadModule('Function');
                    $match = $db->lower($field) . ' LIKE ';
                    break;
                    // case sensitive
                case 'LIKE':
                    $match = is_null($field) ? 'LIKE ' : $field . ' LIKE ';
                    break;
                default:
                    throw new ilDatabaseException('not a supported operator type:' . $operator);
            }
        }
        $match .= "'";
        foreach ($pattern as $key => $value) {
            if ($key % 2 !== 0) {
                $match .= $value;
            } else {
                if ($operator === 'ILIKE') {
                    $value = strtolower((string) $value);
                }
                // @Todo: ilDBPdo::escape & escapePattern do nothing, probably quote instead.
                $escaped = $db->escape($value);
                $match .= $db->escapePattern($escaped);
            }
        }
        $match .= "'";
        $match .= $this->patternEscapeString();
 
        return $match;
    }

References getDBInstance(), and patternEscapeString().

Here is the call graph for this function:

◆ patternEscapeString()

ilDBPdoMySQLFieldDefinition::patternEscapeString ( )

Implements ILIAS\Database\FieldDefinition.

Definition at line 1289 of file ilDBPdoMySQLFieldDefinition.php.

                                         : string
    {
        return '';
    }

Referenced by matchPattern().

Here is the caller graph for this function:

◆ quote()

ilDBPdoMySQLFieldDefinition::quote	(		$value,
		?string	$type = `null`,
		bool	$quote = `true`,
		bool	$escape_wildcards = `false`
	)

Parameters

mixed $value

Implements ILIAS\Database\FieldDefinition.

Definition at line 1194 of file ilDBPdoMySQLFieldDefinition.php.

                                                                                                           : string
    {
        return $this->getDBInstance()->quote($value, $type ?? '');
    }

References getDBInstance().

Referenced by getDeclarationOptions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAllowedAttributes()

ilDBPdoMySQLFieldDefinition::setAllowedAttributes ( array $allowed_attributes )

Parameters

array<string,string[]> $allowed_attributes

Implements ILIAS\Database\FieldDefinition.

Definition at line 1016 of file ilDBPdoMySQLFieldDefinition.php.

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

References $allowed_attributes.

◆ setAvailableTypes()

ilDBPdoMySQLFieldDefinition::setAvailableTypes ( array $available_types )

Parameters

string[] $available_types

Implements ILIAS\Database\FieldDefinition.

Definition at line 1000 of file ilDBPdoMySQLFieldDefinition.php.

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

References $available_types.

◆ setMaxLength()

ilDBPdoMySQLFieldDefinition::setMaxLength ( array $max_length )

Implements ILIAS\Database\FieldDefinition.

Definition at line 1026 of file ilDBPdoMySQLFieldDefinition.php.

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

References $max_length.

◆ setReservedMysql()

ilDBPdoMySQLFieldDefinition::setReservedMysql ( array $reserved_mysql )

Parameters

string[] $reserved_mysql

Implements ILIAS\Database\FieldDefinition.

Definition at line 881 of file ilDBPdoMySQLFieldDefinition.php.

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

References $reserved_mysql.

◆ writeLOBToFile()

ilDBPdoMySQLFieldDefinition::writeLOBToFile	(		$lob,
		string	$file
	)

Parameters

resource $lob

Exceptions

ilDatabaseException

Implements ILIAS\Database\FieldDefinition.

Definition at line 1204 of file ilDBPdoMySQLFieldDefinition.php.

                                                      : bool
    {
        $db = $this->getDBInstance();
 
        if (preg_match('/^(\w+:\/\/)(.*)$/', $file, $match) && $match[1] === 'file://') {
            $file = $match[2];
        }
 
        $fp = @fopen($file, 'wb');
        while (!@feof($lob)) {
            $result = @fread($lob, $db->options['lob_buffer_length']);
            $read = strlen($result);
            if (@fwrite($fp, $result, $read) !== $read) {
                @fclose($fp);
 
                throw new ilDatabaseException('could not write to the output file');
            }
        }
        @fclose($fp);
 
        return true;
    }

References getDBInstance().

Here is the call graph for this function:

Field Documentation

◆ $allowed_attributes

array ilDBPdoMySQLFieldDefinition::$allowed_attributes

Initial value:

= [
        "text" => ["length", "notnull", "default", "fixed"],
        "integer" => ["length", "notnull", "default", "unsigned"],
        "float" => ["notnull", "default"],
        "date" => ["notnull", "default"],
        "time" => ["notnull", "default"],
        "timestamp" => ["notnull", "default"],
        "clob" => ["length", "notnull", "default"],
        "blob" => ["length", "notnull", "default"],
    ]

Definition at line 55 of file ilDBPdoMySQLFieldDefinition.php.

Referenced by checkColumnDefinition(), getAllowedAttributes(), and setAllowedAttributes().

◆ $allowed_attributes_old

array ilDBPdoMySQLFieldDefinition::$allowed_attributes_old

Initial value:

= [
        self::T_TEXT => ['length', 'notnull', 'default', 'fixed'],
        self::T_INTEGER => ['length', 'notnull', 'default', 'unsigned'],
        self::T_FLOAT => ['notnull', 'default'],
        self::T_DATE => ['notnull', 'default'],
        self::T_TIME => ['notnull', 'default'],
        self::T_TIMESTAMP => ['notnull', 'default'],
        self::T_CLOB => ['notnull', 'default'],
        self::T_BLOB => ['notnull', 'default'],
    ]

Definition at line 42 of file ilDBPdoMySQLFieldDefinition.php.

◆ $available_types

array ilDBPdoMySQLFieldDefinition::$available_types

protected

Initial value:

= [
        self::T_TEXT,
        self::T_INTEGER,
        self::T_FLOAT,
        self::T_DATE,
        self::T_TIME,
        self::T_TIMESTAMP,
        self::T_CLOB,
        self::T_BLOB,
    ]

Definition at line 72 of file ilDBPdoMySQLFieldDefinition.php.

Referenced by getAvailableTypes(), and setAvailableTypes().

◆ $instance

self ilDBPdoMySQLFieldDefinition::$instance

staticprotected

Definition at line 38 of file ilDBPdoMySQLFieldDefinition.php.

◆ $lobs

array ilDBPdoMySQLFieldDefinition::$lobs

Definition at line 30 of file ilDBPdoMySQLFieldDefinition.php.

◆ $max_length

array ilDBPdoMySQLFieldDefinition::$max_length

protected

Initial value:

= [
        self::T_INTEGER => [1, 2, 3, 4, 8],
        self::T_TEXT => 4000,
    ]

Definition at line 65 of file ilDBPdoMySQLFieldDefinition.php.

Referenced by checkColumnDefinition(), getMaxLength(), and setMaxLength().

◆ $query_utils

ilMySQLQueryUtils ilDBPdoMySQLFieldDefinition::$query_utils = null

protected

Definition at line 813 of file ilDBPdoMySQLFieldDefinition.php.

◆ $reserved_mysql

array ilDBPdoMySQLFieldDefinition::$reserved_mysql

protected

Definition at line 85 of file ilDBPdoMySQLFieldDefinition.php.

Referenced by getReservedMysql(), and setReservedMysql().

◆ $reserved_postgres

array ilDBPdoMySQLFieldDefinition::$reserved_postgres

protected

Definition at line 715 of file ilDBPdoMySQLFieldDefinition.php.

◆ $valid_default_values

array ilDBPdoMySQLFieldDefinition::$valid_default_values

protected

Initial value:

= [
        'text' => '',
        'boolean' => true,
        'integer' => 0,
        'decimal' => 0.0,
        'float' => 0.0,
        'timestamp' => '1970-01-01 00:00:00',
        'time' => '00:00:00',
        'date' => '1970-01-01',
        'clob' => '',
        'blob' => '',
    ]

Definition at line 819 of file ilDBPdoMySQLFieldDefinition.php.

Referenced by getDeclarationOptions(), and getValidTypes().

◆ DEFAULT_DECIMAL_PLACES

const ilDBPdoMySQLFieldDefinition::DEFAULT_DECIMAL_PLACES = 2

Definition at line 31 of file ilDBPdoMySQLFieldDefinition.php.

◆ DEFAULT_TEXT_LENGTH

const ilDBPdoMySQLFieldDefinition::DEFAULT_TEXT_LENGTH = 4000

Definition at line 32 of file ilDBPdoMySQLFieldDefinition.php.

◆ DEFINITION_COLUMN_NAME

const ilDBPdoMySQLFieldDefinition::DEFINITION_COLUMN_NAME = "/^[a-z]+[_a-z0-9]*$/"

Definition at line 33 of file ilDBPdoMySQLFieldDefinition.php.

◆ DEFINITION_TABLE_NAME

const ilDBPdoMySQLFieldDefinition::DEFINITION_TABLE_NAME = "/^[a-z]+[_a-z0-9]*$/"

Definition at line 34 of file ilDBPdoMySQLFieldDefinition.php.

◆ MAX_TABLE_IDENTIFIER_LENGTH

const ilDBPdoMySQLFieldDefinition::MAX_TABLE_IDENTIFIER_LENGTH = 63

private

Definition at line 36 of file ilDBPdoMySQLFieldDefinition.php.

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

components/ILIAS/Database/classes/PDO/FieldDefinition/ilDBPdoMySQLFieldDefinition.php

Public Member Functions

Data Fields

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkColumnDefinition()

◆ checkColumnName()

◆ checkIndexName()

◆ checkTableName()

◆ compareDefinition()

◆ destroyLOB()

◆ getAllowedAttributes()

◆ getAllReserved()

◆ getAvailableTypes()

◆ getDBInstance()

◆ getDeclaration()

◆ getDeclarationOptions()

◆ getMaxLength()

◆ getReservedMysql()

◆ getTypeDeclaration()

◆ getValidTypes()

◆ isAllowedAttribute()

◆ isReserved()

◆ mapNativeDatatype()

◆ mapNativeDatatypeInternal()

◆ mapPrepareDatatype()

◆ matchPattern()

◆ patternEscapeString()

◆ quote()

◆ setAllowedAttributes()

◆ setAvailableTypes()

◆ setMaxLength()

◆ setReservedMysql()

◆ writeLOBToFile()

Field Documentation

◆ $allowed_attributes

◆ $allowed_attributes_old

◆ $available_types

◆ $instance

◆ $lobs

◆ $max_length

◆ $query_utils

◆ $reserved_mysql

◆ $reserved_postgres

◆ $valid_default_values

◆ DEFAULT_DECIMAL_PLACES

◆ DEFAULT_TEXT_LENGTH

◆ DEFINITION_COLUMN_NAME

◆ DEFINITION_TABLE_NAME

◆ MAX_TABLE_IDENTIFIER_LENGTH