Inheritance diagram for ilDBPdoFieldDefinition:

Collaboration diagram for ilDBPdoFieldDefinition:

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

	checkTableName ($table_name)

	isReserved ($table_name)

	getAllReserved ()

	getReservedMysql ()

	setReservedMysql ($reserved_mysql)

	getReservedPostgres ()

	setReservedPostgres ($reserved_postgres)

	getReservedOracle ()

	setReservedOracle ($reserved_oracle)

	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)

Data Fields
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 Member Functions
	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)

Protected Attributes
	$db_instance

	$max_length

	$available_types

	$reserved_mysql

	$reserved_postgres

	$reserved_oracle

	$query_utils

	$valid_default_values

Static Protected Attributes
static	$instance

Detailed Description

Class ilDBPdoFieldDefinition.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilDBPdoFieldDefinition::__construct ( \ilDBInterface $ilDBInterface )

ilDBPdoFieldDefinition constructor.

Parameters

\ilDBInterface $ilDBInterface

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

                                                                    {
                 $this->db_instance = $ilDBInterface;
         }

Member Function Documentation

◆ baseConvertResult()

ilDBPdoFieldDefinition::baseConvertResult	(	$value,
		$type,
		$rtrim = `true`
	)

protected

Parameters

	$value
	$type
bool	$rtrim

Returns: bool|float|int|resource|string

Exceptions

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

References array.

Referenced by convertResult().

                                                                            {
                 switch ($type) {
                         case 'text':
                                 if ($rtrim) {
                                         $value = rtrim($value);
                                 }
 
                                 return $value;
                         case 'integer':
                                 return intval($value);
                         case 'boolean':
                                 return !empty($value);
                         case 'decimal':
                                 return $value;
                         case 'float':
                                 return doubleval($value);
                         case 'date':
                                 return $value;
                         case 'time':
                                 return $value;
                         case 'timestamp':
                                 return $value;
                         case 'clob':
                         case 'blob':
                                 $this->lobs[] = array(
                                         'buffer'    => null,
                                         'position'  => 0,
                                         'lob_index' => null,
                                         'endOfLOB'  => false,
                                         'resource'  => $value,
                                         'value'     => null,
                                         'loaded'    => false,
                                 );
                                 end($this->lobs);
                                 $lob_index = key($this->lobs);
                                 $this->lobs[$lob_index]['lob_index'] = $lob_index;
 
                                 return fopen('MDB2LOB://' . $lob_index . '@' . $this->db_index, 'r+');
                 }
 
                 throw new ilDatabaseException('attempt to convert result value to an unknown type :' . $type);
         }

Here is the caller graph for this function:

◆ checkColumnDefinition()

ilDBPdoFieldDefinition::checkColumnDefinition ( $a_def )

Parameters

$a_def

Returns: bool

Exceptions

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

