ilDBPdo Class Reference

Class pdoDB. More...

Inheritance diagram for ilDBPdo:

Collaboration diagram for ilDBPdo:

Public Member Functions
	connect ($return_false_for_error=false)
	initHelpers ()
	getFieldDefinition ()
	setFieldDefinition ($field_definition)
	createDatabase ($a_name, $a_charset="utf8", $a_collation="")
	getLastErrorCode ()
	initFromIniFile ($tmpClientIniFile=null)
	generateDSN ()
	quoteIdentifier ($identifier, $check_option=false)
	nextId ($table_name)
	createTable ($table_name, $fields, $drop_table=false, $ignore_erros=false)
	checkColumnName ($a_name)
	addPrimaryKey ($table_name, $primary_keys)
	dropIndexByFields ($table_name, $fields)
	getPrimaryKeyIdentifier ()
	createSequence ($table_name, $start=1)
	tableExists ($table_name)
	tableColumnExists ($table_name, $column_name)
	addTableColumn ($table_name, $column_name, $attributes)
	dropTable ($table_name, $error_if_not_existing=true)
	query ($query)
	dropSequence ($table_name)
	dropTableColumn ($table_name, $column_name)
	renameTableColumn ($table_name, $column_old_name, $column_new_name)
	insert ($table_name, $values)
	fetchObject ($query_result)
	update ($table_name, $columns, $where)
	manipulate ($query)
	fetchAssoc ($query_result)
	numRows ($query_result)
	quote ($value, $type=null)
	indexExistsByFields ($table_name, $fields)
	addIndex ($table_name, $fields, $index_name='', $fulltext=false)
	addFulltextIndex ($a_table, $a_fields, $a_name="in")
	dropFulltextIndex ($a_table, $a_name)
	Drop fulltext index. More...
	isFulltextIndex ($a_table, $a_name)
	Is index a fulltext index? More...
	getIndexName ($index_name_base)
	getSequenceName ($table_name)
	constraintName ($a_table, $a_constraint)
	Determine contraint name by table name and constraint name. More...
	getDSN ()
	getDBType ()
	setDBType ($type)
	lockTables ($tables)
	unlockTables ()
	in ($field, $values, $negate=false, $type="")
	queryF ($query, $types, $values)
	manipulateF ($query, $types, $values)
	useSlave ($bool)
	setLimit ($limit, $offset=0)
	Set the Limit for the next Query. More...
	like ($column, $type, $value="?", $case_insensitive=true)
	now ()
	replace ($table, $primaryKeys, $otherColumns)
	Replace into method. More...
	equals ($columns, $value, $type, $emptyOrNull=false)
	getHost ()
	setHost ($host)
	getDbname ()
	setDbname ($dbname)
	getCharset ()
	setCharset ($charset)
	getUsername ()
	setUsername ($username)
	getPassword ()
	setPassword ($password)
	getPort ()
	setPort ($port)
	setDBUser ($user)
	setDBPort ($port)
	setDBPassword ($password)
	setDBHost ($host)
	upper ($a_exp)
	lower ($a_exp)
	substr ($a_exp, $a_pos=1, $a_len=-1)
	prepareManip ($query, $types=null)
	prepare ($query, $types=null, $result_types=null)
	enableResultBuffering ($a_status)
	supportsSlave ()
	supportsFulltext ()
	supportsTransactions ()
	supports ($feature)
	listTables ()
	loadModule ($module)
	getAllowedAttributes ()
	Returns array More...
	sequenceExists ($sequence)
	listSequences ()
	concat (array $values, $allow_null=true)
	locate ($a_needle, $a_string, $a_start_pos=1)
	modifyTableColumn ($table, $a_column, $a_attributes)
	renameTable ($a_name, $a_new_name)
	checkTableName ($a_name)
	beginTransaction ()
	commit ()
	rollback ()
	dropIndex ($a_table, $a_name="i1")
	setStorageEngine ($storage_engine)
	getStorageEngine ()
	queryCol ($query, $type=PDO::FETCH_ASSOC, $colnum=0)
	queryRow ($query, $types=null, $fetchmode=ilDBConstants::FETCHMODE_DEFAULT)
	getServerVersion ($native=false)
	escape ($value, $escape_wildcards=false)
	escapePattern ($text)
	migrateAllTablesToEngine ($engine=ilDBConstants::MYSQL_ENGINE_INNODB)
	migrateAllTablesToCollation ($collation=ilDBConstants::MYSQL_COLLATION_UTF8MB4)
	@inheritDoc More...
	supportsCollationMigration ()
	@inheritDoc More...
	supportsEngineMigration ()
	checkIndexName ($name)
	addUniqueConstraint ($table, $fields, $name="con")
	dropUniqueConstraint ($a_table, $a_name="con")
	dropUniqueConstraintByFields ($a_table, $a_fields)
	getLastInsertId ()
	buildAtomQuery ()
	uniqueConstraintExists ($table, array $fields)
	dropPrimaryKey ($table_name)
	executeMultiple ($stmt, $a_data)
	fromUnixtime ($a_expr, $a_to_text=true)
	unixTimestamp ()
	autoExecute ($tablename, $fields, $mode=ilDBConstants::AUTOQUERY_INSERT, $where=false)
	Generate an insert, update or delete query and call prepare() and execute() on it. More...
	getDBVersion ()
	sanitizeMB4StringIfNotSupported ($query)
	Parameters $query string to sanitize, all MB4-Characters like emojis will re replaced with ??? Returns string sanitized query More...
	doesCollationSupportMB4Strings ()
	@inheritDoc More...
	groupConcat ($a_field_name, $a_seperator=",", $a_order=null)
	Parameters string $a_field_name string $a_seperator string $a_order Returns string More...
	cast ($a_field_name, $a_dest_type)
	Parameters string $a_field_name string $a_dest_type Returns string; More...
