Inheritance diagram for ilDBPdoFieldDefinition:

Collaboration diagram for ilDBPdoFieldDefinition:

Public Member Functions
	__construct (protected \ilDBInterface $db_instance)
	ilDBPdoFieldDefinition constructor. More...

	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]*$/"

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'

array	$allowed_attributes_old

array	$allowed_attributes

Protected Member Functions
	getQueryUtils ()

	getDBInstance ()

	getInternalDeclaration (string $name, array $field)

	getDeclarationOptions (array $field)

	getCharsetFieldDeclaration (string $charset)

	getCollationFieldDeclaration (string $collation)

	getIntegerDeclaration (string $name, array $field)

	getTextDeclaration (string $name, array $field)

	getCLOBDeclaration (string $name, array $field)

	getBLOBDeclaration (string $name, array $field)

	getBooleanDeclaration (string $name, array $field)

	getDateDeclaration (string $name, array $field)

	getTimestampDeclaration (string $name, array $field)

	getTimeDeclaration (string $name, array $field)

	getFloatDeclaration (string $name, array $field)

	getDecimalDeclaration (string $name, array $field)

	compareIntegerDefinition (array $current, array $previous)

	compareTextDefinition (array $current, array $previous)

	compareCLOBDefinition (array $current, array $previous)

	compareBLOBDefinition (array $current, array $previous)

	compareDateDefinition (array $current, array $previous)

	compareTimeDefinition (array $current, array $previous)

	compareTimestampDefinition (array $current, array $previous)

	compareBooleanDefinition (array $current, array $previous)

	compareFloatDefinition (array $current, array $previous)

	compareDecimalDefinition (array $current, array $previous)

	quoteInteger ($value, bool $quote, bool $escape_wildcards)

	quoteText (string $value, bool $quote, bool $escape_wildcards)

	readFile ($value)

	quoteLOB ($value, bool $quote, bool $escape_wildcards)

	quoteCLOB ($value, bool $quote, bool $escape_wildcards)

	quoteBLOB ($value, bool $quote, bool $escape_wildcards)

	quoteBoolean (bool $value, bool $quote, bool $escape_wildcards)

	quoteDate (string $value, bool $quote, bool $escape_wildcards)

	quoteTimestamp (int $value, bool $quote, bool $escape_wildcards)

	quoteTime (int $value, bool $quote, bool $escape_wildcards)

	quoteFloat (string $value, bool $quote, bool $escape_wildcards)

	quoteDecimal (string $value, bool $quote, bool $escape_wildcards)

	retrieveLOB (array &$lob)

	readLOB (array $lob, int $length)

	endOfLOB (array $lob)

	mapNativeDatatypeInternal (array $field)

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 ilDBPdoFieldDefinition	$instance

Private Attributes
const	MAX_TABLE_IDENTIFIER_LENGTH = 63

Detailed Description

Class ilDBPdoFieldDefinition.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilDBPdoFieldDefinition::__construct ( protected \ilDBInterface $db_instance )

ilDBPdoFieldDefinition constructor.

Definition at line 829 of file class.ilDBPdoFieldDefinition.php.

830 {

831 }

Member Function Documentation

◆ checkColumnDefinition()

ilDBPdoFieldDefinition::checkColumnDefinition ( array $a_def )

Exceptions

ilDatabaseException

Definition at line 958 of file class.ilDBPdoFieldDefinition.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(), T_INTEGER, and T_TEXT.

Here is the call graph for this function:

◆ checkColumnName()

ilDBPdoFieldDefinition::checkColumnName ( string $column_name )

Exceptions

ilDatabaseException

Definition at line 913 of file class.ilDBPdoFieldDefinition.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()

ilDBPdoFieldDefinition::checkIndexName ( string $a_name )

Exceptions

ilDatabaseException

Definition at line 938 of file class.ilDBPdoFieldDefinition.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()

ilDBPdoFieldDefinition::checkTableName ( string $table_name )

Exceptions

ilDatabaseException