References $allowed_attributes, $max_length, getAllowedAttributes(), getAvailableTypes(), and getMaxLength().

                                                       {
                 // check valid type
                 if (!in_array($a_def["type"], $this->getAvailableTypes())) {
                         switch ($a_def["type"]) {
                                 case "boolean":
                                         throw new ilDatabaseException("Invalid column type '" . $a_def["type"] . "'. Use integer(1) instead.");
                                         break;
 
                                 case "decimal":
                                         throw new ilDatabaseException("Invalid column type '" . $a_def["type"] . "'. Use float or integer instead.");
                                         break;
 
                                 default:
                                         throw new ilDatabaseException("Invalid column type '" . $a_def["type"] . "'. Allowed types are: "
                                                                       . implode(', ', $this->getAvailableTypes()));
                         }
                 }
 
                 // check used attributes
                 $allowed_attributes = $this->getAllowedAttributes();
                 foreach ($a_def as $k => $v) {
                         if ($k != "type" && !in_array($k, $allowed_attributes[$a_def["type"]])) {
                                 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 ($a_def["length"] < 1 || $a_def["length"] > $max_length[self::T_TEXT]) {
                                         if (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 (!in_array($a_def["length"], $max_length[self::T_INTEGER])) {
                                         if (isset($a_def["length"])) {
                                                 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"]) {
                                         throw new ilDatabaseException("Unsigned attribut must not be true for type integer.");
                                 }
                                 break;
                 }
 
                 return true;
         }

Here is the call graph for this function:

◆ checkColumnName()

ilDBPdoFieldDefinition::checkColumnName ( $column_name )

Parameters

$column_name

Returns: bool

Exceptions

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

References isReserved().

                                                       {
                 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 (strtolower(substr($column_name, 0, 4)) == "sys_") {
                         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;
         }

Here is the call graph for this function:

◆ checkIndexName()

ilDBPdoFieldDefinition::checkIndexName ( $a_name )

Parameters

$a_name

Returns: bool

Exceptions

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

References isReserved().

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

Here is the call graph for this function:

◆ checkResultTypes()

ilDBPdoFieldDefinition::checkResultTypes ( $types )

protected

Parameters

$types

Returns: array|

Exceptions

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

References array, and getDBInstance().

                                                     {
                 $types = is_array($types) ? $types : array( $types );
                 foreach ($types as $key => $type) {
                         if (!isset($this->valid_default_values[$type])) {
                                 $db = $this->getDBInstance();
                                 if (empty($db->options['datatype_map'][$type])) {
                                         throw new ilDatabaseException($type . ' for ' . $key . ' is not a supported column type');
                                 }
                         }
                 }
 
                 return $types;
         }

Here is the call graph for this function:

◆ checkTableName()

ilDBPdoFieldDefinition::checkTableName ( $table_name )

Parameters

$table_name

Returns: bool

Exceptions

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

References isReserved().

                                                     {
                 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 (strtolower(substr($table_name, 0, 4)) == "sys_") {
                         throw new ilDatabaseException("Invalid table name '" . $table_name . "'. Name must not start with 'sys_'.");
                 }
 
                 if (strlen($table_name) > 22) {
                         throw new ilDatabaseException("Invalid table name '" . $table_name . "'. Maximum table identifer length is 22 bytes.");
                 }
 
                 return true;
         }

Here is the call graph for this function:

◆ compareBLOBDefinition()

ilDBPdoFieldDefinition::compareBLOBDefinition	(	$current,
		$previous
	)

protected

Parameters

$current
$previous

Returns: array

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

References compareTextDefinition().

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

Here is the call graph for this function:

◆ compareBooleanDefinition()

ilDBPdoFieldDefinition::compareBooleanDefinition	(	$current,
		$previous
	)

protected

Parameters

$current
$previous

Returns: array

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

References array.

                                                                          {
                 return array();
         }

◆ compareCLOBDefinition()

ilDBPdoFieldDefinition::compareCLOBDefinition	(	$current,
		$previous
	)

protected

Parameters

$current
$previous

Returns: array

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

References compareTextDefinition().

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

Here is the call graph for this function:

◆ compareDateDefinition()

ilDBPdoFieldDefinition::compareDateDefinition	(	$current,
		$previous
	)

protected

Parameters

$current
$previous

Returns: array

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

References array.

                                                                       {
                 return array();
         }

◆ compareDecimalDefinition()

ilDBPdoFieldDefinition::compareDecimalDefinition	(	$current,
		$previous
	)

protected

Parameters

$current
$previous

Returns: array

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

References array.

                                                                          {
                 return array();
         }

◆ compareDefinition()

ilDBPdoFieldDefinition::compareDefinition	(	$current,
		$previous
	)

Parameters

$current
$previous

Returns: |mixed

Exceptions

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

References array, and getDBInstance().

                                                                {
                 $type = !empty($current['type']) ? $current['type'] : null;
 
                 if (!method_exists($this, "compare{$type}Definition")) {
                         $db = $this->getDBInstance();
 
                         if (!empty($db->options['datatype_map_callback'][$type])) {
                                 $parameter = array( 'current' => $current, 'previous' => $previous );
                                 $change = call_user_func_array($db->options['datatype_map_callback'][$type], array( &$db, __FUNCTION__, $parameter ));
 
                                 return $change;
                         }
 
                         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']) ? $previous['notnull'] : false;
                 $notnull = !empty($current['notnull']) ? $current['notnull'] : false;
                 if ($previous_notnull != $notnull) {
                         $change['notnull'] = true;
                 }
 
                 $previous_default = array_key_exists('default', $previous) ? $previous['default'] : ($previous_notnull ? '' : null);
                 $default = array_key_exists('default', $current) ? $current['default'] : ($notnull ? '' : null);
                 if ($previous_default !== $default) {
                         $change['default'] = true;
                 }
 
                 return $change;
         }

Here is the call graph for this function:

◆ compareFloatDefinition()

ilDBPdoFieldDefinition::compareFloatDefinition	(	$current,
		$previous
	)

protected

Parameters

$current
$previous

Returns: array

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

References array.

                                                                        {
                 return array();
         }

◆ compareIntegerDefinition()

ilDBPdoFieldDefinition::compareIntegerDefinition	(	$current,
		$previous
	)

protected

Parameters

$current
$previous

Returns: array

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

References array.

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

◆ compareTextDefinition()

ilDBPdoFieldDefinition::compareTextDefinition	(	$current,
		$previous
	)

protected

Parameters

$current
$previous

Returns: array

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

References array.

Referenced by compareBLOBDefinition(), and compareCLOBDefinition().

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

Here is the caller graph for this function:

◆ compareTimeDefinition()

ilDBPdoFieldDefinition::compareTimeDefinition	(	$current,
		$previous
	)

protected

Parameters

$current
$previous

Returns: array

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

References array.

                                                                       {
                 return array();
         }

◆ compareTimestampDefinition()

ilDBPdoFieldDefinition::compareTimestampDefinition	(	$current,
		$previous
	)

protected

Parameters

$current
$previous

Returns: array

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

References array.

                                                                            {
                 return array();
         }

◆ convertResult()

ilDBPdoFieldDefinition::convertResult	(	$value,
		$type,
		$rtrim = `true`
	)

Parameters

	$value
	$type
bool	$rtrim

Returns: bool|float|int|mixed|null|resource|string

Exceptions

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

References array, baseConvertResult(), and getDBInstance().

Referenced by convertResultRow().

                                                                     {
                 if (is_null($value)) {
                         return null;
                 }
                 $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 = array( 'type' => $type, 'value' => $value, 'rtrim' => $rtrim );
 
                                 return call_user_func_array($db->options['datatype_map_callback'][$type], array( &$db, __FUNCTION__, $parameter ));
                         }
                 }
 
                 return $this->baseConvertResult($value, $type, $rtrim);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ convertResultRow()

ilDBPdoFieldDefinition::convertResultRow	(	$types,
		$row,
		$rtrim = `true`
	)

Parameters

	$types
	$row
bool	$rtrim

Returns: bool|float|int|mixed|null|resource|string

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

References $row, convertResult(), and sortResultFieldTypes().

                                                                       {
                 $types = $this->sortResultFieldTypes(array_keys($row), $types);
                 foreach ($row as $key => $value) {
                         if (empty($types[$key])) {
                                 continue;
                         }
                         $value = $this->convertResult($row[$key], $types[$key], $rtrim);
 
                         $row[$key] = $value;
                 }
 
                 return $row;
         }

Here is the call graph for this function:

◆ destroyLOB()

ilDBPdoFieldDefinition::destroyLOB ( $lob )

Parameters

$lob

Returns: bool

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

References destroyLOBInternal().

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

Here is the call graph for this function:

◆ destroyLOBInternal()

ilDBPdoFieldDefinition::destroyLOBInternal ( & $lob )

protected

Parameters

$lob

Returns: bool

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

Referenced by destroyLOB().

                                                      {
                 return true;
         }

Here is the caller graph for this function:

◆ endOfLOB()

ilDBPdoFieldDefinition::endOfLOB ( $lob )

protected

Parameters

$lob

Returns: mixed

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

                                           {
                 return $lob['endOfLOB'];
         }

◆ getAllowedAttributes()

ilDBPdoFieldDefinition::getAllowedAttributes ( )

Returns: array

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

References $allowed_attributes.

Referenced by checkColumnDefinition().

                                                {
                 return $this->allowed_attributes;
         }

Here is the caller graph for this function:

◆ getAllReserved()

ilDBPdoFieldDefinition::getAllReserved ( )

Returns: array

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

References getReservedMysql(), getReservedOracle(), and getReservedPostgres().

Referenced by isReserved().

                                          {
                 return array_merge($this->getReservedMysql(), $this->getReservedOracle(), $this->getReservedPostgres());
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAvailableTypes()

ilDBPdoFieldDefinition::getAvailableTypes ( )

Returns: array

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

References $available_types.

Referenced by checkColumnDefinition().

                                             {
                 return $this->available_types;
         }

Here is the caller graph for this function:

◆ getBLOBDeclaration()

ilDBPdoFieldDefinition::getBLOBDeclaration	(	$name,
		$field
	)

protected

Parameters

$name
$field

Returns: |string

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

References getDBInstance(), and getTypeDeclaration().

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

Here is the call graph for this function:

◆ getBooleanDeclaration()

ilDBPdoFieldDefinition::getBooleanDeclaration	(	$name,
		$field
	)

protected

Parameters

$name
$field

Returns: |string

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

References getInternalDeclaration().

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

Here is the call graph for this function:

◆ getCharsetFieldDeclaration()

ilDBPdoFieldDefinition::getCharsetFieldDeclaration ( $charset )

protected

Parameters

$charset

Returns: string

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

Referenced by getDeclarationOptions().

                                                                 {
                 return '';
         }

Here is the caller graph for this function:

◆ getCLOBDeclaration()

ilDBPdoFieldDefinition::getCLOBDeclaration	(	$name,
		$field
	)

protected

Parameters

$name
$field

Returns: |string

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

References getDBInstance(), and getTypeDeclaration().

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

Here is the call graph for this function:

◆ getCollationFieldDeclaration()

ilDBPdoFieldDefinition::getCollationFieldDeclaration ( $collation )

protected

Parameters

$collation

Returns: string

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

Referenced by getDeclarationOptions().

                                                                     {
                 return '';
         }

Here is the caller graph for this function:

◆ getDateDeclaration()

ilDBPdoFieldDefinition::getDateDeclaration	(	$name,
		$field
	)

protected

Parameters

$name
$field

Returns: |string

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

References getInternalDeclaration().

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

Here is the call graph for this function:

◆ getDBInstance()

ilDBPdoFieldDefinition::getDBInstance ( )

protected

Returns

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

References $db_instance.

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

                                            {
                 return $this->db_instance;
         }

Here is the caller graph for this function:

◆ getDecimalDeclaration()

ilDBPdoFieldDefinition::getDecimalDeclaration	(	$name,
		$field
	)

protected

Parameters

$name
$field

Returns: |string

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

References getInternalDeclaration().

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

Here is the call graph for this function:

◆ getDeclaration()

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

Parameters

$type
$name
$field

Returns: |mixed

Exceptions

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

References array, and getDBInstance().

                                                              {
                 $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 = array( 'type' => $type, 'name' => $name, 'field' => $field );
 
                                 return call_user_func_array($db->options['datatype_map_callback'][$type], array( &$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);
         }

Here is the call graph for this function:

◆ getDeclarationOptions()

ilDBPdoFieldDefinition::getDeclarationOptions ( $field )

protected

Parameters

$field

Returns: |string

Exceptions

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

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

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

Here is the call graph for this function:

◆ getFloatDeclaration()

ilDBPdoFieldDefinition::getFloatDeclaration	(	$name,
		$field
	)

protected

Parameters

$name
$field

Returns: |string

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

References getInternalDeclaration().

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

Here is the call graph for this function:

◆ getIntegerDeclaration()

ilDBPdoFieldDefinition::getIntegerDeclaration	(	$name,
		$field
	)

protected

Parameters

$name
$field

Returns: ||mixed

Exceptions

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

References getDBInstance(), and getInternalDeclaration().

                                                                 {
                 if (!empty($field['unsigned'])) {
                         $db = $this->getDBInstance();
 
                         $db->warnings[] = "unsigned integer field \"$name\" is being declared as signed integer";
                 }
 
                 return $this->getInternalDeclaration($name, $field);
         }

Here is the call graph for this function:

◆ getInternalDeclaration()

ilDBPdoFieldDefinition::getInternalDeclaration	(	$name,
		$field
	)

protected

Parameters

$name
$field

Returns: |string

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

References getDBInstance(), and getTypeDeclaration().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMaxLength()

ilDBPdoFieldDefinition::getMaxLength ( )

Returns: array

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

References $max_length.

Referenced by checkColumnDefinition().

                                        {
                 return $this->max_length;
         }

Here is the caller graph for this function:

◆ getQueryUtils()

ilDBPdoFieldDefinition::getQueryUtils ( )

protected

Returns

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

References $query_utils.

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

◆ getReservedMysql()

ilDBPdoFieldDefinition::getReservedMysql ( )

Returns: array

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

References $reserved_mysql.

Referenced by getAllReserved().

                                            {
                 return $this->reserved_mysql;
         }

Here is the caller graph for this function:

◆ getReservedOracle()

ilDBPdoFieldDefinition::getReservedOracle ( )

Returns: array

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

References $reserved_oracle.

Referenced by getAllReserved().

                                             {
                 return $this->reserved_oracle;
         }

Here is the caller graph for this function:

◆ getReservedPostgres()

ilDBPdoFieldDefinition::getReservedPostgres ( )

Returns: array

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

References $reserved_postgres.

Referenced by getAllReserved().

                                               {
                 return $this->reserved_postgres;
         }

Here is the caller graph for this function:

◆ getTextDeclaration()

ilDBPdoFieldDefinition::getTextDeclaration	(	$name,
		$field
	)

protected

Parameters

$name
$field

Returns: |mixed

Exceptions

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

References getInternalDeclaration().

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

Here is the call graph for this function:

◆ getTimeDeclaration()

ilDBPdoFieldDefinition::getTimeDeclaration	(	$name,
		$field
	)

protected

Parameters

$name
$field

Returns: |string

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

References getInternalDeclaration().

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

Here is the call graph for this function:

◆ getTimestampDeclaration()

ilDBPdoFieldDefinition::getTimestampDeclaration	(	$name,
		$field
	)

protected

Parameters

$name
$field

Returns: |string

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

References getInternalDeclaration().

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

Here is the call graph for this function:

◆ getTypeDeclaration()

ilDBPdoFieldDefinition::getTypeDeclaration ( $field )

Parameters

$field

Returns: |string

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

References getDBInstance().

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

                                                    {
                 $db = $this->getDBInstance();
 
                 switch ($field['type']) {
                         case 'text':
                                 $length = !empty($field['length']) ? $field['length'] : $db->options['default_text_field_length'];
                                 $fixed = !empty($field['fixed']) ? $field['fixed'] : false;
 
                                 return $fixed ? ($length ? 'CHAR(' . $length . ')' : 'CHAR(' . $db->options['default_text_field_length']
                                                                                      . ')') : ($length ? 'VARCHAR(' . $length . ')' : 'TEXT');
                         case 'clob':
                                 return 'TEXT';
                         case 'blob':
                                 return 'TEXT';
                         case 'integer':
                                 return 'INT';
                         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') . ')';
                         case 'float':
                                 return 'TEXT';
                         case 'decimal':
                                 return 'TEXT';
                 }
 
                 return '';
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValidTypes()

ilDBPdoFieldDefinition::getValidTypes ( )

Returns: array

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

References $valid_default_values, array, and getDBInstance().

Referenced by getDeclarationOptions().

                                         {
                 $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 = array( 'type' => $type, 'mapped_type' => $mapped_type );
                                         $default = call_user_func_array($db->options['datatype_map_callback'][$type], array( &$db, __FUNCTION__, $parameter ));
                                         $types[$type] = $default;
                                 }
                         }
                 }
 
                 return $types;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ implodeArray()

ilDBPdoFieldDefinition::implodeArray	(	$array,
		$type = `false`
	)

Parameters

	$array
bool	$type

Returns: string

Exceptions

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

References quote().

                                                             {
                 if (!is_array($array) || empty($array)) {
                         return 'NULL';
                 }
                 if ($type) {
                         foreach ($array as $value) {
                                 $return[] = $this->quote($value, $type);
                         }
                 } else {
                         $return = $array;
                 }
 
                 return implode(', ', $return);
         }

Here is the call graph for this function:

◆ isAllowedAttribute()

ilDBPdoFieldDefinition::isAllowedAttribute	(	$attribute,
		$type
	)

Parameters

$attribute
$type

Returns: bool

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

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

◆ isReserved()

ilDBPdoFieldDefinition::isReserved ( $table_name )

Parameters

$table_name

Returns: bool

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

References getAllReserved().

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

                                                 {
                 return in_array(strtoupper($table_name), $this->getAllReserved());
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mapNativeDatatype()

ilDBPdoFieldDefinition::mapNativeDatatype ( $field )

Parameters

$field

Returns: |mixed

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

References array, getDBInstance(), and mapNativeDatatypeInternal().

                                                   {
                 $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], array( $db, $field ));
                 }
 
                 return $this->mapNativeDatatypeInternal($field);
         }

Here is the call graph for this function:

◆ mapNativeDatatypeInternal()

ilDBPdoFieldDefinition::mapNativeDatatypeInternal ( $field )

abstractprotected

Parameters

$field

Returns

Exceptions

Referenced by mapNativeDatatype().

Here is the caller graph for this function:

◆ mapPrepareDatatype()

ilDBPdoFieldDefinition::mapPrepareDatatype ( $type )

Parameters

$type

Returns: |mixed

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

References array, and getDBInstance().

                                                   {
                 $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 = array( 'type' => $type );
 
                                 return call_user_func_array($db->options['datatype_map_callback'][$type], array( &$db, __FUNCTION__, $parameter ));
                         }
                 }
 
                 return $type;
         }

Here is the call graph for this function:

◆ matchPattern()

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

Parameters

	$pattern
null	$operator
null	$field

Returns: |string

Exceptions

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

References getDBInstance(), and patternEscapeString().

                                                                                 {
                 $db = $this->getDBInstance();
 
                 $match = '';
                 if (!is_null($operator)) {
                         $operator = strtoupper($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', null, true);
                                         $match = $db->function->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) {
                                 $match .= $value;
                         } else {
                                 if ($operator === 'ILIKE') {
                                         $value = strtolower($value);
                                 }
                                 $escaped = $db->escape($value);
                                 $match .= $db->escapePattern($escaped);
                         }
                 }
                 $match .= "'";
                 $match .= $this->patternEscapeString();
 
                 return $match;
         }

Here is the call graph for this function:

◆ patternEscapeString()

ilDBPdoFieldDefinition::patternEscapeString ( )

Returns: string

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

Referenced by matchPattern(), and quote().

                                               {
                 return '';
         }

Here is the caller graph for this function:

◆ quote()

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

Parameters

	$value
null	$type
bool	$quote
bool	$escape_wildcards

Returns: |mixed|string

Exceptions

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

References array, getDBInstance(), MDB2_PORTABILITY_EMPTY_TO_NULL, and patternEscapeString().

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

                                                                                               {
                 $db = $this->getDBInstance();
 
                 return $db->quote($value, $type);
 
                 if (is_null($value)
                     || ($value === '' && $db->options['portability'] & MDB2_PORTABILITY_EMPTY_TO_NULL)
                 ) {
                         if (!$quote) {
                                 return null;
                         }
 
                         return 'NULL';
                 }
 
                 if (is_null($type)) {
                         switch (gettype($value)) {
                                 case 'integer':
                                         $type = 'integer';
                                         break;
                                 case 'double':
                                         // todo: default to decimal as float is quite unusual
                                         // $type = 'float';
                                         $type = 'decimal';
                                         break;
                                 case 'boolean':
                                         $type = 'boolean';
                                         break;
                                 case 'array':
                                         $value = serialize($value);
                                 case 'object':
                                         $type = 'text';
                                         break;
                                 default:
                                         if (preg_match('/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}$/', $value)) {
                                                 $type = 'timestamp';
                                         } elseif (preg_match('/^\d{2}:\d{2}$/', $value)) {
                                                 $type = 'time';
                                         } elseif (preg_match('/^\d{4}-\d{2}-\d{2}$/', $value)) {
                                                 $type = 'date';
                                         } else {
                                                 $type = 'text';
                                         }
                                         break;
                         }
                 } elseif (!empty($db->options['datatype_map'][$type])) {
                         $type = $db->options['datatype_map'][$type];
                         if (!empty($db->options['datatype_map_callback'][$type])) {
                                 $parameter = array( 'type' => $type, 'value' => $value, 'quote' => $quote, 'escape_wildcards' => $escape_wildcards );
 
                                 return call_user_func_array($db->options['datatype_map_callback'][$type], array( &$db, __FUNCTION__, $parameter ));
                         }
                 }
 
                 if (!method_exists($this, "quote{$type}")) {
                         throw new ilDatabaseException('type not defined: ' . $type);
                 }
                 $value = $this->{"quote{$type}"}($value, $quote, $escape_wildcards);
                 if ($quote && $escape_wildcards && $db->string_quoting['escape_pattern']
                     && $db->string_quoting['escape'] !== $db->string_quoting['escape_pattern']
                 ) {
                         $value .= $this->patternEscapeString();
                 }
 
                 return $value;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ quoteBLOB()

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

protected

Parameters

$value
$quote
$escape_wildcards

Returns: |string

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

References quoteLOB().

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

Here is the call graph for this function:

◆ quoteBoolean()

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

protected

Parameters

$value
$quote
$escape_wildcards

Returns: int

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

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

◆ quoteCLOB()

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

protected

Parameters

$value
$quote
$escape_wildcards

Returns: |string

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

References quoteLOB().

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

Here is the call graph for this function:

◆ quoteDate()

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

protected

Parameters

$value
$quote
$escape_wildcards

Returns: |string

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

References getDBInstance(), and quoteText().

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

Here is the call graph for this function:

◆ quoteDecimal()

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

protected

Parameters

$value
$quote
$escape_wildcards

Returns: mixed|string

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

References string.

Referenced by quoteFloat().

                                                                            {
                 $value = (string)$value;
                 $value = preg_replace('/[^\d\.,\-+eE]/', '', $value);
                 if (preg_match('/[^.0-9]/', $value)) {
                         if (strpos($value, ',')) {
                                 // 1000,00
                                 if (!strpos($value, '.')) {
                                         // convert the last "," to a "."
                                         $value = strrev(str_replace(',', '.', strrev($value)));
                                         // 1.000,00
                                 } elseif (strpos($value, '.') && strpos($value, '.') < strpos($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;
         }

Here is the caller graph for this function:

◆ quoteFloat()

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

protected

Parameters

$value
$quote
$escape_wildcards

Returns: string

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

References quoteDecimal().

                                                                          {
                 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);
                         $value = $decimal . 'E' . $sign . $exponent;
                 } else {
                         $value = $this->quoteDecimal($value, $quote, $escape_wildcards);
                 }
 
                 return $value;
         }

Here is the call graph for this function:

◆ quoteInteger()

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

protected

Parameters

$value
$quote
$escape_wildcards

Returns: int

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

                                                                            {
                 return (int)$value;
         }

◆ quoteLOB()

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

protected

Parameters

$value
$quote
$escape_wildcards

Returns: |string

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

References quoteText(), and readFile().

Referenced by quoteBLOB(), and quoteCLOB().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ quoteText()

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

protected

Parameters

$value
$quote
$escape_wildcards

Returns: |string

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

References getDBInstance().

Referenced by quoteDate(), quoteLOB(), quoteTime(), and quoteTimestamp().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ quoteTime()

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

protected

Parameters

$value
$quote
$escape_wildcards

Returns: |string

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

References getDBInstance(), and quoteText().

                                                                         {
                 if ($value === 'CURRENT_TIME') {
                         $db = $this->getDBInstance();
 
                         if (isset($db->function) && is_a($db->function, 'MDB2_Driver_Function_Common')) {
                                 return $db->function->now('time');
                         }
 
                         return 'CURRENT_TIME';
                 }
 
                 return $this->quoteText($value, $quote, $escape_wildcards);
         }

Here is the call graph for this function:

◆ quoteTimestamp()

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

protected

Parameters

$value
$quote
$escape_wildcards

Returns: |string

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

References getDBInstance(), and quoteText().

                                                                              {
                 if ($value === 'CURRENT_TIMESTAMP') {
                         $db = $this->getDBInstance();
 
                         if (isset($db->function) && is_a($db->function, 'MDB2_Driver_Function_Common')) {
                                 return $db->function->now('timestamp');
                         }
 
                         return 'CURRENT_TIMESTAMP';
                 }
 
                 return $this->quoteText($value, $quote, $escape_wildcards);
         }

Here is the call graph for this function:

◆ readFile()

ilDBPdoFieldDefinition::readFile ( $value )

protected

Parameters

$value

Returns: |string

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

References getDBInstance().

Referenced by quoteLOB().

                                             {
                 $close = false;
                 if (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;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readLOB()

ilDBPdoFieldDefinition::readLOB	(	$lob,
		$length
	)

protected

Parameters

$lob
$length

Returns: string

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

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

◆ retrieveLOB()

ilDBPdoFieldDefinition::retrieveLOB ( & $lob )

protected

Parameters

$lob

Returns: bool

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

References MDB2_OK.

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

◆ setAllowedAttributes()

ilDBPdoFieldDefinition::setAllowedAttributes ( $allowed_attributes )

Parameters

array $allowed_attributes

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

References $allowed_attributes.

                                                                   {
                 $this->allowed_attributes = $allowed_attributes;
         }

◆ setAvailableTypes()

ilDBPdoFieldDefinition::setAvailableTypes ( $available_types )

Parameters

array $available_types

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

References $available_types.

                                                             {
                 $this->available_types = $available_types;
         }

◆ setMaxLength()

ilDBPdoFieldDefinition::setMaxLength ( $max_length )

Parameters

array $max_length

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

References $max_length.

                                                   {
                 $this->max_length = $max_length;
         }

◆ setReservedMysql()

ilDBPdoFieldDefinition::setReservedMysql ( $reserved_mysql )

Parameters

array $reserved_mysql

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

References $reserved_mysql.

                                                           {
                 $this->reserved_mysql = $reserved_mysql;
         }

◆ setReservedOracle()

ilDBPdoFieldDefinition::setReservedOracle ( $reserved_oracle )

Parameters

array $reserved_oracle

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

References $reserved_oracle.

                                                             {
                 $this->reserved_oracle = $reserved_oracle;
         }

◆ setReservedPostgres()

ilDBPdoFieldDefinition::setReservedPostgres ( $reserved_postgres )

Parameters

array $reserved_postgres

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

References $reserved_postgres.

                                                                 {
                 $this->reserved_postgres = $reserved_postgres;
         }

◆ sortResultFieldTypes()

ilDBPdoFieldDefinition::sortResultFieldTypes	(	$columns,
		$types
	)

protected

Parameters

$columns
$types

Returns: array

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

References $columns, and array.

Referenced by convertResultRow().

                                                                   {
                 $n_cols = count($columns);
                 $n_types = count($types);
                 if ($n_cols > $n_types) {
                         for ($i = $n_cols - $n_types; $i >= 0; $i --) {
                                 $types[] = null;
                         }
                 }
                 $sorted_types = array();
                 foreach ($columns as $col) {
                         $sorted_types[$col] = null;
                 }
                 foreach ($types as $name => $type) {
                         if (array_key_exists($name, $sorted_types)) {
                                 $sorted_types[$name] = $type;
                                 unset($types[$name]);
                         }
                 }
                 // if there are left types in the array, fill the null values of the
                 // sorted array with them, in order.
                 if (count($types)) {
                         reset($types);
                         foreach (array_keys($sorted_types) as $k) {
                                 if (is_null($sorted_types[$k])) {
                                         $sorted_types[$k] = current($types);
                                         next($types);
                                 }
                         }
                 }
 
                 return $sorted_types;
         }

Here is the caller graph for this function:

◆ writeLOBToFile()

ilDBPdoFieldDefinition::writeLOBToFile	(	$lob,
		$file
	)

Parameters

$lob
$file

Returns: bool|

Exceptions

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

References $file, $read, $result, getDBInstance(), and MDB2_OK.

                                                     {
                 $db = $this->getDBInstance();
 
                 if (preg_match('/^(\w+:\/\/)(.*)$/', $file, $match)) {
                         if ($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 MDB2_OK;
         }

Here is the call graph for this function:

Field Documentation

◆ $allowed_attributes

ilDBPdoFieldDefinition::$allowed_attributes

Initial value:

= array(
                "text"      => array( "length", "notnull", "default", "fixed" ),
                "integer"   => array( "length", "notnull", "default", "unsigned" ),
                "float"     => array( "notnull", "default" ),
                "date"      => array( "notnull", "default" ),
                "time"      => array( "notnull", "default" ),
                "timestamp" => array( "notnull", "default" ),
                "clob"      => array( "length", "notnull", "default" ),
                "blob"      => array( "length", "notnull", "default" ),
        )

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

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

◆ $allowed_attributes_old

ilDBPdoFieldDefinition::$allowed_attributes_old

Initial value:

= array(
                self::T_TEXT      => array( 'length', 'notnull', 'default', 'fixed' ),
                self::T_INTEGER   => array( 'length', 'notnull', 'default', 'unsigned' ),
                self::T_FLOAT     => array( 'notnull', 'default' ),
                self::T_DATE      => array( 'notnull', 'default' ),
                self::T_TIME      => array( 'notnull', 'default' ),
                self::T_TIMESTAMP => array( 'notnull', 'default' ),
                self::T_CLOB      => array( 'notnull', 'default' ),
                self::T_BLOB      => array( 'notnull', 'default' ),
        )

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

◆ $available_types

ilDBPdoFieldDefinition::$available_types

protected

Initial value:

= array(
                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 70 of file class.ilDBPdoFieldDefinition.php.

Referenced by getAvailableTypes(), and setAvailableTypes().

◆ $db_instance

ilDBPdoFieldDefinition::$db_instance

protected

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

Referenced by getDBInstance().

◆ $instance

ilDBPdoFieldDefinition::$instance

staticprotected

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

◆ $max_length

ilDBPdoFieldDefinition::$max_length

protected

Initial value:

= array(
                self::T_INTEGER => array( 1, 2, 3, 4, 8 ),
                self::T_TEXT    => 4000,
        )

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

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

◆ $query_utils

ilDBPdoFieldDefinition::$query_utils

protected

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

Referenced by getQueryUtils().

◆ $reserved_mysql

ilDBPdoFieldDefinition::$reserved_mysql

protected

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

Referenced by getReservedMysql(), and setReservedMysql().

◆ $reserved_oracle

ilDBPdoFieldDefinition::$reserved_oracle

protected

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

Referenced by getReservedOracle(), and setReservedOracle().

◆ $reserved_postgres

ilDBPdoFieldDefinition::$reserved_postgres

protected

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

Referenced by getReservedPostgres(), and setReservedPostgres().

◆ $valid_default_values

ilDBPdoFieldDefinition::$valid_default_values

protected

Initial value:

= array(
                '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'      => '',
        )