Class ilDBPdoMySQLFieldDefinition. More...

Inheritance diagram for ilDBPdoMySQLFieldDefinition:

Collaboration diagram for ilDBPdoMySQLFieldDefinition:

Public Member Functions
	getTypeDeclaration ($field)

Public Member Functions inherited from ilDBPdoFieldDefinition
	__construct (\ilDBInterface $ilDBInterface)
	ilDBPdoFieldDefinition constructor. More...

	checkTableName ($table_name)

	isReserved ($table_name)

	getAllReserved ()

	getReservedMysql ()

	setReservedMysql ($reserved_mysql)

	getReservedPostgres ()

	setReservedPostgres ($reserved_postgres)

	checkColumnName ($column_name)

	checkIndexName ($a_name)

	checkColumnDefinition ($a_def)

	isAllowedAttribute ($attribute, $type)

	getAvailableTypes ()

	setAvailableTypes ($available_types)

	getAllowedAttributes ()

	setAllowedAttributes ($allowed_attributes)

	getMaxLength ()

	setMaxLength ($max_length)

	getValidTypes ()

	convertResult ($value, $type, $rtrim=true)

	convertResultRow ($types, $row, $rtrim=true)

	getDeclaration ($type, $name, $field)

	getTypeDeclaration ($field)

	compareDefinition ($current, $previous)

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

	writeLOBToFile ($lob, $file)

	destroyLOB ($lob)

	implodeArray ($array, $type=false)

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

	patternEscapeString ()

	mapNativeDatatype ($field)

	mapPrepareDatatype ($type)

Protected Member Functions
	getIntegerDeclaration ($name, $field)

	mapNativeDatatypeInternal ($field)

Protected Member Functions inherited from ilDBPdoFieldDefinition
	getQueryUtils ()

	getDBInstance ()

	checkResultTypes ($types)

	baseConvertResult ($value, $type, $rtrim=true)

	sortResultFieldTypes ($columns, $types)

	getInternalDeclaration ($name, $field)

	getDeclarationOptions ($field)

	getCharsetFieldDeclaration ($charset)

	getCollationFieldDeclaration ($collation)

	getIntegerDeclaration ($name, $field)

	getTextDeclaration ($name, $field)

	getCLOBDeclaration ($name, $field)

	getBLOBDeclaration ($name, $field)

	getBooleanDeclaration ($name, $field)

	getDateDeclaration ($name, $field)

	getTimestampDeclaration ($name, $field)

	getTimeDeclaration ($name, $field)

	getFloatDeclaration ($name, $field)

	getDecimalDeclaration ($name, $field)

	compareIntegerDefinition ($current, $previous)

	compareTextDefinition ($current, $previous)

	compareCLOBDefinition ($current, $previous)

	compareBLOBDefinition ($current, $previous)

	compareDateDefinition ($current, $previous)

	compareTimeDefinition ($current, $previous)

	compareTimestampDefinition ($current, $previous)

	compareBooleanDefinition ($current, $previous)

	compareFloatDefinition ($current, $previous)

	compareDecimalDefinition ($current, $previous)

	quoteInteger ($value, $quote, $escape_wildcards)

	quoteText ($value, $quote, $escape_wildcards)

	readFile ($value)

	quoteLOB ($value, $quote, $escape_wildcards)

	quoteCLOB ($value, $quote, $escape_wildcards)

	quoteBLOB ($value, $quote, $escape_wildcards)

	quoteBoolean ($value, $quote, $escape_wildcards)

	quoteDate ($value, $quote, $escape_wildcards)

	quoteTimestamp ($value, $quote, $escape_wildcards)

	quoteTime ($value, $quote, $escape_wildcards)

	quoteFloat ($value, $quote, $escape_wildcards)

	quoteDecimal ($value, $quote, $escape_wildcards)

	retrieveLOB (&$lob)

	readLOB ($lob, $length)

	endOfLOB ($lob)

	destroyLOBInternal (&$lob)

	mapNativeDatatypeInternal ($field)

Additional Inherited Members
Data Fields inherited from ilDBPdoFieldDefinition
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'

	$allowed_attributes_old

	$allowed_attributes

Protected Attributes inherited from ilDBPdoFieldDefinition
	$db_instance

	$max_length

	$available_types

	$reserved_mysql

	$reserved_postgres

	$query_utils

	$valid_default_values

Static Protected Attributes inherited from ilDBPdoFieldDefinition
static	$instance

Detailed Description

Class ilDBPdoMySQLFieldDefinition.

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

Definition at line 9 of file class.ilDBPdoMySQLFieldDefinition.php.

Member Function Documentation

◆ getIntegerDeclaration()

ilDBPdoMySQLFieldDefinition::getIntegerDeclaration	(	$name,
		$field
	)

protected

Parameters

$name
$field

Returns: |string

Exceptions

Definition at line 99 of file class.ilDBPdoMySQLFieldDefinition.php.

References $default, $name, ilDBPdoFieldDefinition\getDBInstance(), getTypeDeclaration(), and ilDBPdoFieldDefinition\quote().

     {
         $db = $this->getDBInstance();
 
         $default = $autoinc = '';
         if (!empty($field['autoincrement'])) {
             $autoinc = ' AUTO_INCREMENT PRIMARY KEY';
         } elseif (array_key_exists('default', $field)) {
             if ($field['default'] === '') {
                 $field['default'] = empty($field['notnull']) ? null : 0;
             }
             $default = ' DEFAULT ' . $this->quote($field['default'], 'integer');
         } elseif (empty($field['notnull'])) {
             $default = ' DEFAULT NULL';
         }
 
         $notnull = empty($field['notnull']) ? '' : ' NOT NULL';
         $unsigned = empty($field['unsigned']) ? '' : ' UNSIGNED';
         $name = $db->quoteIdentifier($name, true);
 
         return $name . ' ' . $this->getTypeDeclaration($field) . $unsigned . $default . $notnull . $autoinc;
     }