Definition at line 858 of file class.ilDBPdoFieldDefinition.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:

◆ compareBLOBDefinition()

ilDBPdoFieldDefinition::compareBLOBDefinition	(	array	$current,
		array	$previous
	)

protected

Returns: array<string, bool>

Definition at line 1384 of file class.ilDBPdoFieldDefinition.php.

                                                                             : array
    {
        return $this->compareTextDefinition($current, $previous);
    }

References compareTextDefinition().

Here is the call graph for this function:

◆ compareBooleanDefinition()

ilDBPdoFieldDefinition::compareBooleanDefinition	(	array	$current,
		array	$previous
	)

protected

Definition at line 1404 of file class.ilDBPdoFieldDefinition.php.

◆ compareCLOBDefinition()

ilDBPdoFieldDefinition::compareCLOBDefinition	(	array	$current,
		array	$previous
	)

protected

Returns: array<string, bool>

Definition at line 1376 of file class.ilDBPdoFieldDefinition.php.

                                                                             : array
    {
        return $this->compareTextDefinition($current, $previous);
    }

References compareTextDefinition().

Here is the call graph for this function:

◆ compareDateDefinition()

ilDBPdoFieldDefinition::compareDateDefinition	(	array	$current,
		array	$previous
	)

protected

Definition at line 1389 of file class.ilDBPdoFieldDefinition.php.

◆ compareDecimalDefinition()

ilDBPdoFieldDefinition::compareDecimalDefinition	(	array	$current,
		array	$previous
	)

protected

Definition at line 1414 of file class.ilDBPdoFieldDefinition.php.

◆ compareDefinition()

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

Exceptions

ilDatabaseException

Returns: array<string, bool>

Definition at line 1284 of file class.ilDBPdoFieldDefinition.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:

◆ compareFloatDefinition()

ilDBPdoFieldDefinition::compareFloatDefinition	(	array	$current,
		array	$previous
	)

protected

Definition at line 1409 of file class.ilDBPdoFieldDefinition.php.

◆ compareIntegerDefinition()

ilDBPdoFieldDefinition::compareIntegerDefinition	(	array	$current,
		array	$previous
	)

protected

Returns: array<string, bool>

Definition at line 1336 of file class.ilDBPdoFieldDefinition.php.

                                                                                : array
    {
        $change = [];
        $previous_unsigned = empty($previous['unsigned']) ? false : $previous['unsigned'];
        $unsigned = empty($current['unsigned']) ? false : $current['unsigned'];
        if ($previous_unsigned != $unsigned) {
            $change['unsigned'] = true;
        }
        $previous_autoincrement = empty($previous['autoincrement']) ? false : $previous['autoincrement'];
        $autoincrement = empty($current['autoincrement']) ? false : $current['autoincrement'];
        if ($previous_autoincrement != $autoincrement) {
            $change['autoincrement'] = true;
        }
 
        return $change;
    }

◆ compareTextDefinition()

ilDBPdoFieldDefinition::compareTextDefinition	(	array	$current,
		array	$previous
	)

protected

Returns: array<string, bool>

Definition at line 1356 of file class.ilDBPdoFieldDefinition.php.

                                                                             : array
    {
        $change = [];
        $previous_length = empty($previous['length']) ? 0 : $previous['length'];
        $length = empty($current['length']) ? 0 : $current['length'];
        if ($previous_length != $length) {
            $change['length'] = true;
        }
        $previous_fixed = empty($previous['fixed']) ? 0 : $previous['fixed'];
        $fixed = empty($current['fixed']) ? 0 : $current['fixed'];
        if ($previous_fixed != $fixed) {
            $change['fixed'] = true;
        }
 
        return $change;
    }

Referenced by compareBLOBDefinition(), and compareCLOBDefinition().

Here is the caller graph for this function:

◆ compareTimeDefinition()

ilDBPdoFieldDefinition::compareTimeDefinition	(	array	$current,
		array	$previous
	)

protected