Public Member Functions inherited from ilDBInterface
	doesCollationSupportMB4Strings ()
	sanitizeMB4StringIfNotSupported ($query)
	initFromIniFile ($tmpClientIniFile=null)
	connect ($return_false_on_error=false)
	nextId ($table_name)
	createTable ($table_name, $fields, $drop_table=false, $ignore_erros=false)
	addPrimaryKey ($table_name, $primary_keys)
	createSequence ($table_name, $start=1)
	getSequenceName ($table_name)
	tableExists ($table_name)
	tableColumnExists ($table_name, $column_name)
	addTableColumn ($table_name, $column_name, $attributes)
	dropTable ($table_name, $error_if_not_existing=true)
	renameTable ($old_name, $new_name)
	query ($query)
	Run a (read-only) Query on the database. More...
	fetchAll ($query_result, $fetch_mode=ilDBConstants::FETCHMODE_ASSOC)
	dropSequence ($table_name)
	dropTableColumn ($table_name, $column_name)
	renameTableColumn ($table_name, $column_old_name, $column_new_name)
	insert ($table_name, $values)
	fetchObject ($query_result)
	update ($table_name, $values, $where)
	manipulate ($query)
	Run a (write) Query on the database. More...
	fetchAssoc ($query_result)
	numRows ($query_result)
	quote ($value, $type)
	addIndex ($table_name, $fields, $index_name='', $fulltext=false)
	indexExistsByFields ($table_name, $fields)
	getDSN ()
	Get DSN. More...
	getDBType ()
	Get DSN. More...
	lockTables ($tables)
	Abstraction of lock table. More...
	unlockTables ()
	Unlock tables locked by previous lock table calls. More...
	in ($field, $values, $negate=false, $type="")
	queryF ($query, $types, $values)
	manipulateF ($query, $types, $values)
	useSlave ($bool)
	Return false iff slave is not supported. More...
	setLimit ($limit, $offset)
	like ($column, $type, $value="?", $case_insensitive=true)
	Generate a like subquery. More...
	now ()
	replace ($table, $primaryKeys, $otherColumns)
	Replace into method. More...
	equals ($columns, $value, $type, $emptyOrNull=false)
	setDBUser ($user)
	setDBPort ($port)
	setDBPassword ($password)
	setDBHost ($host)
	upper ($a_exp)
	lower ($a_exp)
	substr ($a_exp)
	prepare ($a_query, $a_types=null, $a_result_types=null)
	Prepare a query (SELECT) statement to be used with execute. More...
	prepareManip ($a_query, $a_types=null)
	enableResultBuffering ($a_status)
	execute ($stmt, $data=array())
	sequenceExists ($sequence)
	listSequences ()
	supports ($feature)
	supportsFulltext ()
	supportsSlave ()
	supportsTransactions ()
	listTables ()
	loadModule ($module)
	getAllowedAttributes ()
	concat (array $values, $allow_null=true)
	locate ($a_needle, $a_string, $a_start_pos=1)
	quoteIdentifier ($identifier, $check_option=false)
	modifyTableColumn ($table, $column, $attributes)
	free ($a_st)
	checkTableName ($a_name)
	beginTransaction ()
	commit ()
	rollback ()
	constraintName ($a_table, $a_constraint)
	dropIndex ($a_table, $a_name="i1")
	createDatabase ($a_name, $a_charset="utf8", $a_collation="")
	dropIndexByFields ($table_name, $afields)
	getPrimaryKeyIdentifier ()
	addFulltextIndex ($table_name, $afields, $a_name='in')
	dropFulltextIndex ($a_table, $a_name)
	isFulltextIndex ($a_table, $a_name)
	setStorageEngine ($storage_engine)
	getStorageEngine ()
	buildAtomQuery ()
	groupConcat ($a_field_name, $a_seperator=",", $a_order=null)
	cast ($a_field_name, $a_dest_type)
	getServerVersion ($native=false)
	queryCol ($query, $type=ilDBConstants::FETCHMODE_DEFAULT, $colnum=0)
	queryRow ($query, $types=null, $fetchmode=ilDBConstants::FETCHMODE_DEFAULT)
	escape ($value, $escape_wildcards=false)
	escapePattern ($text)
	migrateAllTablesToEngine ($engine=ilDBConstants::MYSQL_ENGINE_INNODB)
	supportsEngineMigration ()
	migrateAllTablesToCollation ($collation=ilDBConstants::MYSQL_COLLATION_UTF8MB4)
	supportsCollationMigration ()
	addUniqueConstraint ($table, $fields, $name="con")
	dropUniqueConstraint ($table, $name="con")
	dropUniqueConstraintByFields ($table, $fields)
	checkIndexName ($name)
	getLastInsertId ()
	prepare ($query, $types=null, $result_types=null)
	uniqueConstraintExists ($table, array $fields)
	dropPrimaryKey ($table_name)
	executeMultiple ($stmt, $data)
	fromUnixtime ($expr, $to_text=true)
	unixTimestamp ()
	autoExecute ($tablename, $fields, $mode=ilDBConstants::AUTOQUERY_INSERT, $where=false)
	Generate an insert, update or delete query and call prepare() and execute() on it. More...
	getDBVersion ()
	returns the Version of the Database (e.g. More...

Static Public Member Functions
static	isReservedWord ($a_word)
Static Public Member Functions inherited from ilDBInterface
static	getReservedWords ()
	Get reserved words. More...
static	isReservedWord ($a_word)

Data Fields
const	FEATURE_TRANSACTIONS = 'transactions'
const	FEATURE_FULLTEXT = 'fulltext'
const	FEATURE_SLAVE = 'slave'

Protected Member Functions
	initSQLMode ()
	getAttributes ()
	getAdditionalAttributes ()
	checkTableColumns ($a_cols)
	checkColumn ($a_col, $a_def)
	checkColumnDefinition ($a_def, $a_modify_mode=false)
	appendLimit ($query)
	autoPrepare ($table, $table_fields, $mode=ilDBConstants::AUTOQUERY_INSERT, $where=false, $types=null, $result_types=ilDBConstants::PREPARE_MANIP)
	buildManipSQL ($table, $table_fields, $mode, $where=false)

Protected Attributes
	$host = ''
	$dbname = ''
	$charset = 'utf8'
	$username = ''
	$password = ''
	$port = 3306
	$pdo
	$manager
	$reverse
	$limit = null
	$offset = null
	$storage_engine = 'MyISAM'
	$dsn = ''
	$attributes
	$db_type = ''
	$error_code = 0
	$field_definition

Detailed Description

Class pdoDB.

Author

Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Definition at line 10 of file class.ilDBPdo.php.

Member Function Documentation

addFulltextIndex()

ilDBPdo::addFulltextIndex	(		$a_table,
			$a_fields,
			$a_name = "in"
	)

Parameters

	$a_table
	$a_fields
string	$a_name

Exceptions

ilDatabaseException

Returns

bool

Implements ilDBInterface.

Reimplemented in ilDBPdoMySQLInnoDB.

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

    {
        $i_name = $this->constraintName($a_table, $a_name) . "_idx";
        $f_str = implode(",", $a_fields);
        $q = "ALTER TABLE $a_table ADD FULLTEXT $i_name ($f_str)";
        $this->query($q);
    }

References constraintName(), and query().

Referenced by addIndex().

Here is the call graph for this function:

Here is the caller graph for this function:

addIndex()

ilDBPdo::addIndex	(		$table_name,
			$fields,
			$index_name = '',
			$fulltext = false
	)

Parameters

	$table_name
array	$fields
	$index_name

Returns

null

Implements ilDBInterface.

Reimplemented in ilDBPdoPostgreSQL.

Definition at line 851 of file class.ilDBPdo.php.

    {
        assert(is_array($fields));
        $this->field_definition->checkIndexName($index_name);
 
        $definition_fields = array();
        foreach ($fields as $f) {
            $definition_fields[$f] = array();
        }
        $definition = array(
            'fields' => $definition_fields,
        );
 
        if (!$fulltext) {
            $this->manager->createIndex($table_name, $this->constraintName($table_name, $index_name), $definition);
        } else {
            if ($this->supportsFulltext()) {
                $this->addFulltextIndex($table_name, $fields, $index_name); // TODO
            }
        }
 
        return true;
    }

References Vendor\Package\$f, addFulltextIndex(), constraintName(), and supportsFulltext().

Here is the call graph for this function:

addPrimaryKey()

ilDBPdo::addPrimaryKey	(		$table_name,
			$primary_keys
	)

Parameters

string	$table_name
array	$primary_keys

Returns

bool

Exceptions

ilDatabaseException

Implements ilDBInterface.

Reimplemented in ilDBPdoPostgreSQL.

Definition at line 342 of file class.ilDBPdo.php.

    {
        assert(is_array($primary_keys));
 
        $fields = array();
        foreach ($primary_keys as $f) {
            $fields[$f] = array();
        }
        $definition = array(
            'primary' => true,
            'fields' => $fields,
        );
        $this->manager->createConstraint($table_name, $this->constraintName($table_name, $this->getPrimaryKeyIdentifier()), $definition);
 
        return true;
    }

References Vendor\Package\$f, constraintName(), and getPrimaryKeyIdentifier().

Here is the call graph for this function:

addTableColumn()

ilDBPdo::addTableColumn	(		$table_name,
			$column_name,
			$attributes
	)

Parameters

string	$table_name
string	$column_name
array	$attributes

Returns

bool

Exceptions

ilDatabaseException

Implements ilDBInterface.

Definition at line 439 of file class.ilDBPdo.php.

    {
        if (!$this->checkColumnName($column_name)) {
            throw new ilDatabaseException("ilDB Error: addTableColumn(" . $table_name . ", " . $column_name . ")");
        }
        if (!$this->checkColumnDefinition($attributes)) {
            throw new ilDatabaseException("ilDB Error: addTableColumn(" . $table_name . ", " . $column_name . ")");
        }
 
        $changes = array(
            "add" => array(
                $column_name => $attributes,
            ),
        );
 
        return $this->manager->alterTable($table_name, $changes, false);
    }

References $attributes, checkColumnDefinition(), and checkColumnName().

Here is the call graph for this function:

addUniqueConstraint()

ilDBPdo::addUniqueConstraint	(		$table,
			$fields,
			$name = "con"
	)

Parameters

	$table
	$fields
string	$name

Returns

bool

Exceptions

ilDatabaseException

Implements ilDBPdoInterface.

Reimplemented in ilDBPdoPostgreSQL.

Definition at line 1874 of file class.ilDBPdo.php.

    {
        assert(is_array($fields));
        $manager = $this->manager;
 
        // check index name
        if (!$this->checkIndexName($name)) {
            throw new ilDatabaseException("ilDB Error: addUniqueConstraint(" . $table . "," . $name . ")");
        }
 
        $fields_corrected = array();
        foreach ($fields as $f) {
            $fields_corrected[$f] = array();
        }
        $definition = array(
            'unique' => true,
            'fields' => $fields_corrected,
        );
 
        return $manager->createConstraint($table, $this->constraintName($table, $name), $definition);
    }

References Vendor\Package\$f, $manager, $name, checkIndexName(), and constraintName().

Here is the call graph for this function:

appendLimit()

ilDBPdo::appendLimit (   $query )

protected

Parameters

$query

Returns

string

Reimplemented in ilDBPdoPostgreSQL.

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

    {
        if ($this->limit !== null && $this->offset !== null) {
            $query .= ' LIMIT ' . (int) $this->offset . ', ' . (int) $this->limit;
            $this->limit = null;
            $this->offset = null;
 
            return $query;
        }
 
        return $query;
    }

References $limit, and $query.

Referenced by query().

Here is the caller graph for this function:

autoExecute()

ilDBPdo::autoExecute	(		$tablename,
			$fields,
			$mode = ilDBConstants::AUTOQUERY_INSERT,
			$where = false
	)

Generate an insert, update or delete query and call prepare() and execute() on it.

Parameters

string	$tablename	of the table
array	$fields	($key=>$value) where $key is a field name and $value its value
int	$mode	of query to build ilDBConstants::AUTOQUERY_INSERT ilDBConstants::AUTOQUERY_UPDATE ilDBConstants::AUTOQUERY_DELETE ilDBConstants::AUTOQUERY_SELECT
bool	$where	(in case of update and delete queries, this string will be put after the sql WHERE statement)

Deprecated:

Will be removed in ILIAS 5.3

Returns

bool

Implements ilDBPdoInterface.

Definition at line 2037 of file class.ilDBPdo.php.

    {
        $fields_values = (array) $fields;
        if ($mode == ilDBConstants::AUTOQUERY_INSERT) {
            if (!empty($fields_values)) {
                $keys = $fields_values;
            } else {
                $keys = array();
            }
        } else {
            $keys = array_keys($fields_values);
        }
        $params = array_values($fields_values);
        if (empty($params)) {
            $query = $this->buildManipSQL($tablename, $keys, $mode, $where);
            $result = $this->pdo->query($query);
        } else {
            $stmt = $this->autoPrepare($tablename, $keys, $mode, $where, $types, $result_types);
            $this->execute($stmt);
            $this->free($stmt);
            $result = $stmt;
        }
 
        return $result;
    }

References $keys, $query, $result, autoPrepare(), ilDBConstants\AUTOQUERY_INSERT, buildManipSQL(), ilDBInterface\execute(), and ilDBInterface\free().

Here is the call graph for this function:

autoPrepare()

ilDBPdo::autoPrepare (   $table,   $table_fields,   $mode = ilDBConstants::AUTOQUERY_INSERT,   $where = false,   $types = null,   $result_types = ilDBConstants::PREPARE_MANIP  )

protected

Parameters

	$table
	$table_fields
int	$mode
bool	$where
null	$types
bool	$result_types

Returns

string

Definition at line 2073 of file class.ilDBPdo.php.

    {
        $query = $this->buildManipSQL($table, $table_fields, $mode, $where);
 
        return $this->prepare($query, $types, $result_types);
    }

References $query, buildManipSQL(), and prepare().

Referenced by autoExecute().

Here is the call graph for this function:

Here is the caller graph for this function:

beginTransaction()

ilDBPdo::beginTransaction

(

)

Returns

bool

Exceptions

ilDatabaseException

Implements ilDBInterface.

Definition at line 1673 of file class.ilDBPdo.php.

    {
        if (!$this->supports(self::FEATURE_TRANSACTIONS)) {
            throw new ilDatabaseException("ilDB::beginTransaction: Transactions are not supported.");
        }
 
        return $this->pdo->beginTransaction();
    }

References supports().

Referenced by ilDBPdoPostgreSQL\lockTables().

Here is the call graph for this function:

Here is the caller graph for this function:

buildAtomQuery()

ilDBPdo::buildAtomQuery

(

)

Returns

\ilAtomQuery

Implements ilDBInterface.

Reimplemented in ilDBPdoMySQLGalera.

Definition at line 1947 of file class.ilDBPdo.php.

    {
        return new ilAtomQueryLock($this);
    }

buildManipSQL()

ilDBPdo::buildManipSQL (   $table,   $table_fields,   $mode,   $where = false  )

protected

Parameters

	$table
	$table_fields
	$mode
bool	$where

Returns

string

Exceptions

ilDatabaseException

Definition at line 2089 of file class.ilDBPdo.php.

    {
        if ($this->options['quote_identifier']) {
            $table = $this->quoteIdentifier($table);
        }
 
        if (!empty($table_fields) && $this->options['quote_identifier']) {
            foreach ($table_fields as $key => $field) {
                $table_fields[$key] = $this->quoteIdentifier($field);
            }
        }
 
        if ($where !== false && !is_null($where)) {
            if (is_array($where)) {
                $where = implode(' AND ', $where);
            }
            $where = ' WHERE ' . $where;
        }
 
        switch ($mode) {
            case ilDBConstants::AUTOQUERY_INSERT:
                if (empty($table_fields)) {
                    throw new ilDatabaseException('Insert requires table fields');
                }
                $cols = implode(', ', $table_fields);
                $values = '?' . str_repeat(', ?', (count($table_fields) - 1));
 
                return 'INSERT INTO ' . $table . ' (' . $cols . ') VALUES (' . $values . ')';
                break;
            case ilDBConstants::AUTOQUERY_UPDATE:
                if (empty($table_fields)) {
                    throw new ilDatabaseException('Update requires table fields');
                }
                $set = implode(' = ?, ', $table_fields) . ' = ?';
                $sql = 'UPDATE ' . $table . ' SET ' . $set . $where;
 
                return $sql;
                break;
            case ilDBConstants::AUTOQUERY_DELETE:
                $sql = 'DELETE FROM ' . $table . $where;
 
                return $sql;
                break;
            case ilDBConstants::AUTOQUERY_SELECT:
                $cols = !empty($table_fields) ? implode(', ', $table_fields) : '*';
                $sql = 'SELECT ' . $cols . ' FROM ' . $table . $where;
 
                return $sql;
                break;
        }
 
        throw new ilDatabaseException('Syntax error');
    }

References $cols, ilDBConstants\AUTOQUERY_DELETE, ilDBConstants\AUTOQUERY_INSERT, ilDBConstants\AUTOQUERY_SELECT, ilDBConstants\AUTOQUERY_UPDATE, and quoteIdentifier().

Referenced by autoExecute(), and autoPrepare().

Here is the call graph for this function:

Here is the caller graph for this function:

cast()

ilDBPdo::cast	(		$a_field_name,
			$a_dest_type
	)

Parameters

string	$a_field_name
string	$a_dest_type

Returns

string;

Implements ilDBInterface.

Definition at line 2195 of file class.ilDBPdo.php.

    {
        return $this->manager->getQueryUtils()->cast($a_field_name, $a_dest_type);
    }

checkColumn()

ilDBPdo::checkColumn (   $a_col,   $a_def  )

protected

Parameters

$a_col
$a_def

Returns

bool

Definition at line 301 of file class.ilDBPdo.php.

    {
        if (!$this->checkColumnName($a_col)) {
            return false;
        }
 
        if (!$this->checkColumnDefinition($a_def)) {
            return false;
        }
 
        return true;
    }

References checkColumnDefinition(), and checkColumnName().

Referenced by checkTableColumns().

Here is the call graph for this function:

Here is the caller graph for this function:

checkColumnDefinition()

ilDBPdo::checkColumnDefinition (   $a_def,   $a_modify_mode = false  )

protected

Parameters

	$a_def
bool	$a_modify_mode

Returns

bool

Definition at line 320 of file class.ilDBPdo.php.

    {
        return $this->field_definition->checkColumnDefinition($a_def);
    }

Referenced by addTableColumn(), checkColumn(), and modifyTableColumn().

Here is the caller graph for this function:

checkColumnName()

ilDBPdo::checkColumnName

(

$a_name

)

Parameters

$a_name

Returns

bool

Definition at line 330 of file class.ilDBPdo.php.

    {
        return $this->field_definition->checkColumnName($a_name);
    }

Referenced by addTableColumn(), checkColumn(), and renameTableColumn().

Here is the caller graph for this function:

checkIndexName()

ilDBPdo::checkIndexName

(

$name

)

Parameters

$name

Returns

bool

Exceptions

ilDatabaseException

Implements ilDBPdoInterface.

Definition at line 1861 of file class.ilDBPdo.php.

    {
        return $this->getFieldDefinition()->checkIndexName($name);
    }

References $name, and getFieldDefinition().

Referenced by addUniqueConstraint().

Here is the call graph for this function:

Here is the caller graph for this function:

checkTableColumns()

ilDBPdo::checkTableColumns (   $a_cols )

protected

Parameters

$a_cols

Returns

bool

Definition at line 284 of file class.ilDBPdo.php.

    {
        foreach ($a_cols as $col => $def) {
            if (!$this->checkColumn($col, $def)) {
                return false;
            }
        }
 
        return true;
    }

References checkColumn().

Referenced by createTable().

Here is the call graph for this function:

Here is the caller graph for this function:

checkTableName()

ilDBPdo::checkTableName

(

$a_name

)

Parameters

$a_name

Returns

bool

Exceptions

ilDatabaseException

Implements ilDBInterface.

Definition at line 1650 of file class.ilDBPdo.php.

    {
        return $this->field_definition->checkTableName($a_name);
    }

Referenced by createTable(), renameTable(), and ilDBPdoPostgreSQL\renameTable().

Here is the caller graph for this function:

commit()

ilDBPdo::commit

(

)

Returns

bool

Exceptions

ilDatabaseException

Implements ilDBInterface.

Definition at line 1687 of file class.ilDBPdo.php.

    {
        if (!$this->supports(self::FEATURE_TRANSACTIONS)) {
            throw new ilDatabaseException("ilDB::beginTransaction: Transactions are not supported.");
        }
 
        return $this->pdo->commit();
    }

References supports().

Referenced by ilDBPdoPostgreSQL\unlockTables().

Here is the call graph for this function:

Here is the caller graph for this function:

concat()

ilDBPdo::concat	(	array	$values,
			$allow_null = true
	)

Parameters

array	$values
bool	$allow_null

Returns

string

Implements ilDBInterface.

Definition at line 1518 of file class.ilDBPdo.php.

    {
        return $this->manager->getQueryUtils()->concat($values, $allow_null);
    }

connect()

ilDBPdo::connect

(

$return_false_for_error = false

)

Parameters

bool

$return_false_for_error

Returns

bool

Exceptions

Exception

Implements ilDBInterface.

Reimplemented in ilDBPdoPostgreSQL.

Definition at line 93 of file class.ilDBPdo.php.

    {
        $this->generateDSN();
        try {
            $options = $this->getAttributes();
            $this->pdo = new PDO($this->getDSN(), $this->getUsername(), $this->getPassword(), $options);
            $this->initHelpers();
            $this->initSQLMode();
        } catch (Exception $e) {
            $this->error_code = $e->getCode();
            if ($return_false_for_error) {
                return false;
            }
            throw $e;
        }
 
        return ($this->pdo->errorCode() == PDO::ERR_NONE);
    }

References Vendor\Package\$e, generateDSN(), getAttributes(), getDSN(), getPassword(), getUsername(), initHelpers(), and initSQLMode().

Referenced by createDatabase().

Here is the call graph for this function:

Here is the caller graph for this function:

constraintName()

ilDBPdo::constraintName	(		$a_table,
			$a_constraint
	)

Determine contraint name by table name and constraint name.

In MySQL these are "unique" per table

Implements ilDBInterface.

Reimplemented in ilDBPdoPostgreSQL.

Definition at line 942 of file class.ilDBPdo.php.

    {
        return $a_constraint;
    }

Referenced by addFulltextIndex(), addIndex(), addPrimaryKey(), addUniqueConstraint(), dropFulltextIndex(), and dropUniqueConstraint().

Here is the caller graph for this function:

createDatabase()

ilDBPdo::createDatabase	(		$a_name,
			$a_charset = "utf8",
			$a_collation = ""
	)

Parameters

	$a_name
string	$a_charset
string	$a_collation

Returns

ilPDOStatement|false

Exceptions

ilDatabaseException

Implements ilDBInterface.

Definition at line 169 of file class.ilDBPdo.php.

    {
        $this->setDbname(null);
        $this->generateDSN();
        $this->connect(true);
        try {
            return $this->query($this->manager->getQueryUtils()->createDatabase($a_name, $a_charset, $a_collation));
        } catch (PDOException $e) {
            return false;
        }
    }

References Vendor\Package\$e, connect(), generateDSN(), query(), and setDbname().

Here is the call graph for this function:

createSequence()

ilDBPdo::createSequence	(		$table_name,
			$start = 1
	)

Parameters

	$table_name
int	$start

Implements ilDBInterface.

Reimplemented in ilDBPdoPostgreSQL.

Definition at line 394 of file class.ilDBPdo.php.

    {
        $this->manager->createSequence($table_name, $start);
    }

createTable()

ilDBPdo::createTable	(		$table_name,
			$fields,
			$drop_table = false,
			$ignore_erros = false
	)

Parameters

	$table_name
	$fields
bool	$drop_table
bool	$ignore_erros

Returns

mixed

Exceptions

ilDatabaseException

Implements ilDBInterface.

Reimplemented in ilDBPdoPostgreSQL.

Definition at line 260 of file class.ilDBPdo.php.

    {
        // check table name
        if (!$this->checkTableName($table_name) && !$ignore_erros) {
            throw new ilDatabaseException("ilDB Error: createTable(" . $table_name . ")");
        }
 
        // check definition array
        if (!$this->checkTableColumns($fields) && !$ignore_erros) {
            throw new ilDatabaseException("ilDB Error: createTable(" . $table_name . ")");
        }
 
        if ($drop_table) {
            $this->dropTable($table_name, false);
        }
 
        return $this->manager->createTable($table_name, $fields, array());
    }

References checkTableColumns(), checkTableName(), and dropTable().

Here is the call graph for this function:

doesCollationSupportMB4Strings()

ilDBPdo::doesCollationSupportMB4Strings

(

)

@inheritDoc

Implements ilDBInterface.

Reimplemented in ilDBPdoMySQL.

Definition at line 2178 of file class.ilDBPdo.php.

    {
        return false;
    }

Referenced by sanitizeMB4StringIfNotSupported().

Here is the caller graph for this function:

dropFulltextIndex()

ilDBPdo::dropFulltextIndex	(		$a_table,
			$a_name
	)

Drop fulltext index.

Implements ilDBInterface.

Definition at line 895 of file class.ilDBPdo.php.

    {
        $i_name = $this->constraintName($a_table, $a_name) . "_idx";
        $this->query("ALTER TABLE $a_table DROP FULLTEXT $i_name");
    }

References constraintName(), and query().

Here is the call graph for this function:

dropIndex()

ilDBPdo::dropIndex	(		$a_table,
			$a_name = "i1"
	)

Parameters

	$a_table
string	$a_name

Returns

mixed

Implements ilDBInterface.

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

    {
        return $this->manager->dropIndex($a_table, $a_name);
    }

Referenced by dropIndexByFields().

Here is the caller graph for this function:

dropIndexByFields()

ilDBPdo::dropIndexByFields	(		$table_name,
			$fields
	)

Parameters

$table_name
$fields

Returns

bool|mixed

Exceptions

ilDatabaseException

Implements ilDBInterface.

Definition at line 366 of file class.ilDBPdo.php.

    {
        foreach ($this->manager->listTableIndexes($table_name) as $idx_name) {
            $def = $this->reverse->getTableIndexDefinition($table_name, $idx_name);
            $idx_fields = array_keys((array) $def['fields']);
 
            if ($idx_fields === $fields) {
                return $this->dropIndex($table_name, $idx_name);
            }
        }
 
        return false;
    }

References dropIndex().

Here is the call graph for this function:

dropPrimaryKey()

ilDBPdo::dropPrimaryKey

(

$table_name

)

Parameters

$table_name

Returns

bool

Implements ilDBPdoInterface.

Reimplemented in ilDBPdoPostgreSQL.

Definition at line 1984 of file class.ilDBPdo.php.

    {
        return $this->manager->dropConstraint($table_name, "PRIMARY", true);
    }

dropSequence()

ilDBPdo::dropSequence

(

$table_name

)

Parameters

$table_name

string

Implements ilDBInterface.

Definition at line 546 of file class.ilDBPdo.php.

    {
        $this->manager->dropSequence($table_name);
    }

dropTable()

ilDBPdo::dropTable	(		$table_name,
			$error_if_not_existing = true
	)

Parameters

	$table_name
bool	$error_if_not_existing

Returns

bool

Exceptions

ilDatabaseException

Implements ilDBInterface.

Reimplemented in ilDBPdoPostgreSQL.

Definition at line 464 of file class.ilDBPdo.php.

    {
        $ilDBPdoManager = $this->loadModule(ilDBConstants::MODULE_MANAGER);
        $tables = $ilDBPdoManager->listTables();
        $table_exists = in_array($table_name, $tables);
        if (!$table_exists && $error_if_not_existing) {
            throw new ilDatabaseException("Table {$table_name} does not exist");
        }
 
        // drop sequence
        $sequences = $ilDBPdoManager->listSequences();
        if (in_array($table_name, $sequences)) {
            $ilDBPdoManager->dropSequence($table_name);
        }
 
        // drop table
        if ($table_exists) {
            $ilDBPdoManager->dropTable($table_name);
        }
 
        return true;
    }

References loadModule(), and ilDBConstants\MODULE_MANAGER.

Referenced by createTable().

Here is the call graph for this function:

Here is the caller graph for this function:

dropTableColumn()

ilDBPdo::dropTableColumn	(		$table_name,
			$column_name
	)

Parameters

string	$table_name
string	$column_name

Returns

bool

Exceptions

ilDatabaseException

Implements ilDBInterface.

Definition at line 558 of file class.ilDBPdo.php.

    {
        $changes = array(
            "remove" => array(
                $column_name => array(),
            ),
        );
 
        return $this->manager->alterTable($table_name, $changes, false);
    }

dropUniqueConstraint()

ilDBPdo::dropUniqueConstraint	(		$a_table,
			$a_name = "con"
	)

Parameters

	$a_table
string	$a_name

Returns

mixed

Implements ilDBPdoInterface.

Definition at line 1902 of file class.ilDBPdo.php.

    {
        return $this->manager->dropConstraint($a_table, $this->constraintName($a_table, $a_name), false);
    }

References constraintName().

Referenced by dropUniqueConstraintByFields().

Here is the call graph for this function:

Here is the caller graph for this function:

dropUniqueConstraintByFields()

ilDBPdo::dropUniqueConstraintByFields	(		$a_table,
			$a_fields
	)

Parameters

$a_table
$a_fields

Returns

bool|mixed

Implements ilDBPdoInterface.

Definition at line 1913 of file class.ilDBPdo.php.

    {
        $analyzer = new ilDBAnalyzer();
        $cons = $analyzer->getConstraintsInformation($a_table);
        foreach ($cons as $c) {
            if ($c["type"] == "unique" && count($a_fields) == count($c["fields"])) {
                $all_in = true;
                foreach ($a_fields as $f) {
                    if (!isset($c["fields"][$f])) {
                        $all_in = false;
                    }
                }
                if ($all_in) {
                    return $this->dropUniqueConstraint($a_table, $c['name']);
                }
            }
        }
 
        return false;
    }

References Vendor\Package\$c, Vendor\Package\$f, and dropUniqueConstraint().

Here is the call graph for this function:

enableResultBuffering()

ilDBPdo::enableResultBuffering

(

$a_status

)

Parameters

$a_status

Implements ilDBInterface.

Definition at line 1390 of file class.ilDBPdo.php.

    {
        $this->pdo->setAttribute(PDO::MYSQL_ATTR_USE_BUFFERED_QUERY, $a_status);
    }

equals()

ilDBPdo::equals	(		$columns,
			$value,
			$type,
			$emptyOrNull = false
	)

Parameters

	$columns
	$value
	$type
bool	$emptyOrNull

Returns

string

Implements ilDBInterface.

Definition at line 1173 of file class.ilDBPdo.php.

    {
        if (!$emptyOrNull || $value != "") {
            return $columns . " = " . $this->quote($value, $type);
        } else {
            return "(" . $columns . " = '' OR $columns IS NULL)";
        }
    }

References $columns, $type, and quote().

Here is the call graph for this function:

escape()

ilDBPdo::escape	(		$value,
			$escape_wildcards = false
	)

Parameters

	$value
bool	$escape_wildcards

Returns

string

Implements ilDBPdoInterface.

Definition at line 1803 of file class.ilDBPdo.php.

    {
        return $value;
    }

escapePattern()

ilDBPdo::escapePattern

(

$text

)

Parameters

$text

Returns

string

Implements ilDBPdoInterface.

Definition at line 1813 of file class.ilDBPdo.php.

    {
        return $text;
    }

executeMultiple()

ilDBPdo::executeMultiple	(		$stmt,
			$a_data
	)

Parameters

$stmt
$a_data

Implements ilDBPdoInterface.

Definition at line 1994 of file class.ilDBPdo.php.

    {
        for ($i = 0, $j = count($a_data); $i < $j; $i++) {
            $stmt->execute($a_data[$i]);
        }
    }

References $i.

fetchAssoc()

ilDBPdo::fetchAssoc

(

$query_result

)

Parameters

$query_result

ilPDOStatement

Returns

mixed

Implements ilDBInterface.

Definition at line 761 of file class.ilDBPdo.php.

    {
        $res = $query_result->fetch(PDO::FETCH_ASSOC);
        if ($res == null) {
            $query_result->closeCursor();
 
            return null;
        }
 
        return $res;
    }

References $res.

Referenced by isFulltextIndex().

Here is the caller graph for this function:

fetchObject()

ilDBPdo::fetchObject

(

$query_result

)

Parameters

$query_result

ilPDOStatement

Returns

mixed|null

Implements ilDBInterface.

Definition at line 633 of file class.ilDBPdo.php.

    {
        $res = $query_result->fetchObject();
        if ($res == null) {
            $query_result->closeCursor();
 
            return null;
        }
 
        return $res;
    }

References $res.

Referenced by getDBVersion().

Here is the caller graph for this function:

fromUnixtime()

ilDBPdo::fromUnixtime	(		$a_expr,
			$a_to_text = true
	)

Parameters

	$a_expr
bool	$a_to_text

Returns

string

Implements ilDBPdoInterface.

Definition at line 2007 of file class.ilDBPdo.php.

    {
        return "FROM_UNIXTIME(" . $a_expr . ")";
    }

generateDSN()

ilDBPdo::generateDSN

(

)

Reimplemented in ilDBPdoPostgreSQL.

Definition at line 224 of file class.ilDBPdo.php.

    {
        $port = $this->getPort() ? ";port=" . $this->getPort() : "";
        $dbname = $this->getDbname() ? ';dbname=' . $this->getDbname() : '';
        $host = $this->getHost();
        $charset = ';charset=' . $this->getCharset();
        $this->dsn = 'mysql:host=' . $host . $port . $dbname . $charset;
    }

References $charset, $dbname, $host, $port, getCharset(), getDbname(), getHost(), and getPort().

Referenced by connect(), createDatabase(), and initFromIniFile().

Here is the call graph for this function:

Here is the caller graph for this function:

getAdditionalAttributes()

ilDBPdo::getAdditionalAttributes ( )

protected

Returns

array

Reimplemented in ilDBPdoMySQL, and ilDBPdoPostgreSQL.

Definition at line 138 of file class.ilDBPdo.php.

    {
        return array();
    }

Referenced by getAttributes().

Here is the caller graph for this function:

getAllowedAttributes()

ilDBPdo::getAllowedAttributes

(

)

Returns

array

Implements ilDBInterface.

Definition at line 1488 of file class.ilDBPdo.php.

    {
        return $this->field_definition->getAllowedAttributes();
    }

getAttributes()

ilDBPdo::getAttributes ( )

protected

Returns

array

Definition at line 124 of file class.ilDBPdo.php.

    {
        $options = $this->attributes;
        foreach ($this->getAdditionalAttributes() as $k => $v) {
            $options[$k] = $v;
        }
 
        return $options;
    }

References $attributes, and getAdditionalAttributes().

Referenced by connect(), and ilDBPdoPostgreSQL\connect().

Here is the call graph for this function:

Here is the caller graph for this function:

getCharset()

ilDBPdo::getCharset

(

)

Returns

string

Definition at line 1222 of file class.ilDBPdo.php.

    {
        return $this->charset;
    }

References $charset.

Referenced by generateDSN().

Here is the caller graph for this function:

getDbname()

ilDBPdo::getDbname

(

)

Returns

string

Definition at line 1204 of file class.ilDBPdo.php.

    {
        return $this->dbname;
    }

References $dbname.

Referenced by generateDSN(), and ilDBPdoPostgreSQL\generateDSN().

Here is the caller graph for this function:

getDBType()

ilDBPdo::getDBType

(

)

Returns

string

Implements ilDBInterface.

Definition at line 960 of file class.ilDBPdo.php.

    {
        return $this->db_type;
    }

References $db_type.

getDBVersion()

ilDBPdo::getDBVersion

(

)

Returns

string

Exceptions

ilDatabaseException

Implements ilDBPdoInterface.

Definition at line 2148 of file class.ilDBPdo.php.

    {
        $d = $this->fetchObject($this->query("SELECT VERSION() AS version"));
 
        return ($d->version ? $d->version : 'Unknown');
    }

References $d, fetchObject(), and query().

Here is the call graph for this function:

getDSN()

ilDBPdo::getDSN

(

)

Returns

string

Implements ilDBInterface.

Definition at line 951 of file class.ilDBPdo.php.

    {
        return $this->dsn;
    }

References $dsn.

Referenced by connect(), and ilDBPdoPostgreSQL\connect().

Here is the caller graph for this function:

getFieldDefinition()

ilDBPdo::getFieldDefinition

(

)

Returns

ilDBPdoFieldDefinition

Definition at line 147 of file class.ilDBPdo.php.

    {
        return $this->field_definition;
    }

References $field_definition.

Referenced by checkIndexName().

Here is the caller graph for this function:

getHost()

ilDBPdo::getHost

(

)

Returns

string

Definition at line 1186 of file class.ilDBPdo.php.

    {
        return $this->host;
    }

References $host.

Referenced by generateDSN(), and ilDBPdoPostgreSQL\generateDSN().

Here is the caller graph for this function:

getIndexName()

ilDBPdo::getIndexName

(

$index_name_base

)

Parameters

$index_name_base

Returns

string

Reimplemented in ilDBPdoPostgreSQL.

Definition at line 922 of file class.ilDBPdo.php.

    {
        return sprintf(ilDBPdoFieldDefinition::INDEX_FORMAT, preg_replace('/[^a-z0-9_\$]/i', '_', $index_name_base));
    }

References ilDBPdoFieldDefinition\INDEX_FORMAT.

getLastErrorCode()

ilDBPdo::getLastErrorCode

(

)

Returns

int

Definition at line 185 of file class.ilDBPdo.php.

    {
        if ($this->pdo instanceof PDO) {
            return $this->pdo->errorCode();
        }
 
        return $this->error_code;
    }

References $error_code.

getLastInsertId()

ilDBPdo::getLastInsertId

(

)

Returns

string

Implements ilDBPdoInterface.

Definition at line 1938 of file class.ilDBPdo.php.

    {
        return $this->pdo->lastInsertId();
    }

getPassword()

ilDBPdo::getPassword

(

)

Returns

string

Definition at line 1258 of file class.ilDBPdo.php.

    {
        return $this->password;
    }

References $password.

Referenced by connect(), ilDBPdoPostgreSQL\connect(), and ilDBPdoPostgreSQL\generateDSN().

Here is the caller graph for this function:

getPort()

ilDBPdo::getPort

(

)

Returns

int

Definition at line 1276 of file class.ilDBPdo.php.

    {
        return $this->port;
    }

References $port.

Referenced by generateDSN(), and ilDBPdoPostgreSQL\generateDSN().

Here is the caller graph for this function:

getPrimaryKeyIdentifier()

ilDBPdo::getPrimaryKeyIdentifier

(

)

Returns

string

Implements ilDBInterface.

Reimplemented in ilDBPdoPostgreSQL.

Definition at line 384 of file class.ilDBPdo.php.

    {
        return "PRIMARY";
    }

Referenced by addPrimaryKey().

Here is the caller graph for this function:

getSequenceName()

ilDBPdo::getSequenceName

(

$table_name

)

Parameters

$table_name

Returns

string

Implements ilDBInterface.

Definition at line 932 of file class.ilDBPdo.php.

    {
        return sprintf(ilDBPdoFieldDefinition::SEQUENCE_FORMAT, preg_replace('/[^a-z0-9_\$.]/i', '_', $table_name));
    }

References ilDBPdoFieldDefinition\SEQUENCE_FORMAT.

Referenced by ilDBPdoMySQL\nextId(), renameTable(), and ilDBPdoPostgreSQL\renameTable().

Here is the caller graph for this function:

getServerVersion()

ilDBPdo::getServerVersion

(

$native = false

)

Parameters

bool

$native

Returns

string

Implements ilDBPdoInterface.

Definition at line 1792 of file class.ilDBPdo.php.

    {
        return $this->pdo->query('SELECT VERSION()')->fetchColumn();
    }

getStorageEngine()

ilDBPdo::getStorageEngine

(

)

Returns

string

Implements ilDBInterface.

Reimplemented in ilDBPdoPostgreSQL.

Definition at line 1734 of file class.ilDBPdo.php.

    {
        return $this->storage_engine;
    }

References $storage_engine.

getUsername()

ilDBPdo::getUsername

(

)

Returns

string

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

    {
        return $this->username;
    }

References $username.

Referenced by connect(), ilDBPdoPostgreSQL\connect(), and ilDBPdoPostgreSQL\generateDSN().

Here is the caller graph for this function:

groupConcat()

ilDBPdo::groupConcat	(		$a_field_name,
			$a_seperator = ",",
			$a_order = null
	)

Parameters

string	$a_field_name
string	$a_seperator
string	$a_order

Returns

string

Implements ilDBInterface.

Definition at line 2187 of file class.ilDBPdo.php.

    {
        return $this->manager->getQueryUtils()->groupConcat($a_field_name, $a_seperator, $a_order);
    }

in()

ilDBPdo::in	(		$field,
			$values,
			$negate = false,
			$type = ""
	)

Parameters

	$field	string
	$values	array
bool	$negate
string	$type

Returns

string

Implements ilDBInterface.

Definition at line 1028 of file class.ilDBPdo.php.

    {
        return $this->manager->getQueryUtils()->in($field, $values, $negate, $type);
    }

References $type.

indexExistsByFields()

ilDBPdo::indexExistsByFields	(		$table_name,
			$fields
	)

Parameters

string	$table_name
array	$fields

Returns

bool

Implements ilDBInterface.

Definition at line 830 of file class.ilDBPdo.php.

    {
        foreach ($this->manager->listTableIndexes($table_name) as $idx_name) {
            $def = $this->reverse->getTableIndexDefinition($table_name, $idx_name);
            $idx_fields = array_keys((array) $def['fields']);
 
            if ($idx_fields === $fields) {
                return true;
            }
        }
 
        return false;
    }

initFromIniFile()

ilDBPdo::initFromIniFile

(

$tmpClientIniFile = null

)

Parameters

null

$tmpClientIniFile

Implements ilDBInterface.

Definition at line 198 of file class.ilDBPdo.php.

    {
        global $DIC;
 
        if ($tmpClientIniFile instanceof ilIniFile) {
            $clientIniFile = $tmpClientIniFile;
        } else {
            $ilClientIniFile = null;
            if ($DIC->offsetExists('ilClientIniFile')) {
                $clientIniFile = $DIC['ilClientIniFile'];
            } else {
                throw new InvalidArgumentException('$tmpClientIniFile is not an instance of ilIniFile');
            }
        }
 
        $this->setUsername($clientIniFile->readVariable("db", "user"));
        $this->setHost($clientIniFile->readVariable("db", "host"));
        $this->setPort((int) $clientIniFile->readVariable("db", "port"));
        $this->setPassword($clientIniFile->readVariable("db", "pass"));
        $this->setDbname($clientIniFile->readVariable("db", "name"));
        $this->setDBType($clientIniFile->readVariable("db", "type"));
 
        $this->generateDSN();
    }

References $DIC, generateDSN(), setDbname(), setDBType(), setHost(), setPassword(), setPort(), and setUsername().

Here is the call graph for this function:

initHelpers()

ilDBPdo::initHelpers ( )

abstract

Reimplemented in ilDBPdoMySQL, and ilDBPdoPostgreSQL.

Referenced by connect().

Here is the caller graph for this function:

initSQLMode()

ilDBPdo::initSQLMode ( )

protected

Reimplemented in ilDBPdoMySQL.

Definition at line 116 of file class.ilDBPdo.php.

    {
    }

Referenced by connect().

Here is the caller graph for this function:

insert()

ilDBPdo::insert	(		$table_name,
			$values
	)

Parameters

$table_name	string
$values

Returns

int|void

Implements ilDBInterface.

Definition at line 610 of file class.ilDBPdo.php.

    {
        $real = array();
        $fields = array();
        foreach ($values as $key => $val) {
            $real[] = $this->quote($val[1], $val[0]);
            $fields[] = $this->quoteIdentifier($key);
        }
        $values = implode(",", $real);
        $fields = implode(",", $fields);
        $query = "INSERT INTO " . $this->quoteIdentifier($table_name) . " (" . $fields . ") VALUES (" . $values . ")";
 
        $query = $this->sanitizeMB4StringIfNotSupported($query);
 
        return $this->pdo->exec($query);
    }

References $query, quote(), quoteIdentifier(), and sanitizeMB4StringIfNotSupported().

Referenced by ilDBPdoPostgreSQL\replace().

Here is the call graph for this function:

Here is the caller graph for this function:

isFulltextIndex()

ilDBPdo::isFulltextIndex	(		$a_table,
			$a_name
	)

Is index a fulltext index?

Implements ilDBInterface.

Definition at line 905 of file class.ilDBPdo.php.

    {
        $set = $this->query("SHOW INDEX FROM " . $a_table);
        while ($rec = $this->fetchAssoc($set)) {
            if ($rec["Key_name"] == $a_name && $rec["Index_type"] == "FULLTEXT") {
                return true;
            }
        }
 
        return false;
    }

References fetchAssoc(), and query().

Here is the call graph for this function:

isReservedWord()

static ilDBPdo::isReservedWord (   $a_word )

static

Parameters

$a_word

Returns

bool

Implements ilDBInterface.

Definition at line 1660 of file class.ilDBPdo.php.

    {
        global $DIC;
        $ilDBPdoMySQLFieldDefinition = new ilDBPdoMySQLFieldDefinition($DIC->database());
 
        return $ilDBPdoMySQLFieldDefinition->isReserved($a_word);
    }

References $DIC.

like()

ilDBPdo::like	(		$column,
			$type,
			$value = "?",
			$case_insensitive = true
	)

Parameters

string	$column
string	$type
string	$value
bool	$case_insensitive

Returns

string

Exceptions

ilDatabaseException

Implements ilDBInterface.

Definition at line 1111 of file class.ilDBPdo.php.

    {
        return $this->manager->getQueryUtils()->like($column, $type, $value, $case_insensitive);
    }

References $type.

listSequences()

ilDBPdo::listSequences

(

)

Returns

array

Implements ilDBInterface.

Definition at line 1507 of file class.ilDBPdo.php.

    {
        return $this->manager->listSequences();
    }

Referenced by sequenceExists().

Here is the caller graph for this function:

listTables()

ilDBPdo::listTables

(

)

Returns

array

Implements ilDBInterface.

Definition at line 1464 of file class.ilDBPdo.php.

    {
        return $this->manager->listTables();
    }

Referenced by ilDBPdoMySQL\migrateAllTablesToEngine(), and ilDBPdoPostgreSQL\tableExists().

Here is the caller graph for this function:

loadModule()

ilDBPdo::loadModule

(

$module

)

Parameters

$module

Returns

\ilDBPdoManager|\ilDBPdoReverse

Implements ilDBInterface.

Definition at line 1474 of file class.ilDBPdo.php.

    {
        switch ($module) {
            case ilDBConstants::MODULE_MANAGER:
                return $this->manager;
            case ilDBConstants::MODULE_REVERSE:
                return $this->reverse;
        }
    }

References $manager, $reverse, ilDBConstants\MODULE_MANAGER, and ilDBConstants\MODULE_REVERSE.

Referenced by dropTable(), ilDBPdoMySQL\migrateAllTablesToCollation(), and tableColumnExists().

Here is the caller graph for this function:

locate()

ilDBPdo::locate	(		$a_needle,
			$a_string,
			$a_start_pos = 1
	)

Parameters

	$a_needle
	$a_string
int	$a_start_pos

Returns

string

Implements ilDBInterface.

Definition at line 1548 of file class.ilDBPdo.php.

    {
        return $this->manager->getQueryUtils()->locate($a_needle, $a_string, $a_start_pos);
    }

lockTables()

ilDBPdo::lockTables

(

$tables

)

Deprecated:

Use ilAtomQuery instead

Parameters

array

$tables

Implements ilDBInterface.

Reimplemented in ilDBPdoPostgreSQL.

Definition at line 996 of file class.ilDBPdo.php.

    {
        assert(is_array($tables));
 
        $lock = $this->manager->getQueryUtils()->lock($tables);
        global $DIC;
        $ilLogger = $DIC->logger()->root();
        if ($ilLogger instanceof ilLogger) {
            $ilLogger->log('ilDB::lockTables(): ' . $lock);
        }
 
        $this->pdo->exec($lock);
    }

References $DIC.

lower()

ilDBPdo::lower

(

$a_exp

)

Parameters

$a_exp

Returns

string

Implements ilDBInterface.

Definition at line 1341 of file class.ilDBPdo.php.

    {
        return " LOWER(" . $a_exp . ") ";
    }

manipulate()

ilDBPdo::manipulate

(

$query

)

Parameters

string

$query

Returns

bool|int

Exceptions

ilDatabaseException

Implements ilDBInterface.

Definition at line 735 of file class.ilDBPdo.php.

    {
        global $DIC;
        $ilBench = $DIC['ilBench'];
        try {
            $query = $this->sanitizeMB4StringIfNotSupported($query);
            if ($ilBench instanceof ilBenchmark) {
                $ilBench->startDbBench($query);
            }
            $r = $this->pdo->exec($query);
            if ($ilBench instanceof ilBenchmark) {
                $ilBench->stopDbBench();
            }
        } catch (PDOException $e) {
            throw new ilDatabaseException($e->getMessage() . ' QUERY: ' . $query);
        }
 
        return $r;
    }

References $DIC, Vendor\Package\$e, $ilBench, $query, and sanitizeMB4StringIfNotSupported().

Referenced by manipulateF(), and ilDBPdoPostgreSQL\replace().

Here is the call graph for this function:

Here is the caller graph for this function:

manipulateF()

ilDBPdo::manipulateF	(		$query,
			$types,
			$values
	)

Parameters

$query	string
$types	string[]
$values	mixed[]

Returns

string

Exceptions

ilDatabaseException

Implements ilDBInterface.

Definition at line 1063 of file class.ilDBPdo.php.

    {
        if (!is_array($types) || !is_array($values) || count($types) != count($values)) {
            throw new ilDatabaseException("ilDB::manipulateF: types and values must be arrays of same size. ($query)");
        }
        $quoted_values = array();
        foreach ($types as $k => $t) {
            $quoted_values[] = $this->quote($values[$k], $t);
        }
        $query = vsprintf($query, $quoted_values);
 
        return $this->manipulate($query);
    }

References $query, manipulate(), and quote().

Referenced by replace(), and update().

Here is the call graph for this function:

Here is the caller graph for this function:

migrateAllTablesToCollation()

ilDBPdo::migrateAllTablesToCollation

(

$collation = ilDBConstants::MYSQL_COLLATION_UTF8MB4

)

@inheritDoc

Implements ilDBPdoInterface.

Reimplemented in ilDBPdoMySQL.

Definition at line 1832 of file class.ilDBPdo.php.

    {
        return array();
    }

migrateAllTablesToEngine()

ilDBPdo::migrateAllTablesToEngine

(

$engine = ilDBConstants::MYSQL_ENGINE_INNODB

)

Parameters

string

$engine

Returns

array

Implements ilDBPdoInterface.

Reimplemented in ilDBPdoMySQL.

Definition at line 1823 of file class.ilDBPdo.php.

    {
        return array();
    }

modifyTableColumn()

ilDBPdo::modifyTableColumn	(		$table,
			$a_column,
			$a_attributes
	)

Parameters

$table
$a_column
$a_attributes

Returns

bool

Exceptions

ilDatabaseException

Implements ilDBInterface.

Definition at line 1561 of file class.ilDBPdo.php.

    {
        $def = $this->reverse->getTableFieldDefinition($table, $a_column);
 
        $analyzer = new ilDBAnalyzer($this);
        $best_alt = $analyzer->getBestDefinitionAlternative($def);
        $def = $def[$best_alt];
        unset($def["nativetype"]);
        unset($def["mdb2type"]);
 
        // check attributes
        $ilDBPdoFieldDefinition = $this->field_definition;
 
        $type = ($a_attributes["type"] ?? "" != "") ? $a_attributes["type"] : $def["type"];
        foreach ($def as $k => $v) {
            if ($k != "type" && !$ilDBPdoFieldDefinition->isAllowedAttribute($k, $type)) {
                unset($def[$k]);
            }
        }
        $check_array = $def;
        foreach ($a_attributes as $k => $v) {
            $check_array[$k] = $v;
        }
        if (!$this->checkColumnDefinition($check_array, true)) {
            throw new ilDatabaseException("ilDB Error: modifyTableColumn(" . $table . ", " . $a_column . ")");
        }
 
        foreach ($a_attributes as $a => $v) {
            $def[$a] = $v;
        }
 
        $a_attributes["definition"] = $def;
 
        $changes = array(
            "change" => array(
                $a_column => $a_attributes,
            ),
        );
 
        return $this->manager->alterTable($table, $changes, false);
    }

References Vendor\Package\$a, $field_definition, $type, and checkColumnDefinition().

Here is the call graph for this function:

nextId()

ilDBPdo::nextId (   $table_name )

abstract

Parameters

$table_name

string

Returns

int

Implements ilDBInterface.

Reimplemented in ilDBPdoMySQL, and ilDBPdoPostgreSQL.

now()

ilDBPdo::now

(

)

Returns

string the now statement

Implements ilDBInterface.

Definition at line 1120 of file class.ilDBPdo.php.

    {
        return $this->manager->getQueryUtils()->now();
    }

numRows()

ilDBPdo::numRows

(

$query_result

)

Parameters

$query_result

PDOStatement

Returns

int

Implements ilDBInterface.

Definition at line 779 of file class.ilDBPdo.php.

    {
        return $query_result->rowCount();
    }

prepare()

ilDBPdo::prepare	(		$query,
			$types = null,
			$result_types = null
	)

Parameters

	$query
null	$types
null	$result_types

Returns

\ilPDOStatement

Implements ilDBInterface.

Definition at line 1381 of file class.ilDBPdo.php.

    {
        return new ilPDOStatement($this->pdo->prepare($query));
    }

References $query.

Referenced by autoPrepare().

Here is the caller graph for this function:

prepareManip()

ilDBPdo::prepareManip	(		$query,
			$types = null
	)

Parameters

	$query
null	$types

Returns

\ilPDOStatement

Implements ilDBInterface.

Definition at line 1369 of file class.ilDBPdo.php.

    {
        return new ilPDOStatement($this->pdo->prepare($query));
    }

References $query.

Referenced by update().

Here is the caller graph for this function:

query()

ilDBPdo::query

(

$query

)

Parameters

$query

string

Returns

ilPDOStatement

Exceptions

ilDatabaseException

Implements ilDBInterface.

Definition at line 494 of file class.ilDBPdo.php.

    {
        global $DIC;
        $ilBench = $DIC['ilBench'];
 
        $query = $this->appendLimit($query);
 
        try {
            if ($ilBench instanceof ilBenchmark) {
                $ilBench->startDbBench($query);
            }
            $res = $this->pdo->query($query);
            if ($ilBench instanceof ilBenchmark) {
                $ilBench->stopDbBench();
            }
        } catch (PDOException $e) {
            throw new ilDatabaseException($e->getMessage() . ' QUERY: ' . $query);
        }
 
        $err = $this->pdo->errorCode();
        if ($err != PDO::ERR_NONE) {
            $info = $this->pdo->errorInfo();
            $info_message = $info[2];
            throw new ilDatabaseException($info_message . ' QUERY: ' . $query);
        }
 
        return new ilPDOStatement($res);
    }

References $DIC, Vendor\Package\$e, $ilBench, $query, $res, and appendLimit().

Referenced by addFulltextIndex(), createDatabase(), dropFulltextIndex(), getDBVersion(), isFulltextIndex(), ilDBPdoPostgreSQL\lockTables(), ilDBPdoMySQL\nextId(), ilDBPdoPostgreSQL\nextId(), and queryF().

Here is the call graph for this function:

Here is the caller graph for this function:

queryCol()

ilDBPdo::queryCol	(		$query,
			$type = PDO::FETCH_ASSOC,
			$colnum = 0
	)

Parameters

	$query
int	$type
int	$colnum

Returns

array

Implements ilDBPdoInterface.

Definition at line 1746 of file class.ilDBPdo.php.

    {
        switch ($type) {
            case ilDBConstants::FETCHMODE_ASSOC:
                $type = PDO::FETCH_ASSOC;
                break;
            case ilDBConstants::FETCHMODE_OBJECT:
                $type = PDO::FETCH_OBJ;
                break;
            default:
                $type = PDO::FETCH_ASSOC;
                break;
        }
 
        return $this->pdo->query($query, PDO::FETCH_ASSOC)->fetchAll(PDO::FETCH_COLUMN, $colnum);
    }

References $query, $type, ilDBConstants\FETCHMODE_ASSOC, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilDBPdoMySQL\migrateAllTablesToEngine().

Here is the caller graph for this function:

queryF()

ilDBPdo::queryF	(		$query,
			$types,
			$values
	)

Parameters

string	$query
\string[]	$types
\mixed[]	$values

Returns

ilPDOStatement

Exceptions

ilDatabaseException

Implements ilDBInterface.

Definition at line 1041 of file class.ilDBPdo.php.

    {
        if (!is_array($types) || !is_array($values) || count($types) != count($values)) {
            throw new ilDatabaseException("ilDB::queryF: Types and values must be arrays of same size. ($query)");
        }
        $quoted_values = array();
        foreach ($types as $k => $t) {
            $quoted_values[] = $this->quote($values[$k], $t);
        }
        $query = vsprintf($query, $quoted_values);
 
        return $this->query($query);
    }

References $query, query(), and quote().

Here is the call graph for this function:

queryRow()

ilDBPdo::queryRow	(		$query,
			$types = null,
			$fetchmode = ilDBConstants::FETCHMODE_DEFAULT
	)

Parameters

	$query
null	$types
int	$fetchmode

Returns

arary

Implements ilDBPdoInterface.

Definition at line 1770 of file class.ilDBPdo.php.

    {
        switch ($fetchmode) {
            case ilDBConstants::FETCHMODE_ASSOC:
                $type = PDO::FETCH_ASSOC;
                break;
            case ilDBConstants::FETCHMODE_OBJECT:
                $type = PDO::FETCH_OBJ;
                break;
            default:
                $type = PDO::FETCH_ASSOC;
                break;
        }
 
        return $this->pdo->query($query, $type)->fetch();
    }

References $query, $type, ilDBConstants\FETCHMODE_ASSOC, and ilDBConstants\FETCHMODE_OBJECT.

quote()

ilDBPdo::quote	(		$value,
			$type = null
	)

Parameters

$value
$type

Returns

mixed

Implements ilDBInterface.

Definition at line 791 of file class.ilDBPdo.php.

    {
        if ($value === null) {
            return 'NULL';
        }
 
        $pdo_type = PDO::PARAM_STR;
        switch ($type) {
            case ilDBConstants::T_TIMESTAMP:
            case ilDBConstants::T_DATETIME:
            case ilDBConstants::T_DATE:
                if ($value === '') {
                    return 'NULL';
                }
                break;
            case ilDBConstants::T_INTEGER:
                $value = (int) $value;
 
                return $value;
                break;
            case ilDBConstants::T_FLOAT:
                $pdo_type = PDO::PARAM_INT;
                break;
            case ilDBConstants::T_TEXT:
            default:
                $pdo_type = PDO::PARAM_STR;
                break;
        }
 
        return $this->pdo->quote($value, $pdo_type);
    }

References $type, ilDBConstants\T_DATE, ilDBConstants\T_DATETIME, ilDBConstants\T_FLOAT, ilDBConstants\T_INTEGER, ilDBConstants\T_TEXT, and ilDBConstants\T_TIMESTAMP.

Referenced by equals(), insert(), manipulateF(), queryF(), ilDBPdoPostgreSQL\replace(), and update().

Here is the caller graph for this function:

quoteIdentifier()

ilDBPdo::quoteIdentifier	(		$identifier,
			$check_option = false
	)

Parameters

$identifier

Returns

string

Implements ilDBInterface.

Reimplemented in ilDBPdoPostgreSQL.

Definition at line 238 of file class.ilDBPdo.php.

    {
        return '`' . $identifier . '`';
    }

Referenced by buildManipSQL(), insert(), ilDBPdoMySQL\nextId(), and update().

Here is the caller graph for this function:

renameTable()

ilDBPdo::renameTable	(		$a_name,
			$a_new_name
	)

Parameters

$a_name
$a_new_name

Returns

bool

Exceptions

ilDatabaseException

Implements ilDBInterface.

Reimplemented in ilDBPdoPostgreSQL.

Definition at line 1623 of file class.ilDBPdo.php.

    {
        // check table name
        try {
            $this->checkTableName($a_new_name);
        } catch (ilDatabaseException $e) {
            throw new ilDatabaseException("ilDB Error: renameTable(" . $a_name . "," . $a_new_name . ")<br />" . $e->getMessage());
        }
 
        $this->manager->alterTable($a_name, ["name" => $a_new_name], false);
        if ($this->sequenceExists($a_name)) {
            $this->manager->alterTable($this->getSequenceName($a_name), ["name" => $this->getSequenceName($a_new_name)], false);
        }
        // The abstraction_progress is no longer used in ILIAS, see http://www.ilias.de/mantis/view.php?id=19513
        //              $query = "UPDATE abstraction_progress " . "SET table_name = " . $this->quote($a_new_name, 'text') . " " . "WHERE table_name = "
        //                       . $this->quote($a_name, 'text');
        //              $this->pdo->query($query);
 
        return true;
    }

References Vendor\Package\$e, checkTableName(), getSequenceName(), and sequenceExists().

Here is the call graph for this function:

renameTableColumn()

ilDBPdo::renameTableColumn	(		$table_name,
			$column_old_name,
			$column_new_name
	)

Parameters

string	$table_name
string	$column_old_name
string	$column_new_name

Returns

bool

Exceptions

ilDatabaseException

Implements ilDBInterface.

Definition at line 577 of file class.ilDBPdo.php.

    {
        // check table name
        if (!$this->checkColumnName($column_new_name)) {
            throw new ilDatabaseException("ilDB Error: renameTableColumn(" . $table_name . "," . $column_old_name . "," . $column_new_name . ")");
        }
 
        $def = $this->reverse->getTableFieldDefinition($table_name, $column_old_name);
 
        $analyzer = new ilDBAnalyzer($this);
        $best_alt = $analyzer->getBestDefinitionAlternative($def);
        $def = $def[$best_alt];
        unset($def["nativetype"]);
        unset($def["mdb2type"]);
 
        $f["definition"] = $def;
        $f["name"] = $column_new_name;
 
        $changes = array(
            "rename" => array(
                $column_old_name => $f,
            ),
        );
 
        return $this->manager->alterTable($table_name, $changes, false);
    }

References Vendor\Package\$f, and checkColumnName().

Here is the call graph for this function:

replace()

ilDBPdo::replace	(		$table,
			$primaryKeys,
			$otherColumns
	)

Replace into method.

Parameters

string	table name
array	primary key values: array("field1" => array("text", $name), "field2" => ...)
array	other values: array("field1" => array("text", $name), "field2" => ...)

Returns

string

Implements ilDBInterface.

Reimplemented in ilDBPdoPostgreSQL.

Definition at line 1134 of file class.ilDBPdo.php.

    {
        $a_columns = array_merge($primaryKeys, $otherColumns);
        $fields = array();
        $field_values = array();
        $placeholders = array();
        $types = array();
        $values = array();
 
        foreach ($a_columns as $k => $col) {
            $fields[] = $k;
            $placeholders[] = "%s";
            $placeholders2[] = ":$k";
            $types[] = $col[0];
 
            // integer auto-typecast (this casts bool values to integer)
            if ($col[0] == 'integer' && !is_null($col[1])) {
                $col[1] = (int) $col[1];
            }
 
            $values[] = $col[1];
            $field_values[$k] = $col[1];
        }
 
        $q = "REPLACE INTO " . $table . " (" . implode(",", $fields) . ") VALUES (" . implode(",", $placeholders) . ")";
 
        $r = $this->manipulateF($q, $types, $values);
 
        return $r;
    }

References manipulateF().

Here is the call graph for this function:

rollback()

ilDBPdo::rollback

(

)

Returns

bool

Exceptions

ilDatabaseException

Implements ilDBInterface.

Definition at line 1701 of file class.ilDBPdo.php.

    {
        if (!$this->supports(self::FEATURE_TRANSACTIONS)) {
            throw new ilDatabaseException("ilDB::beginTransaction: Transactions are not supported.");
        }
 
        return $this->pdo->rollBack();
    }

References supports().

Here is the call graph for this function:

sanitizeMB4StringIfNotSupported()

ilDBPdo::sanitizeMB4StringIfNotSupported

(

$query

)

Parameters

$query

string to sanitize, all MB4-Characters like emojis will re replaced with ???

Returns

string sanitized query

Implements ilDBInterface.

Definition at line 2159 of file class.ilDBPdo.php.

    {
        if (!$this->doesCollationSupportMB4Strings()) {
            $query_replaced = preg_replace(
                '/[\x{10000}-\x{10FFFF}]/u',
                ilDBConstants::MB4_REPLACEMENT,
                $query
            );
            if (!empty($query_replaced)) {
                return $query_replaced;
            }
        }
 
        return $query;
    }

References $query, doesCollationSupportMB4Strings(), and ilDBConstants\MB4_REPLACEMENT.

Referenced by insert(), manipulate(), and update().

Here is the call graph for this function:

Here is the caller graph for this function:

sequenceExists()

ilDBPdo::sequenceExists

(

$sequence

)

Parameters

$sequence

Returns

bool

Implements ilDBInterface.

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

    {
        return in_array($sequence, $this->listSequences());
    }

References listSequences().

Referenced by renameTable(), and ilDBPdoPostgreSQL\renameTable().

Here is the call graph for this function:

Here is the caller graph for this function:

setCharset()

ilDBPdo::setCharset

(

$charset

)

Parameters

string

$charset

Definition at line 1231 of file class.ilDBPdo.php.

    {
        $this->charset = $charset;
    }

References $charset.

setDBHost()

ilDBPdo::setDBHost

(

$host

)

Parameters

$host

Implements ilDBInterface.

Definition at line 1321 of file class.ilDBPdo.php.

    {
        $this->setHost($host);
    }

References $host, and setHost().

Here is the call graph for this function:

setDbname()

ilDBPdo::setDbname

(

$dbname

)

Parameters

string

$dbname

Definition at line 1213 of file class.ilDBPdo.php.

    {
        $this->dbname = $dbname;
    }

References $dbname.

Referenced by createDatabase(), and initFromIniFile().

Here is the caller graph for this function:

setDBPassword()

ilDBPdo::setDBPassword

(

$password

)

Parameters

$password

Implements ilDBInterface.

Definition at line 1312 of file class.ilDBPdo.php.

    {
        $this->setPassword($password);
    }

References $password, and setPassword().

Here is the call graph for this function:

setDBPort()

ilDBPdo::setDBPort

(

$port

)

Parameters

$port

Implements ilDBInterface.

Definition at line 1303 of file class.ilDBPdo.php.

    {
        $this->setPort($port);
    }

References $port, and setPort().

Here is the call graph for this function:

setDBType()

ilDBPdo::setDBType

(

$type

)

Parameters

string

$type

Definition at line 970 of file class.ilDBPdo.php.

    {
        $this->db_type = $type;
    }

References $type.

Referenced by initFromIniFile().

Here is the caller graph for this function:

setDBUser()

ilDBPdo::setDBUser

(

$user

)

Parameters

$user

Implements ilDBInterface.

Definition at line 1294 of file class.ilDBPdo.php.

    {
        $this->setUsername($user);
    }

References setUsername().

Here is the call graph for this function:

setFieldDefinition()

ilDBPdo::setFieldDefinition

(

$field_definition

)

Parameters

ilDBPdoFieldDefinition

$field_definition

Definition at line 156 of file class.ilDBPdo.php.

    {
        $this->field_definition = $field_definition;
    }

References $field_definition.

setHost()

ilDBPdo::setHost

(

$host

)

Parameters

string

$host

Definition at line 1195 of file class.ilDBPdo.php.

    {
        $this->host = $host;
    }

References $host.

Referenced by initFromIniFile(), and setDBHost().

Here is the caller graph for this function:

setLimit()

ilDBPdo::setLimit	(		$limit,
			$offset = 0
	)

Set the Limit for the next Query.

Parameters

$limit
$offset

Implements ilDBInterface.

Definition at line 1096 of file class.ilDBPdo.php.

    {
        $this->limit = $limit;
        $this->offset = $offset;
    }

References $limit, and $offset.

setPassword()

ilDBPdo::setPassword

(

$password

)

Parameters

string

$password

Definition at line 1267 of file class.ilDBPdo.php.

    {
        $this->password = $password;
    }

References $password.

Referenced by initFromIniFile(), and setDBPassword().

Here is the caller graph for this function:

setPort()

ilDBPdo::setPort

(

$port

)

Parameters

int

$port

Definition at line 1285 of file class.ilDBPdo.php.

    {
        $this->port = $port;
    }

References $port.

Referenced by ilDBPdoPostgreSQL\generateDSN(), initFromIniFile(), and setDBPort().

Here is the caller graph for this function:

setStorageEngine()

ilDBPdo::setStorageEngine

(

$storage_engine

)

Parameters

$storage_engine

Implements ilDBInterface.

Reimplemented in ilDBPdoPostgreSQL.

Definition at line 1725 of file class.ilDBPdo.php.

    {
        $this->storage_engine = $storage_engine;
    }

References $storage_engine.

setUsername()

ilDBPdo::setUsername

(

$username

)

Parameters

string

$username

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

    {
        $this->username = $username;
    }

References $username.

Referenced by initFromIniFile(), and setDBUser().

Here is the caller graph for this function:

substr()

ilDBPdo::substr	(		$a_exp,
			$a_pos = 1,
			$a_len = -1
	)

Parameters

	$a_exp
int	$a_pos
int	$a_len

Returns

string

Definition at line 1353 of file class.ilDBPdo.php.

    {
        $lenstr = "";
        if ($a_len > -1) {
            $lenstr = ", " . $a_len;
        }
 
        return " SUBSTR(" . $a_exp . ", " . $a_pos . $lenstr . ") ";
    }

supports()

ilDBPdo::supports

(

$feature

)

Parameters

$feature

Returns

bool

Implements ilDBInterface.

Definition at line 1446 of file class.ilDBPdo.php.

    {
        switch ($feature) {
            case self::FEATURE_TRANSACTIONS:
                return $this->supportsTransactions();
            case self::FEATURE_FULLTEXT:
                return $this->supportsFulltext();
            case self::FEATURE_SLAVE:
                return $this->supportsSlave();
            default:
                return false;
        }
    }

References FEATURE_FULLTEXT, FEATURE_SLAVE, FEATURE_TRANSACTIONS, supportsFulltext(), supportsSlave(), and supportsTransactions().

Referenced by beginTransaction(), commit(), and rollback().

Here is the call graph for this function:

Here is the caller graph for this function:

supportsCollationMigration()

ilDBPdo::supportsCollationMigration

(

)

@inheritDoc

Implements ilDBPdoInterface.

Reimplemented in ilDBPdoMySQL.

Definition at line 1841 of file class.ilDBPdo.php.

    {
        return false;
    }

supportsEngineMigration()

ilDBPdo::supportsEngineMigration

(

)

Returns

bool

Implements ilDBPdoInterface.

Reimplemented in ilDBPdoMySQL.

Definition at line 1850 of file class.ilDBPdo.php.

    {
        return false;
    }

supportsFulltext()

ilDBPdo::supportsFulltext

(

)

Returns

bool

Implements ilDBInterface.

Reimplemented in ilDBPdoMySQLInnoDB, ilDBPdoMySQLMyISAM, and ilDBPdoPostgreSQL.

Definition at line 1427 of file class.ilDBPdo.php.

    {
        return false;
    }

Referenced by addIndex(), and supports().

Here is the caller graph for this function:

supportsSlave()

ilDBPdo::supportsSlave

(

)

Returns

bool

Implements ilDBInterface.

Definition at line 1418 of file class.ilDBPdo.php.

    {
        return false;
    }

Referenced by supports().

Here is the caller graph for this function:

supportsTransactions()

ilDBPdo::supportsTransactions

(

)

Returns

bool

Implements ilDBInterface.

Reimplemented in ilDBPdoMySQL, ilDBPdoMySQLGalera, ilDBPdoMySQLInnoDB, and ilDBPdoPostgreSQL.

Definition at line 1436 of file class.ilDBPdo.php.

    {
        return false;
    }

Referenced by supports().

Here is the caller graph for this function:

tableColumnExists()

ilDBPdo::tableColumnExists	(		$table_name,
			$column_name
	)

Parameters

$table_name	string
$column_name	string

Returns

bool

Implements ilDBInterface.

Reimplemented in ilDBPdoPostgreSQL.

Definition at line 422 of file class.ilDBPdo.php.

    {
        $fields = $this->loadModule(ilDBConstants::MODULE_MANAGER)->listTableFields($table_name);
 
        $in_array = in_array($column_name, $fields);
 
        return $in_array;
    }

References loadModule(), and ilDBConstants\MODULE_MANAGER.

Here is the call graph for this function:

tableExists()

ilDBPdo::tableExists

(

$table_name

)

Parameters

$table_name

string

Returns

bool

Implements ilDBInterface.

Reimplemented in ilDBPdoPostgreSQL.

Definition at line 405 of file class.ilDBPdo.php.

    {
        $result = $this->pdo->prepare("SHOW TABLES LIKE :table_name");
        $result->execute(array('table_name' => $table_name));
        $return = $result->rowCount();
        $result->closeCursor();
 
        return $return > 0;
    }

References $result.

uniqueConstraintExists()

ilDBPdo::uniqueConstraintExists	(		$table,
		array	$fields
	)

Parameters

	$table
array	$fields

Returns

bool

Implements ilDBPdoInterface.

Definition at line 1958 of file class.ilDBPdo.php.

    {
        $analyzer = new ilDBAnalyzer();
        $cons = $analyzer->getConstraintsInformation($table);
        foreach ($cons as $c) {
            if ($c["type"] == "unique" && count($fields) == count($c["fields"])) {
                $all_in = true;
                foreach ($fields as $f) {
                    if (!isset($c["fields"][$f])) {
                        $all_in = false;
                    }
                }
                if ($all_in) {
                    return true;
                }
            }
        }
 
        return false;
    }

References Vendor\Package\$c, and Vendor\Package\$f.

unixTimestamp()

ilDBPdo::unixTimestamp

(

)

Returns

string

Implements ilDBPdoInterface.

Definition at line 2016 of file class.ilDBPdo.php.

    {
        return "UNIX_TIMESTAMP()";
    }

unlockTables()

ilDBPdo::unlockTables

(

)

Deprecated:

Use ilAtomQuery instead

Exceptions

ilDatabaseException

Implements ilDBInterface.

Reimplemented in ilDBPdoPostgreSQL.

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

    {
        $this->pdo->exec($this->manager->getQueryUtils()->unlock());
    }

update()

ilDBPdo::update	(		$table_name,
			$columns,
			$where
	)

Parameters

$table_name	string
$values	array
$where	array

Returns

int|void

Implements ilDBInterface.

Definition at line 652 of file class.ilDBPdo.php.

    {
        $fields = array();
        $field_values = array();
        $placeholders = array();
        $placeholders_full = array();
        $types = array();
        $values = array();
        $lobs = false;
        $lob = array();
        foreach ($columns as $k => $col) {
            $field_value = $col[1];
            $fields[] = $k;
            $placeholders[] = "%s";
            $placeholders_full[] = ":$k";
            $types[] = $col[0];
 
            if ($col[0] == "blob" || $col[0] == "clob" || $col[0] == 'text') {
                $field_value = $this->sanitizeMB4StringIfNotSupported($field_value);
            }
 
            // integer auto-typecast (this casts bool values to integer)
            if ($col[0] == 'integer' && !is_null($field_value)) {
                $field_value = (int) $field_value;
            }
 
            $values[] = $field_value;
            $field_values[$k] = $field_value;
            if ($col[0] == "blob" || $col[0] == "clob") {
                $lobs = true;
                $lob[$k] = $k;
            }
        }
 
        if ($lobs) {
            $q = "UPDATE " . $this->quoteIdentifier($table_name) . " SET ";
            $lim = "";
            foreach ($fields as $k => $field) {
                $q .= $lim . $field . " = " . $placeholders_full[$k];
                $lim = ", ";
            }
            $q .= " WHERE ";
            $lim = "";
            foreach ($where as $k => $col) {
                $q .= $lim . $k . " = " . $this->quote($col[1], $col[0]);
                $lim = " AND ";
            }
 
            $r = $this->prepareManip($q, $types);
            $this->execute($r, $field_values);
            $this->free($r);
        } else {
            foreach ($where as $k => $col) {
                $types[] = $col[0];
                $values[] = $col[1];
                $field_values[$k] = $col;
            }
            $q = "UPDATE " . $this->quoteIdentifier($table_name) . " SET ";
            $lim = "";
            foreach ($fields as $k => $field) {
                $q .= $lim . $this->quoteIdentifier($field) . " = " . $placeholders[$k];
                $lim = ", ";
            }
            $q .= " WHERE ";
            $lim = "";
            foreach ($where as $k => $col) {
                $q .= $lim . $k . " = %s";
                $lim = " AND ";
            }
 
            $r = $this->manipulateF($q, $types, $values);
        }
 
        return $r;
    }

References $columns, ilDBInterface\execute(), ilDBInterface\free(), manipulateF(), prepareManip(), quote(), quoteIdentifier(), and sanitizeMB4StringIfNotSupported().

Here is the call graph for this function:

upper()

ilDBPdo::upper

(

$a_exp

)

Parameters

$a_exp

Returns

string

Implements ilDBInterface.

Definition at line 1331 of file class.ilDBPdo.php.

    {
        return " UPPER(" . $a_exp . ") ";
    }

useSlave()

ilDBPdo::useSlave

(

$bool

)

Parameters

$bool

Returns

bool

TODO

Implements ilDBInterface.

Definition at line 1084 of file class.ilDBPdo.php.

    {
        return false;
    }

Field Documentation

$attributes

ilDBPdo::$attributes

protected

Initial value:

= array(
        
        PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION,
    )

Definition at line 70 of file class.ilDBPdo.php.

Referenced by addTableColumn(), and getAttributes().

$charset

ilDBPdo::$charset = 'utf8'

protected

Definition at line 26 of file class.ilDBPdo.php.

Referenced by generateDSN(), getCharset(), and setCharset().

$db_type

ilDBPdo::$db_type = ''

protected

Definition at line 77 of file class.ilDBPdo.php.

Referenced by getDBType().

$dbname

ilDBPdo::$dbname = ''

protected

Definition at line 22 of file class.ilDBPdo.php.

Referenced by generateDSN(), getDbname(), and setDbname().

$dsn

ilDBPdo::$dsn = ''

protected

Definition at line 66 of file class.ilDBPdo.php.

Referenced by getDSN().

$error_code

ilDBPdo::$error_code = 0

protected

Definition at line 81 of file class.ilDBPdo.php.

Referenced by getLastErrorCode().

$field_definition

ilDBPdo::$field_definition

protected

Definition at line 85 of file class.ilDBPdo.php.

Referenced by getFieldDefinition(), modifyTableColumn(), and setFieldDefinition().

$host

ilDBPdo::$host = ''

protected

Definition at line 18 of file class.ilDBPdo.php.

Referenced by generateDSN(), getHost(), setDBHost(), and setHost().

$limit

ilDBPdo::$limit = null

protected

Definition at line 54 of file class.ilDBPdo.php.

Referenced by appendLimit(), and setLimit().

$manager

ilDBPdo::$manager

protected

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

Referenced by addUniqueConstraint(), and loadModule().

$offset

ilDBPdo::$offset = null

protected

Definition at line 58 of file class.ilDBPdo.php.

Referenced by ilDBPdoPostgreSQL\appendLimit(), and setLimit().

$password

ilDBPdo::$password = ''

protected

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

Referenced by getPassword(), setDBPassword(), and setPassword().

$pdo

ilDBPdo::$pdo

protected

Definition at line 42 of file class.ilDBPdo.php.

$port

ilDBPdo::$port = 3306

protected

Definition at line 38 of file class.ilDBPdo.php.

Referenced by generateDSN(), getPort(), setDBPort(), and setPort().

$reverse

ilDBPdo::$reverse

protected

Definition at line 50 of file class.ilDBPdo.php.

Referenced by loadModule().

$storage_engine

ilDBPdo::$storage_engine = 'MyISAM'

protected

Definition at line 62 of file class.ilDBPdo.php.

Referenced by getStorageEngine(), and setStorageEngine().

$username

ilDBPdo::$username = ''

protected

Definition at line 30 of file class.ilDBPdo.php.

Referenced by getUsername(), and setUsername().

FEATURE_FULLTEXT

const ilDBPdo::FEATURE_FULLTEXT = 'fulltext'

Definition at line 13 of file class.ilDBPdo.php.

Referenced by supports().

FEATURE_SLAVE

const ilDBPdo::FEATURE_SLAVE = 'slave'

Definition at line 14 of file class.ilDBPdo.php.

Referenced by supports().

FEATURE_TRANSACTIONS

const ilDBPdo::FEATURE_TRANSACTIONS = 'transactions'

Definition at line 12 of file class.ilDBPdo.php.

Referenced by supports().

---

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

• Services/Database/classes/PDO/class.ilDBPdo.php