ilDBPdoInterface Interface Reference

Interface ilDBPdoInterface. More...

Inheritance diagram for ilDBPdoInterface:

Collaboration diagram for ilDBPdoInterface:

Public Member Functions
	getServerVersion (bool $native=false)
	queryCol (string $query, int $type=ilDBConstants::FETCHMODE_DEFAULT, int $colnum=0)
	queryRow (string $query, ?array $types=null, int $fetchmode=ilDBConstants::FETCHMODE_DEFAULT)
	escape (string $value, bool $escape_wildcards=false)
	escapePattern (string $text)
	migrateTableToEngine (string $table_name, string $engine=ilDBConstants::MYSQL_ENGINE_INNODB)
	migrateAllTablesToEngine (string $engine=ilDBConstants::MYSQL_ENGINE_INNODB)
	supportsEngineMigration ()
	migrateTableCollation (string $table_name, string $collation=ilDBConstants::MYSQL_COLLATION_UTF8MB4)
	migrateAllTablesToCollation (string $collation=ilDBConstants::MYSQL_COLLATION_UTF8MB4)
	supportsCollationMigration ()
	addUniqueConstraint (string $table, array $fields, string $name="con")
	dropUniqueConstraint (string $table, string $name="con")
	dropUniqueConstraintByFields (string $table, array $fields)
	checkIndexName (string $name)
	getLastInsertId ()
	uniqueConstraintExists (string $table, array $fields)
	dropPrimaryKey (string $table_name)
	executeMultiple (ilDBStatement $stmt, array $data)
	fromUnixtime (string $expr, bool $to_text=true)
	unixTimestamp ()
	getDBVersion ()
	returns the Version of the Database (e.g. More...
Public Member Functions inherited from ilDBInterface
	doesCollationSupportMB4Strings ()
	sanitizeMB4StringIfNotSupported (string $query)
	initFromIniFile (?ilIniFile $ini=null)
	connect (bool $return_false_on_error=false)
	nextId (string $table_name)
	createTable (string $table_name, array $fields, bool $drop_table=false, bool $ignore_erros=false)
	addPrimaryKey (string $table_name, array $primary_keys)
	createSequence (string $table_name, int $start=1)
	getSequenceName (string $table_name)
	tableExists (string $table_name)
	tableColumnExists (string $table_name, string $column_name)
	addTableColumn (string $table_name, string $column_name, array $attributes)
	dropTable (string $table_name, bool $error_if_not_existing=true)
	renameTable (string $old_name, string $new_name)
	query (string $query)
	Run a (read-only) Query on the database. More...
	fetchAll (ilDBStatement $statement, int $fetch_mode=ilDBConstants::FETCHMODE_ASSOC)
	dropSequence (string $table_name)
	dropTableColumn (string $table_name, string $column_name)
	renameTableColumn (string $table_name, string $column_old_name, string $column_new_name)
	insert (string $table_name, array $values)
	fetchObject (ilDBStatement $query_result)
	update (string $table_name, array $values, array $where)
	@description $where MUST contain existing columns only. More...
	manipulate (string $query)
	Run a (write) Query on the database. More...
	fetchAssoc (ilDBStatement $statement)
	numRows (ilDBStatement $statement)
	quote ($value, string $type)
	addIndex (string $table_name, array $fields, string $index_name='', bool $fulltext=false)
	indexExistsByFields (string $table_name, array $fields)
	getDSN ()
	Get DSN. More...
	getDBType ()
	Get DSN. More...
	lockTables (array $tables)
	Abstraction of lock table. More...
	unlockTables ()
	Unlock tables locked by previous lock table calls. More...
	in (string $field, array $values, bool $negate=false, string $type="")
	queryF (string $query, array $types, array $values)
	manipulateF (string $query, array $types, array $values)
	useSlave (bool $bool)
	setLimit (int $limit, int $offset=0)
	like (string $column, string $type, string $value="?", bool $case_insensitive=true)
	Generate a like subquery. More...
	now ()
	replace (string $table, array $primary_keys, array $other_columns)
	Replace into method. More...
	equals (string $columns, $value, string $type, bool $emptyOrNull=false)
	setDBUser (string $user)
	setDBPort (int $port)
	setDBPassword (string $password)
	setDBHost (string $host)
	upper (string $expression)
	lower (string $expression)
	substr (string $expression)
	prepare (string $a_query, array $a_types=null, array $a_result_types=null)
	Prepare a query (SELECT) statement to be used with execute. More...
	prepareManip (string $a_query, ?array $a_types=null)
	enableResultBuffering (bool $a_status)
	execute (ilDBStatement $stmt, array $data=[])
	sequenceExists (string $sequence)
	listSequences ()
	supports (string $feature)
	supportsFulltext ()
	supportsSlave ()
	supportsTransactions ()
	listTables ()
	loadModule (string $module)
	getAllowedAttributes ()
	concat (array $values, bool $allow_null=true)
	locate (string $needle, string $string, int $start_pos=1)
	quoteIdentifier (string $identifier, bool $check_option=false)
	modifyTableColumn (string $table, string $column, array $attributes)
	free (ilDBStatement $a_st)
	checkTableName (string $a_name)
	beginTransaction ()
	commit ()
	rollback ()
	constraintName (string $a_table, string $a_constraint)
	dropIndex (string $a_table, string $a_name="i1")
	createDatabase (string $a_name, string $a_charset="utf8", string $a_collation="")
	dropIndexByFields (string $table_name, array $afields)
	getPrimaryKeyIdentifier ()
	addFulltextIndex (string $table_name, array $afields, string $a_name='in')
	dropFulltextIndex (string $a_table, string $a_name)
	isFulltextIndex (string $a_table, string $a_name)
	setStorageEngine (string $storage_engine)
	getStorageEngine ()
	buildAtomQuery ()
	groupConcat (string $a_field_name, string $a_seperator=",", ?string $a_order=null)
	cast (string $a_field_name, string $a_dest_type)
	primaryExistsByFields (string $table_name, array $fields)

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

Detailed Description

Interface ilDBPdoInterface.

Definition at line 24 of file interface.ilDBPdoInterface.php.

Member Function Documentation

addUniqueConstraint()

ilDBPdoInterface::addUniqueConstraint	(	string	$table,
		array	$fields,
		string	$name = "con"
	)

Implemented in ilDBPdo.

checkIndexName()

ilDBPdoInterface::checkIndexName

(

string

$name

)

Implemented in ilDBPdo.

dropPrimaryKey()

ilDBPdoInterface::dropPrimaryKey

(

string

$table_name

)

Implemented in ilDBPdo.

dropUniqueConstraint()

ilDBPdoInterface::dropUniqueConstraint	(	string	$table,
		string	$name = "con"
	)

Implemented in ilDBPdo.

dropUniqueConstraintByFields()

ilDBPdoInterface::dropUniqueConstraintByFields	(	string	$table,
		array	$fields
	)

Implemented in ilDBPdo.

escape()

ilDBPdoInterface::escape	(	string	$value,
		bool	$escape_wildcards = false
	)

Implemented in ilDBPdo.

escapePattern()

ilDBPdoInterface::escapePattern

(

string

$text

)

Implemented in ilDBPdo.

executeMultiple()

ilDBPdoInterface::executeMultiple	(	ilDBStatement	$stmt,
		array	$data
	)

Parameters

ilDBStatement[]

$stmt

Returns

string[]

Implemented in ilDBPdo.

fromUnixtime()

ilDBPdoInterface::fromUnixtime	(	string	$expr,
		bool	$to_text = true
	)

Implemented in ilDBPdo.

getDBVersion()

ilDBPdoInterface::getDBVersion

(

)

returns the Version of the Database (e.g.

MySQL 5.6)

Implemented in ilDBPdo.

getLastInsertId()

ilDBPdoInterface::getLastInsertId

(

)

Implemented in ilDBPdo.

getServerVersion()

ilDBPdoInterface::getServerVersion

(

bool

$native = false

)

Implemented in ilDBPdo.

migrateAllTablesToCollation()

ilDBPdoInterface::migrateAllTablesToCollation

(

string

$collation = ilDBConstants::MYSQL_COLLATION_UTF8MB4

)

Returns

array of failed tables

Implemented in ilDBPdo, and ilDBPdoMySQL.

migrateAllTablesToEngine()

ilDBPdoInterface::migrateAllTablesToEngine

(

string

$engine = ilDBConstants::MYSQL_ENGINE_INNODB

)

Returns

array of failed tables

Implemented in ilDBPdo, and ilDBPdoMySQL.

migrateTableCollation()

ilDBPdoInterface::migrateTableCollation	(	string	$table_name,
		string	$collation = ilDBConstants::MYSQL_COLLATION_UTF8MB4
	)

Implemented in ilDBPdoMySQL.

migrateTableToEngine()

ilDBPdoInterface::migrateTableToEngine	(	string	$table_name,
		string	$engine = ilDBConstants::MYSQL_ENGINE_INNODB
	)

Implemented in ilDBPdoMySQL.

queryCol()

ilDBPdoInterface::queryCol	(	string	$query,
		int	$type = ilDBConstants::FETCHMODE_DEFAULT,
		int	$colnum = 0
	)

Implemented in ilDBPdo.

queryRow()

ilDBPdoInterface::queryRow	(	string	$query,
		?array	$types = null,
		int	$fetchmode = ilDBConstants::FETCHMODE_DEFAULT
	)

Implemented in ilDBPdo.

supportsCollationMigration()

ilDBPdoInterface::supportsCollationMigration

(

)

Implemented in ilDBPdo, and ilDBPdoMySQL.

supportsEngineMigration()

ilDBPdoInterface::supportsEngineMigration

(

)

Implemented in ilDBPdo, and ilDBPdoMySQL.

uniqueConstraintExists()

ilDBPdoInterface::uniqueConstraintExists	(	string	$table,
		array	$fields
	)

Implemented in ilDBPdo.

unixTimestamp()

ilDBPdoInterface::unixTimestamp

(

)

Implemented in ilDBPdo.

---

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

• Services/Database/interfaces/interface.ilDBPdoInterface.php