Definition at line 1394 of file class.ilDBPdoFieldDefinition.php.

◆ compareTimestampDefinition()

ilDBPdoFieldDefinition::compareTimestampDefinition	(	array	$current,
		array	$previous
	)

protected

Definition at line 1399 of file class.ilDBPdoFieldDefinition.php.

◆ destroyLOB()

ilDBPdoFieldDefinition::destroyLOB ( $lob )

Parameters

resource $lob

Definition at line 1621 of file class.ilDBPdoFieldDefinition.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;
    }

◆ endOfLOB()

ilDBPdoFieldDefinition::endOfLOB ( array $lob )

protected

Returns: mixed

Definition at line 1613 of file class.ilDBPdoFieldDefinition.php.

    {
        return $lob['endOfLOB'];
    }

◆ getAllowedAttributes()

ilDBPdoFieldDefinition::getAllowedAttributes ( )

Returns: string[]

Definition at line 1031 of file class.ilDBPdoFieldDefinition.php.

                                          : array
    {
        return $this->allowed_attributes;
    }

References $allowed_attributes.

Referenced by checkColumnDefinition().

Here is the caller graph for this function:

◆ getAllReserved()

ilDBPdoFieldDefinition::getAllReserved ( )

Returns: string[]

Definition at line 888 of file class.ilDBPdoFieldDefinition.php.

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

References getReservedMysql().

Here is the call graph for this function:

◆ getAvailableTypes()

ilDBPdoFieldDefinition::getAvailableTypes ( )

Returns: string[]

Definition at line 1015 of file class.ilDBPdoFieldDefinition.php.

                                       : array
    {
        return $this->available_types;
    }

References $available_types.

Referenced by checkColumnDefinition().

Here is the caller graph for this function:

◆ getBLOBDeclaration()

ilDBPdoFieldDefinition::getBLOBDeclaration	(	string	$name,
		array	$field
	)

protected

Definition at line 1239 of file class.ilDBPdoFieldDefinition.php.

                                                                     : string
    {
        $db = $this->getDBInstance();
 
        $notnull = empty($field['notnull']) ? '' : ' NOT NULL';
        $name = $db->quoteIdentifier($name, true);
 
        return $name . ' ' . $this->getTypeDeclaration($field) . $notnull;
    }

References getDBInstance(), and getTypeDeclaration().

Here is the call graph for this function:

◆ getBooleanDeclaration()

ilDBPdoFieldDefinition::getBooleanDeclaration	(	string	$name,
		array	$field
	)

protected

Definition at line 1249 of file class.ilDBPdoFieldDefinition.php.

                                                                        : string
    {
        return $this->getInternalDeclaration($name, $field);
    }

References getInternalDeclaration().

Here is the call graph for this function:

◆ getCharsetFieldDeclaration()

ilDBPdoFieldDefinition::getCharsetFieldDeclaration ( string $charset )

protected

Definition at line 1203 of file class.ilDBPdoFieldDefinition.php.

Referenced by getDeclarationOptions().

Here is the caller graph for this function:

◆ getCLOBDeclaration()

ilDBPdoFieldDefinition::getCLOBDeclaration	(	string	$name,
		array	$field
	)

protected

Definition at line 1229 of file class.ilDBPdoFieldDefinition.php.

                                                                     : string
    {
        $db = $this->getDBInstance();
 
        $notnull = empty($field['notnull']) ? '' : ' NOT NULL';
        $name = $db->quoteIdentifier($name, true);
 
        return $name . ' ' . $this->getTypeDeclaration($field) . $notnull;
    }

References getDBInstance(), and getTypeDeclaration().

Here is the call graph for this function:

◆ getCollationFieldDeclaration()

ilDBPdoFieldDefinition::getCollationFieldDeclaration ( string $collation )

protected

Definition at line 1208 of file class.ilDBPdoFieldDefinition.php.

Referenced by getDeclarationOptions().

Here is the caller graph for this function:

◆ getDateDeclaration()