Here is the call graph for this function:

◆ getTypeDeclaration()

ilDBPdoMySQLFieldDefinition::getTypeDeclaration ( $field )

Parameters

$field

Returns: |string

Definition at line 16 of file class.ilDBPdoMySQLFieldDefinition.php.

References ilDBPdoFieldDefinition\getDBInstance().

Referenced by getIntegerDeclaration().

     {
         $db = $this->getDBInstance();
 
         switch ($field['type']) {
             case 'text':
                 if (empty($field['length']) && array_key_exists('default', $field)) {
                     $field['length'] = $db->varchar_max_length;
                 }
                 $length = !empty($field['length']) ? $field['length'] : false;
                 $fixed = !empty($field['fixed']) ? $field['fixed'] : false;
 
                 return $fixed ? ($length ? 'CHAR(' . $length . ')' : 'CHAR(255)') : ($length ? 'VARCHAR(' . $length . ')' : 'TEXT');
             case 'clob':
                 if (!empty($field['length'])) {
                     $length = $field['length'];
                     if ($length <= 255) {
                         return 'TINYTEXT';
                     } elseif ($length <= 65532) {
                         return 'TEXT';
                     } elseif ($length <= 16777215) {
                         return 'MEDIUMTEXT';
                     }
                 }
 
                 return 'LONGTEXT';
             case 'blob':
                 if (!empty($field['length'])) {
                     $length = $field['length'];
                     if ($length <= 255) {
                         return 'TINYBLOB';
                     } elseif ($length <= 65532) {
                         return 'BLOB';
                     } elseif ($length <= 16777215) {
                         return 'MEDIUMBLOB';
                     }
                 }
 
                 return 'LONGBLOB';
             case 'integer':
                 if (!empty($field['length'])) {
                     $length = $field['length'];
                     if ($length <= 1) {
                         return 'TINYINT';
                     } elseif ($length == 2) {
                         return 'SMALLINT';
                     } elseif ($length == 3) {
                         return 'MEDIUMINT';
                     } elseif ($length == 4) {
                         return 'INT';
                     } elseif ($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']) ? $field['length'] : 18;
                 $scale = !empty($field['scale']) ? $field['scale'] : $db->options['decimal_places'];
 
                 return 'DECIMAL(' . $length . ',' . $scale . ')';
         }
 
         return '';
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mapNativeDatatypeInternal()

ilDBPdoMySQLFieldDefinition::mapNativeDatatypeInternal ( $field )

protected

Parameters

$field

Returns: array

Exceptions

Definition at line 128 of file class.ilDBPdoMySQLFieldDefinition.php.

References $type.

     {
         $db_type = strtolower($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 = array();
         $unsigned = $fixed = null;
         switch ($db_type) {
             case 'tinyint':
                 $type[] = 'integer';
                 $type[] = 'boolean';
                 if (preg_match('/^(is|has)/', $field['name'])) {
                     $type = array_reverse($type);
                 }
                 $unsigned = preg_match('/ unsigned/i', $field['type']);
                 $length = 1;
                 break;
             case 'smallint':
                 $type[] = 'integer';
                 $unsigned = preg_match('/ unsigned/i', $field['type']);
                 $length = 2;
                 break;
             case 'mediumint':
                 $type[] = 'integer';
                 $unsigned = preg_match('/ unsigned/i', $field['type']);
                 $length = 3;
                 break;
             case 'int':
             case 'integer':
                 $type[] = 'integer';
                 $unsigned = preg_match('/ unsigned/i', $field['type']);
                 $length = 4;
                 break;
             case 'bigint':
                 $type[] = 'integer';
                 $unsigned = preg_match('/ unsigned/i', $field['type']);
                 $length = 8;
                 break;
             case 'tinytext':
             case 'mediumtext':
             case 'longtext':
             case 'text':
             case 'text':
             case 'varchar':
                 $fixed = false;
                 // no break
             case 'string':
             case 'char':
                 $type[] = 'text';
                 if ($length == '1') {
                     $type[] = 'boolean';
                     if (preg_match('/^(is|has)/', $field['name'])) {
                         $type = array_reverse($type);
                     }
                 } elseif (strstr($db_type, 'text')) {
                     $type[] = 'clob';
                     if ($decimal == 'binary') {
                         $type[] = 'blob';
                     }
                 }
                 if ($fixed !== false) {
                     $fixed = true;
                 }
                 break;
             case 'enum':
                 $type[] = 'text';
                 preg_match_all('/\'.+\'/U', $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)/', $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', $field['type']);
                 break;
             case 'unknown':
             case 'decimal':
             case 'numeric':
                 $type[] = 'decimal';
                 $unsigned = preg_match('/ unsigned/i', $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 array( $type, $length, $unsigned, $fixed );
     }

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

Services/Database/classes/PDO/FieldDefinition/class.ilDBPdoMySQLFieldDefinition.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getIntegerDeclaration()

◆ getTypeDeclaration()

◆ mapNativeDatatypeInternal()