ilDBPdoFieldDefinition::getDateDeclaration	(	string	$name,
		array	$field
	)

protected

Definition at line 1254 of file class.ilDBPdoFieldDefinition.php.

                                                                     : string
    {
        return $this->getInternalDeclaration($name, $field);
    }

References getInternalDeclaration().

Here is the call graph for this function:

◆ getDBInstance()

ilDBPdoFieldDefinition::getDBInstance ( )

protected

Definition at line 1054 of file class.ilDBPdoFieldDefinition.php.

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

Referenced by compareDefinition(), getBLOBDeclaration(), getCLOBDeclaration(), getDeclaration(), getDeclarationOptions(), ilDBPdoMySQLFieldDefinition\getIntegerDeclaration(), getInternalDeclaration(), getTypeDeclaration(), ilDBPdoMySQLFieldDefinition\getTypeDeclaration(), getValidTypes(), mapNativeDatatype(), mapPrepareDatatype(), matchPattern(), quote(), quoteText(), readFile(), and writeLOBToFile().

Here is the caller graph for this function:

◆ getDecimalDeclaration()

ilDBPdoFieldDefinition::getDecimalDeclaration	(	string	$name,
		array	$field
	)

protected

Definition at line 1274 of file class.ilDBPdoFieldDefinition.php.

                                                                        : string
    {
        return $this->getInternalDeclaration($name, $field);
    }

References getInternalDeclaration().

Here is the call graph for this function:

◆ getDeclaration()

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

Returns: mixed

Exceptions

ilDatabaseException

Definition at line 1091 of file class.ilDBPdoFieldDefinition.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 (!method_exists($this, "get{$type}Declaration")) {
            throw new ilDatabaseException('type not defined: ' . $type);
        }
 
        return $this->{"get{$type}Declaration"}($name, $field);
    }

References getDBInstance().

Here is the call graph for this function:

◆ getDeclarationOptions()

ilDBPdoFieldDefinition::getDeclarationOptions ( array $field )

protected

Exceptions

ilDatabaseException

Definition at line 1164 of file class.ilDBPdoFieldDefinition.php.

                                                          : string
    {
        $charset = empty($field['charset']) ? '' : ' ' . $this->getCharsetFieldDeclaration($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';
        // alex patch 28 Nov 2011 start
        if (isset($field["notnull"]) && $field['notnull'] === false) {
            $notnull = " NULL";
        }
        // alex patch 28 Nov 2011 end
 
        $collation = empty($field['collation']) ? '' : ' ' . $this->getCollationFieldDeclaration($field['collation']);
 
        return $charset . $default . $notnull . $collation;
    }

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

Here is the call graph for this function:

◆ getFloatDeclaration()

ilDBPdoFieldDefinition::getFloatDeclaration	(	string	$name,
		array	$field
	)

protected

Definition at line 1269 of file class.ilDBPdoFieldDefinition.php.

                                                                      : string
    {
        return $this->getInternalDeclaration($name, $field);
    }

References getInternalDeclaration().

Here is the call graph for this function:

◆ getIntegerDeclaration()

ilDBPdoFieldDefinition::getIntegerDeclaration	(	string	$name,
		array	$field
	)

protected

Exceptions

ilDatabaseException

Reimplemented in ilDBPdoMySQLFieldDefinition.

Definition at line 1216 of file class.ilDBPdoFieldDefinition.php.

                                                                        : string
    {
        return $this->getInternalDeclaration($name, $field);
    }

References getInternalDeclaration().

Here is the call graph for this function:

◆ getInternalDeclaration()

ilDBPdoFieldDefinition::getInternalDeclaration	(	string	$name,
		array	$field
	)

protected

Definition at line 1147 of file class.ilDBPdoFieldDefinition.php.

                                                                         : string
    {
        $db = $this->getDBInstance();
 
        $name = $db->quoteIdentifier($name, true);
        $declaration_options = '';
        $fd = $db->getFieldDefinition();
        if ($fd !== null) {
            $declaration_options = $fd->getDeclarationOptions($field);
        }
 
        return $name . ' ' . $this->getTypeDeclaration($field) . $declaration_options;
    }

References getDBInstance(), and getTypeDeclaration().

Referenced by getBooleanDeclaration(), getDateDeclaration(), getDecimalDeclaration(), getFloatDeclaration(), getIntegerDeclaration(), getTextDeclaration(), getTimeDeclaration(), and getTimestampDeclaration().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMaxLength()

ilDBPdoFieldDefinition::getMaxLength ( )

Definition at line 1044 of file class.ilDBPdoFieldDefinition.php.

                                  : array
    {
        return $this->max_length;
    }

References $max_length.

Referenced by checkColumnDefinition().

Here is the caller graph for this function:

◆ getQueryUtils()

ilDBPdoFieldDefinition::getQueryUtils ( )

protected

Definition at line 833 of file class.ilDBPdoFieldDefinition.php.

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

References $query_utils.

◆ getReservedMysql()

ilDBPdoFieldDefinition::getReservedMysql ( )

Returns: string[]

Definition at line 896 of file class.ilDBPdoFieldDefinition.php.

                                      : array
    {
        return $this->reserved_mysql;
    }

References $reserved_mysql.

Referenced by getAllReserved().

Here is the caller graph for this function:

◆ getTextDeclaration()

ilDBPdoFieldDefinition::getTextDeclaration	(	string	$name,
		array	$field
	)

protected

Exceptions

ilDatabaseException

Definition at line 1224 of file class.ilDBPdoFieldDefinition.php.

                                                                     : string
    {
        return $this->getInternalDeclaration($name, $field);
    }

References getInternalDeclaration().

Here is the call graph for this function:

◆ getTimeDeclaration()

ilDBPdoFieldDefinition::getTimeDeclaration	(	string	$name,
		array	$field
	)

protected

Definition at line 1264 of file class.ilDBPdoFieldDefinition.php.

                                                                     : string
    {
        return $this->getInternalDeclaration($name, $field);
    }

References getInternalDeclaration().

Here is the call graph for this function:

◆ getTimestampDeclaration()

ilDBPdoFieldDefinition::getTimestampDeclaration	(	string	$name,
		array	$field
	)

protected

Definition at line 1259 of file class.ilDBPdoFieldDefinition.php.

                                                                          : string
    {
        return $this->getInternalDeclaration($name, $field);
    }

References getInternalDeclaration().

Here is the call graph for this function:

◆ getTypeDeclaration()

ilDBPdoFieldDefinition::getTypeDeclaration ( array $field )

Reimplemented in ilDBPdoMySQLFieldDefinition.

Definition at line 1115 of file class.ilDBPdoFieldDefinition.php.

                                                    : string
    {
        $db = $this->getDBInstance();
 
        switch ($field['type']) {
            case 'text':
                $length = empty($field['length']) ? $db->options['default_text_field_length'] : $field['length'];
                $fixed = empty($field['fixed']) ? false : $field['fixed'];
                if ($fixed) {
                    return $length ? 'CHAR(' . $length . ')' : 'CHAR(' . $db->options['default_text_field_length'] . ')';
                }
 
                return $length ? 'VARCHAR(' . $length . ')' : 'TEXT';
            case 'clob':
            case 'decimal':
            case 'float':
            case 'blob':
                return 'TEXT';
            case 'integer':
            case 'boolean':
                return 'INT';
            case 'date':
                return 'CHAR (' . strlen('YYYY-MM-DD') . ')';
            case 'time':
                return 'CHAR (' . strlen('HH:MM:SS') . ')';
            case 'timestamp':
                return 'CHAR (' . strlen('YYYY-MM-DD HH:MM:SS') . ')';
        }
 
        return '';
    }

References getDBInstance().

Referenced by getBLOBDeclaration(), getCLOBDeclaration(), and getInternalDeclaration().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValidTypes()

ilDBPdoFieldDefinition::getValidTypes ( )

Returns: string[]

Definition at line 1062 of file class.ilDBPdoFieldDefinition.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 getDeclarationOptions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isAllowedAttribute()

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

Definition at line 1007 of file class.ilDBPdoFieldDefinition.php.

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

◆ isReserved()

ilDBPdoFieldDefinition::isReserved ( string $table_name )

Definition at line 880 of file class.ilDBPdoFieldDefinition.php.

                                                  : bool
    {
        return false;
    }

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

Here is the caller graph for this function:

◆ mapNativeDatatype()

ilDBPdoFieldDefinition::mapNativeDatatype ( array $field )

Returns: mixed

Definition at line 1687 of file class.ilDBPdoFieldDefinition.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()

ilDBPdoFieldDefinition::mapNativeDatatypeInternal ( array $field )

abstractprotected

Exceptions

ilDatabaseException

Reimplemented in ilDBPdoMySQLFieldDefinition.

Referenced by mapNativeDatatype().

Here is the caller graph for this function:

◆ mapPrepareDatatype()

ilDBPdoFieldDefinition::mapPrepareDatatype ( string $type )

Returns: mixed

Definition at line 1706 of file class.ilDBPdoFieldDefinition.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()

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

Exceptions

ilDatabaseException

Definition at line 1637 of file class.ilDBPdoFieldDefinition.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);
                }
                $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()

ilDBPdoFieldDefinition::patternEscapeString ( )

Definition at line 1679 of file class.ilDBPdoFieldDefinition.php.

                                         : string
    {
        return '';
    }

Referenced by matchPattern().

Here is the caller graph for this function:

◆ quote()

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

Parameters

mixed $value

Definition at line 1422 of file class.ilDBPdoFieldDefinition.php.

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

References getDBInstance().

Referenced by getDeclarationOptions(), and ilDBPdoMySQLFieldDefinition\getIntegerDeclaration().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ quoteBLOB()

ilDBPdoFieldDefinition::quoteBLOB	(		$value,
		bool	$quote,
		bool	$escape_wildcards
	)

protected

Parameters

string | resource $value

Definition at line 1498 of file class.ilDBPdoFieldDefinition.php.

                                                                             : string
    {
        return $this->quoteLOB($value, $quote, $escape_wildcards);
    }

References quoteLOB().

Here is the call graph for this function:

◆ quoteBoolean()

ilDBPdoFieldDefinition::quoteBoolean	(	bool	$value,
		bool	$quote,
		bool	$escape_wildcards
	)

protected

Definition at line 1503 of file class.ilDBPdoFieldDefinition.php.

                                                                                     : int
    {
        return ($value ? 1 : 0);
    }

◆ quoteCLOB()

ilDBPdoFieldDefinition::quoteCLOB	(		$value,
		bool	$quote,
		bool	$escape_wildcards
	)

protected

Parameters

string | resource $value

Definition at line 1491 of file class.ilDBPdoFieldDefinition.php.

                                                                             : string
    {
        return $this->quoteLOB($value, $quote, $escape_wildcards);
    }

References quoteLOB().

Here is the call graph for this function:

◆ quoteDate()

ilDBPdoFieldDefinition::quoteDate	(	string	$value,
		bool	$quote,
		bool	$escape_wildcards
	)

protected

Definition at line 1508 of file class.ilDBPdoFieldDefinition.php.

                                                                                    : string
    {
        if ($value === 'CURRENT_DATE') {
            return 'CURRENT_DATE';
        }
 
        return $this->quoteText($value, $quote, $escape_wildcards);
    }

References quoteText().

Here is the call graph for this function:

◆ quoteDecimal()

ilDBPdoFieldDefinition::quoteDecimal	(	string	$value,
		bool	$quote,
		bool	$escape_wildcards
	)

protected

Definition at line 1545 of file class.ilDBPdoFieldDefinition.php.

                                                                                       : ?string
    {
        $value = preg_replace('/[^\d\.,\-+eE]/', '', $value);
        if (preg_match('/[^.0-9]/', (string) $value) && strpos((string) $value, ',')) {
            // 1000,00
            if (!strpos((string) $value, '.')) {
                // convert the last "," to a "."
                $value = strrev(str_replace(',', '.', strrev((string) $value)));
                // 1.000,00
            } elseif (strpos((string) $value, '.') && strpos((string) $value, '.') < strpos((string) $value, ',')) {
                $value = str_replace('.', '', $value);
                // convert the last "," to a "."
                $value = strrev(str_replace(',', '.', strrev($value)));
                // 1,000.00
            } else {
                $value = str_replace(',', '', $value);
            }
        }
 
        return $value;
    }

Referenced by quoteFloat().

Here is the caller graph for this function:

◆ quoteFloat()

ilDBPdoFieldDefinition::quoteFloat	(	string	$value,
		bool	$quote,
		bool	$escape_wildcards
	)

protected

Definition at line 1533 of file class.ilDBPdoFieldDefinition.php.

                                                                                     : ?string
    {
        if (preg_match('/^(.*)e([-+])(\d+)$/i', $value, $matches)) {
            $decimal = $this->quoteDecimal($matches[1], $quote, $escape_wildcards);
            $sign = $matches[2];
            $exponent = str_pad($matches[3], 2, '0', STR_PAD_LEFT);
            return $decimal . 'E' . $sign . $exponent;
        }
 
        return $this->quoteDecimal($value, $quote, $escape_wildcards);
    }

References quoteDecimal().

Here is the call graph for this function:

◆ quoteInteger()

ilDBPdoFieldDefinition::quoteInteger	(		$value,
		bool	$quote,
		bool	$escape_wildcards
	)

protected

Parameters

mixed $value

Definition at line 1430 of file class.ilDBPdoFieldDefinition.php.

                                                                                : int
    {
        return (int) $value;
    }

◆ quoteLOB()

ilDBPdoFieldDefinition::quoteLOB	(		$value,
		bool	$quote,
		bool	$escape_wildcards
	)

protected

Parameters

string | resource $value

Definition at line 1482 of file class.ilDBPdoFieldDefinition.php.

                                                                            : string
    {
        $value = $this->readFile($value);
 
        return $this->quoteText($value, $quote, $escape_wildcards);
    }

References quoteText(), and readFile().

Referenced by quoteBLOB(), and quoteCLOB().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ quoteText()

ilDBPdoFieldDefinition::quoteText	(	string	$value,
		bool	$quote,
		bool	$escape_wildcards
	)

protected

Definition at line 1435 of file class.ilDBPdoFieldDefinition.php.

                                                                                    : string
    {
        if (!$quote) {
            return $value;
        }
 
        $db = $this->getDBInstance();
 
        $value = $db->escape($value, $escape_wildcards);
 
        return "'" . $value . "'";
    }

References getDBInstance().

Referenced by quoteDate(), and quoteLOB().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ quoteTime()

ilDBPdoFieldDefinition::quoteTime	(	int	$value,
		bool	$quote,
		bool	$escape_wildcards
	)

protected

Deprecated:

Definition at line 1528 of file class.ilDBPdoFieldDefinition.php.

                                                                                 : string
    {
        throw new ilDatabaseException("deprecated");
    }

◆ quoteTimestamp()

ilDBPdoFieldDefinition::quoteTimestamp	(	int	$value,
		bool	$quote,
		bool	$escape_wildcards
	)

protected

Deprecated:

Definition at line 1520 of file class.ilDBPdoFieldDefinition.php.

                                                                                      : string
    {
        throw new ilDatabaseException("deprecated");
    }

◆ readFile()

ilDBPdoFieldDefinition::readFile ( $value )

protected

Parameters

string | resource $value

Definition at line 1451 of file class.ilDBPdoFieldDefinition.php.

                                       : string
    {
        $close = false;
        if (is_string($value) && preg_match('/^(\w+:\/\/)(.*)$/', $value, $match)) {
            $close = true;
            if ($match[1] === 'file://') {
                $value = $match[2];
            }
            // do not try to open urls
            #$value = @fopen($value, 'r');
        }
 
        if (is_resource($value)) {
            $db = $this->getDBInstance();
 
            $fp = $value;
            $value = '';
            while (!@feof($fp)) {
                $value .= @fread($fp, $db->options['lob_buffer_length']);
            }
            if ($close) {
                @fclose($fp);
            }
        }
 
        return $value;
    }

References getDBInstance().

Referenced by quoteLOB().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readLOB()

ilDBPdoFieldDefinition::readLOB	(	array	$lob,
		int	$length
	)

protected

Definition at line 1605 of file class.ilDBPdoFieldDefinition.php.

                                                       : string
    {
        return substr((string) $lob['value'], $lob['position'], $length);
    }

◆ retrieveLOB()

ilDBPdoFieldDefinition::retrieveLOB ( array & $lob )

protected

Definition at line 1595 of file class.ilDBPdoFieldDefinition.php.

                                               : bool
    {
        if (is_null($lob['value'])) {
            $lob['value'] = $lob['resource'];
        }
        $lob['loaded'] = true;
 
        return true;
    }

◆ setAllowedAttributes()

ilDBPdoFieldDefinition::setAllowedAttributes ( array $allowed_attributes )

Parameters

string[] $allowed_attributes

Definition at line 1039 of file class.ilDBPdoFieldDefinition.php.

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

References $allowed_attributes.

◆ setAvailableTypes()

ilDBPdoFieldDefinition::setAvailableTypes ( array $available_types )

Parameters

string[] $available_types

Definition at line 1023 of file class.ilDBPdoFieldDefinition.php.

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

References $available_types.

◆ setMaxLength()

ilDBPdoFieldDefinition::setMaxLength ( array $max_length )

Definition at line 1049 of file class.ilDBPdoFieldDefinition.php.

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

References $max_length.

◆ setReservedMysql()

ilDBPdoFieldDefinition::setReservedMysql ( array $reserved_mysql )

Parameters

string[] $reserved_mysql

Definition at line 904 of file class.ilDBPdoFieldDefinition.php.

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

References $reserved_mysql.

◆ writeLOBToFile()

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

Parameters

resource $lob

Exceptions

ilDatabaseException

Definition at line 1572 of file class.ilDBPdoFieldDefinition.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 ilDBPdoFieldDefinition::$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 64 of file class.ilDBPdoFieldDefinition.php.

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

◆ $allowed_attributes_old

array ilDBPdoFieldDefinition::$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 51 of file class.ilDBPdoFieldDefinition.php.

◆ $available_types

array ilDBPdoFieldDefinition::$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 81 of file class.ilDBPdoFieldDefinition.php.

Referenced by getAvailableTypes(), and setAvailableTypes().

◆ $instance

ilDBPdoFieldDefinition ilDBPdoFieldDefinition::$instance

staticprotected

Definition at line 47 of file class.ilDBPdoFieldDefinition.php.

◆ $lobs

array ilDBPdoFieldDefinition::$lobs

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

◆ $max_length

array ilDBPdoFieldDefinition::$max_length

protected

Initial value:

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

Definition at line 74 of file class.ilDBPdoFieldDefinition.php.

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

◆ $query_utils

ilMySQLQueryUtils ilDBPdoFieldDefinition::$query_utils = null

protected

Definition at line 824 of file class.ilDBPdoFieldDefinition.php.

Referenced by getQueryUtils().

◆ $reserved_mysql

array ilDBPdoFieldDefinition::$reserved_mysql

protected

Definition at line 94 of file class.ilDBPdoFieldDefinition.php.

Referenced by getReservedMysql(), and setReservedMysql().

◆ $reserved_postgres

array ilDBPdoFieldDefinition::$reserved_postgres

protected

Definition at line 724 of file class.ilDBPdoFieldDefinition.php.

◆ $valid_default_values

array ilDBPdoFieldDefinition::$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' => '',
    ]