ilDBInterface Interface Reference

Interface ilDBInterface. More...

Inheritance diagram for ilDBInterface:

Collaboration diagram for ilDBInterface:

Public Member Functions
	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)

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

Detailed Description

Interface ilDBInterface.

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 26 of file interface.ilDBInterface.php.

Member Function Documentation

addFulltextIndex()

ilDBInterface::addFulltextIndex	(	string	$table_name,
		array	$afields,
		string	$a_name = 'in'
	)

Implemented in ilDBPdo, and ilDBPdoMySQLInnoDB.

addIndex()

ilDBInterface::addIndex	(	string	$table_name,
		array	$fields,
		string	$index_name = '',
		bool	$fulltext = false
	)

Implemented in ilDBPdo.

addPrimaryKey()

ilDBInterface::addPrimaryKey	(	string	$table_name,
		array	$primary_keys
	)

Implemented in ilDBPdo.

Referenced by ILIAS\Portfolio\Setup\ilPortfolioDBUpdateSteps\step_1().

Here is the caller graph for this function:

addTableColumn()

ilDBInterface::addTableColumn	(	string	$table_name,
		string	$column_name,
		array	$attributes
	)

Implemented in ilDBPdo.

Referenced by ILIAS\MediaCast\Setup\ilMediaCastDBUpdateSteps\step_1(), ILIAS\MediaObjects\Setup\ilMediaObjectsDBUpdateSteps\step_1(), ILIAS\MediaCast\Setup\ilMediaCastDBUpdateSteps\step_2(), and ILIAS\MediaCast\Setup\ilMediaCastDBUpdateSteps\step_3().

Here is the caller graph for this function:

beginTransaction()

ilDBInterface::beginTransaction

(

)

Exceptions

ilDatabaseException

Implemented in ilDBPdo.

buildAtomQuery()

ilDBInterface::buildAtomQuery

(

)

Implemented in ilDBPdo, and ilDBPdoMySQLGalera.

Referenced by ilObjectActivation\createDefaultEntry().

Here is the caller graph for this function:

cast()

ilDBInterface::cast	(	string	$a_field_name,
		string	$a_dest_type
	)

Implemented in ilDBPdo.

Referenced by ilMaterializedPathTree\createMaterializedPath().

Here is the caller graph for this function:

checkTableName()

ilDBInterface::checkTableName

(

string

$a_name

)

Implemented in ilDBPdo.

commit()

ilDBInterface::commit

(

)

Exceptions

ilDatabaseException

Implemented in ilDBPdo.

concat()

ilDBInterface::concat	(	array	$values,
		bool	$allow_null = true
	)

Implemented in ilDBPdo.

connect()

ilDBInterface::connect

(

bool

$return_false_on_error = false

)

Implemented in ilDBPdo.

constraintName()

ilDBInterface::constraintName	(	string	$a_table,
		string	$a_constraint
	)

Implemented in ilDBPdo.

createDatabase()

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

Implemented in ilDBPdo.

createSequence()

ilDBInterface::createSequence	(	string	$table_name,
		int	$start = 1
	)

Implemented in ilDBPdo.

createTable()

ilDBInterface::createTable	(	string	$table_name,
		array	$fields,
		bool	$drop_table = false,
		bool	$ignore_erros = false
	)

Implemented in ilDBPdo.

Referenced by ILIAS\Portfolio\Setup\ilPortfolioDBUpdateSteps\step_1().

Here is the caller graph for this function:

doesCollationSupportMB4Strings()

ilDBInterface::doesCollationSupportMB4Strings

(

)

Implemented in ilDBPdo, and ilDBPdoMySQL.

dropFulltextIndex()

ilDBInterface::dropFulltextIndex	(	string	$a_table,
		string	$a_name
	)

Implemented in ilDBPdo.

dropIndex()

ilDBInterface::dropIndex	(	string	$a_table,
		string	$a_name = "i1"
	)

Implemented in ilDBPdo.

dropIndexByFields()

ilDBInterface::dropIndexByFields	(	string	$table_name,
		array	$afields
	)

Implemented in ilDBPdo.

dropSequence()

ilDBInterface::dropSequence

(

string

$table_name

)

Implemented in ilDBPdo.

dropTable()

ilDBInterface::dropTable	(	string	$table_name,
		bool	$error_if_not_existing = true
	)

Implemented in ilDBPdo.

dropTableColumn()

ilDBInterface::dropTableColumn	(	string	$table_name,
		string	$column_name
	)

Implemented in ilDBPdo.

enableResultBuffering()

ilDBInterface::enableResultBuffering

(

bool

$a_status

)

Implemented in ilDBPdo.

equals()

ilDBInterface::equals	(	string	$columns,
			$value,
		string	$type,
		bool	$emptyOrNull = false
	)

Implemented in ilDBPdo.

execute()

ilDBInterface::execute	(	ilDBStatement	$stmt,
		array	$data = []
	)

Exceptions

ilDatabaseException

Referenced by ilDatabasePopulatedObjective\readDumpFile().

Here is the caller graph for this function:

fetchAll()

ilDBInterface::fetchAll	(	ilDBStatement	$statement,
		int	$fetch_mode = ilDBConstants::FETCHMODE_ASSOC
	)

Implemented in ilDBPdo.

Referenced by ilRecommendedContentDBRepository\getDeclinedUserObjectRecommendations(), ilRecommendedContentDBRepository\getRecommendationsOfRoles(), and ilRecommendedContentDBRepository\getUserObjectRecommendations().

Here is the caller graph for this function:

fetchAssoc()

ilDBInterface::fetchAssoc

(

ilDBStatement

$statement

)

Implemented in ilDBPdo.

Referenced by ilObject\_getAllReferences(), ilObject\_getIdForImportId(), ilObject\_getIdsForTitle(), ilObject\_getLastUpdateOfObjects(), ilObject\_getObjectsByType(), ilObject\_getObjectsDataForType(), ilObject\_lookupCreationDate(), ilObject\_lookupDeletedDate(), ilFavouritesDBRepository\add(), ilBookingPrefBasedBookGatewayRepository\checkProcessHash(), ilMaterializedPathTree\createFromParentRelation(), ilMaterializedPathTree\createMaterializedPath(), ilWorkspaceTree\exists(), ilAdvancedMDFieldDefinition\exists(), ILIAS\Style\Content\Container\ContainerDBRepository\filterByReuse(), ilExAssignment\fixInstructionFileOrdering(), ilObject\fixMissingTitles(), ILIAS\Survey\Participants\InvitationsDBRepository\getAllForSurvey(), ILIAS\Survey\Participants\InvitationsDBRepository\getAllForUser(), ilObject\getAllOwnedRepositoryObjects(), ilExcAssMemberStateRepository\getAssignmentIdsWithGradingNeeded(), ILIAS\Style\Content\CharacteristicDBRepo\getByKey(), ILIAS\Style\Content\CharacteristicDBRepo\getByTypes(), ilBenchmark\getCurrentRecordNumber(), ilBenchmark\getDbBenchRecords(), ilMDCopyrightSelectionEntry\getDefault(), ilPageObject\getEditLock(), ilPageObject\getEditLockInfo(), ilContainerFilterFieldData\getFilterSetForRefId(), ilPageObject\getHistoryEntries(), ilPageObject\getHistoryEntry(), ilPageObject\getHistoryInfo(), ilAdvancedMDFieldDefinition\getInstance(), ilObjectActivation\getItem(), ilObject\getLongDescriptions(), ILIAS\COPage\History\HistoryDBRepository\getMaxHistEntryPerPageOlderThanX(), ILIAS\Style\Content\Object\ObjectDBRepository\getOwnedStyles(), ilSkillTreeDBRepository\getParentNodeIdForNodeId(), ilBookingPrefBasedBookGatewayRepository\getPoolsWithOverdueBooking(), ilObjBookingPool\getPoolsWithReminders(), ilBookingPreferencesDBRepository\getPreferences(), ilExternalFeedRemoveMigration\getRemainingAmountOfSteps(), ilWorkspaceFolderUserSettingsRepository\getSortation(), ilWorkspaceFolderUserSettingsRepository\getSortationMultiple(), ilSkillTreeDBRepository\getTreeIdForNodeId(), ilSkillResources\getTriggerLevelsForRefId(), ilObjUseBookDBRepository\getUsedBookingPools(), ilUserProfilePromptDataGateway\getUserPrompt(), ILIAS\Exercise\Submission\SubmissionDBRepository\getUserSubmissionState(), ILIAS\Survey\Settings\SettingsDBRepository\hasEnded(), ilGlossaryTermReferences\hasReferences(), ilBookingPrefBasedBookGatewayRepository\hasRun(), ilRecommendedContentDBRepository\ifExistsObjectRecommendation(), ilFavouritesDBRepository\ifIsFavourite(), ilSkillTree\initChildsData(), ilExAssignment\instructionFileOrderGetMax(), ILIAS\Style\Content\Object\ObjectDBRepository\isOwned(), ilFavouritesDBRepository\loadData(), ilObjOrgUnit\loadRootOrgRefIdAndId(), ilPageObject\lookupParentId(), ilBookingObject\lookupPoolId(), ilBookingObject\lookupTitle(), ilPageObject\preloadActivationDataByParentId(), ilObjectActivation\preloadData(), ilContainerGlobalProfiles\read(), ilContainerLocalProfiles\read(), ilContainerSkills\read(), ilObjNotificationSettings\read(), ILIAS\Style\Content\Container\ContainerDBRepository\readReuse(), ilPageObject\releasePageLock(), SurveySearch\search(), ilForumCronNotification\sendCronForumNotification(), ilExternalFeedRemoveMigration\step(), ILIAS\BookingManager\Setup\ilBookingManager8HotfixDBUpdateSteps\step_1(), and ILIAS\Notes\Setup\ilNotesDBUpdateSteps\step_1().

Here is the caller graph for this function:

fetchObject()

ilDBInterface::fetchObject

(

ilDBStatement

$query_result

)

Implemented in ilDBPdo.

Referenced by ilObject\_lookupObjIdByImportId(), ilDatabaseEnvironmentValidObjective\checkDefaultEngine(), ilDatabaseEnvironmentValidObjective\checkRowFormat(), ilDatabasePopulatedObjective\getDefaultEngine(), ilObjOrgUnit\getIconsCache(), and ilMDCopyrightSelectionEntry\lookupCopyrightFromImport().

Here is the caller graph for this function:

free()

ilDBInterface::free

(

ilDBStatement

$a_st

)

Implemented in ilDBPdo.

getAllowedAttributes()

ilDBInterface::getAllowedAttributes

(

)

Returns

string[]

Implemented in ilDBPdo.

getDBType()

ilDBInterface::getDBType

(

)

Get DSN.

This must be overwritten in DBMS specific class.

Implemented in ilDBPdo.

Referenced by ilDatabasePopulatedObjective\setDefaultEngine().

Here is the caller graph for this function:

getDSN()

ilDBInterface::getDSN

(

)

Get DSN.

This must be overwritten in DBMS specific class.

Implemented in ilDBPdo.

getPrimaryKeyIdentifier()

ilDBInterface::getPrimaryKeyIdentifier

(

)

Implemented in ilDBPdo.

getReservedWords()

static ilDBInterface::getReservedWords ( )

static

Get reserved words.

This must be overwritten in DBMS specific class. This is mainly used to check whether a new identifier can be problematic because it is a reserved word. So createTable / alterTable usually check these.

Returns

string[]

getSequenceName()

ilDBInterface::getSequenceName

(

string

$table_name

)

Implemented in ilDBPdo.

getStorageEngine()

ilDBInterface::getStorageEngine

(

)

Implemented in ilDBPdo.

groupConcat()

ilDBInterface::groupConcat	(	string	$a_field_name,
		string	$a_seperator = ",",
		?string	$a_order = null
	)

Implemented in ilDBPdo.

in()

ilDBInterface::in	(	string	$field,
		array	$values,
		bool	$negate = false,
		string	$type = ""
	)

Implemented in ilDBPdo.

Referenced by ilObject\_getLastUpdateOfObjects(), ILIAS\Style\Content\Container\ContainerDBRepository\filterByReuse(), ilObject\fixMissingTitles(), ilObject\getAllOwnedRepositoryObjects(), ilExcAssMemberStateRepository\getAssignmentIdsWithGradingNeeded(), ilObject\getLongDescriptions(), ILIAS\Style\Content\Object\ObjectDBRepository\getOwnedStyles(), ilRecommendedContentDBRepository\getRecommendationsOfRoles(), ilWorkspaceFolderUserSettingsRepository\getSortationMultiple(), ilExSubmission\getSubmissionsForFilename(), ILIAS\Exercise\Submission\SubmissionDBRepository\getUserSubmissionState(), ilObjectActivation\hasChangeableTimings(), ILIAS\Survey\Settings\SettingsDBRepository\hasEnded(), ilObjectActivation\hasTimings(), ilFavouritesDBRepository\loadData(), ilMDRights\lookupRightsByTypeAndCopyright(), ilObjectActivation\preloadData(), ilCOPageDataSet\readData(), ilObject\setDeletedDates(), and ilExternalFeedRemoveMigration\step().

Here is the caller graph for this function:

indexExistsByFields()

ilDBInterface::indexExistsByFields	(	string	$table_name,
		array	$fields
	)

Implemented in ilDBPdo.

initFromIniFile()

ilDBInterface::initFromIniFile

(

?ilIniFile

$ini = null

)

Implemented in ilDBPdo.

insert()

ilDBInterface::insert	(	string	$table_name,
		array	$values
	)

Returns

int The number of rows affected by the manipulation

Implemented in ilDBPdo.

Referenced by ilObject\_writeDescription(), ilRecommendedContentDBRepository\addObjectRecommendation(), ilRecommendedContentDBRepository\declineObjectRecommendation(), ilLSPostConditionDB\insert(), ilBenchmark\save(), ilContainerFilterFieldData\saveFilterSetForRefId(), ilBookingPreferencesDBRepository\savePreferences(), ilBookingPreferencesDBRepository\savePreferencesOfUser(), ILIAS\MediaCast\Setup\ilMediaCastDBUpdateSteps\step_4(), ilStudyProgrammeAutoCategoryDBRepository\update(), ilStudyProgrammeAutoMembershipsDBRepository\update(), and ilObjUseBookDBRepository\updateUsedBookingPools().

Here is the caller graph for this function:

isFulltextIndex()

ilDBInterface::isFulltextIndex	(	string	$a_table,
		string	$a_name
	)

Implemented in ilDBPdo.

isReservedWord()

static ilDBInterface::isReservedWord ( string  $a_word )

static

Implemented in ilDBPdo.

like()

ilDBInterface::like	(	string	$column,
		string	$type,
		string	$value = "?",
		bool	$case_insensitive = true
	)

Generate a like subquery.

Implemented in ilDBPdo.

Referenced by ilObject\_getIdsForTitle(), and SurveySearch\search().

Here is the caller graph for this function:

listSequences()

ilDBInterface::listSequences

(

)

Returns

string[]

Implemented in ilDBPdo.

listTables()

ilDBInterface::listTables

(

)

Returns

string[]

Implemented in ilDBPdo.

Referenced by ilDatabasePopulatedObjective\isDatabasePopulated().

Here is the caller graph for this function:

loadModule()

ilDBInterface::loadModule

(

string

$module

)

Parameters

string

$module

Manager|Reverse

Returns

ilDBReverse|ilDBManager

Implemented in ilDBPdo.

locate()

ilDBInterface::locate	(	string	$needle,
		string	$string,
		int	$start_pos = 1
	)

Implemented in ilDBPdo.

lockTables()

ilDBInterface::lockTables

(

array

$tables

)

Abstraction of lock table.

Parameters

array

table definitions

Deprecated:

Use ilAtomQuery instead

Implemented in ilDBPdo.

lower()

ilDBInterface::lower

(

string

$expression

)

Implemented in ilDBPdo.

manipulate()

ilDBInterface::manipulate

(

string

$query

)

Run a (write) Query on the database.

Returns

int The number of rows affected by the manipulation

Implemented in ilDBPdo.

Referenced by ilBenchmark\clearData(), ilADTActiveRecordByType\create(), ilContainerGlobalProfiles\delete(), ilContainerMemberSkills\delete(), ilContainerSkills\delete(), ilObjNotificationSettings\delete(), ilLSPostConditionDB\delete(), ilObjectActivation\deleteAllEntries(), ilAdvancedMDRecordScope\deleteByRecordId(), ilLORandomTestQuestionPools\deleteForObjectiveAndTestType(), ilGlossaryTermReferences\deleteReferencesOfTerm(), ilExAssignment\fixInstructionFileOrdering(), ilPageObject\getEditLock(), ilPageObject\increaseViewCnt(), ilExAssignment\instructionFileDeleteOrder(), ilExAssignment\instructionFileInsertOrder(), ilExternalFeedRemoveMigration\manipulate(), ilContainerMemberSkills\publish(), ilPageObject\releasePageLock(), ilExAssignment\renameInstructionFile(), ilLOUserResults\resetFinalByObjective(), ilContainerGlobalProfiles\save(), ilContainerSkills\save(), ilBenchmark\save(), ilContainerMemberSkills\saveLevelForSkills(), ilDatabasePopulatedObjective\setDefaultEngine(), ilObject\setDeletedDates(), ILIAS\MediaCast\Setup\ilMediaCastDBUpdateSteps\step_4(), ilStudyProgrammeAutoCategoryDBRepository\update(), ilStudyProgrammeAutoMembershipsDBRepository\update(), and ilLOUserResults\updateResultLimit().

Here is the caller graph for this function:

manipulateF()

ilDBInterface::manipulateF	(	string	$query,
		array	$types,
		array	$values
	)

Parameters

$types

string[]

Returns

int The number of rows affected by the manipulation

Implemented in ilDBPdo.

Referenced by ilTree\_removeEntry(), ilPageObject\_writeParentId(), ilFavouritesDBRepository\add(), ilMaterializedPathTree\createMaterializedPath(), ILIAS\Survey\Code\CodeDBRepo\delete(), ILIAS\Survey\Code\CodeDBRepo\deleteAll(), ilLMMenuEditor\fixImportMenuItems(), ILIAS\Survey\Participants\InvitationsDBRepository\remove(), ilFavouritesDBRepository\remove(), ILIAS\Survey\Participants\InvitationsDBRepository\removeAll(), ilFavouritesDBRepository\removeFavouritesOfRefId(), ilFavouritesDBRepository\removeFavouritesOfUser(), ilRecommendedContentDBRepository\removeObjectRecommendation(), ilRecommendedContentDBRepository\removeRecommendationsOfRefId(), ilRecommendedContentDBRepository\removeRecommendationsOfRole(), ilRecommendedContentDBRepository\removeRecommendationsOfUser(), ilRecommendedContentDBRepository\removeRoleRecommendation(), ilTreeImplementationSwitch\renumberNestedSet(), ilContainerFilterFieldData\saveFilterSetForRefId(), ILIAS\Wiki\Setup\ilWiki8HotfixDBUpdateSteps\step_1(), ILIAS\Notes\Setup\ilNotesDBUpdateSteps\step_1(), and ilTestRandomQuestionSetStagingPoolQuestionList\updateSourceQuestionPoolId().

Here is the caller graph for this function:

modifyTableColumn()

ilDBInterface::modifyTableColumn	(	string	$table,
		string	$column,
		array	$attributes
	)

Implemented in ilDBPdo.

Referenced by ILIAS\Wiki\Setup\ilWikiDBUpdateSteps\step_1(), ILIAS\Wiki\Setup\ilWikiDBUpdateSteps\step_2(), ILIAS\MediaObjects\Setup\ilMediaObjectsDBUpdateSteps\step_2(), and ILIAS\Wiki\Setup\ilWikiDBUpdateSteps\step_3().

Here is the caller graph for this function:

nextId()

ilDBInterface::nextId

(

string

$table_name

)

Implemented in ilDBPdo, and ilDBPdoMySQL.

Referenced by ilBenchmark\save().

Here is the caller graph for this function:

now()

ilDBInterface::now

(

)

Returns

string the now statement

Implemented in ilDBPdo.

Referenced by ilObject\_setDeletedDate(), ilObject\_writeDescription(), ilObject\_writeImportId(), ilObject\_writeTitle(), and ilObject\setDeletedDates().

Here is the caller graph for this function:

numRows()

ilDBInterface::numRows

(

ilDBStatement

$statement

)

Implemented in ilDBPdo.

Referenced by ilObject\_exists(), ilObject\_getObjectsByType(), ilObject\_lookupObjIdByImportId(), ilObjectActivation\createDefaultEntry(), and ilExAssignment\instructionFileExistsInDb().

Here is the caller graph for this function:

prepare()

ilDBInterface::prepare	(	string	$a_query,
		array	$a_types = null,
		array	$a_result_types = null
	)

Prepare a query (SELECT) statement to be used with execute.

prepareManip()

ilDBInterface::prepareManip	(	string	$a_query,
		?array	$a_types = null
	)

Implemented in ilDBPdo.

Referenced by ilDatabasePopulatedObjective\readDumpFile().

Here is the caller graph for this function:

primaryExistsByFields()

ilDBInterface::primaryExistsByFields	(	string	$table_name,
		array	$fields
	)

Implemented in ilDBPdo.

query()

ilDBInterface::query

(

string

$query

)

Run a (read-only) Query on the database.

Implemented in ilDBPdo.

Referenced by ilObject\_exists(), ilObject\_getAllReferences(), ilObject\_getIdForImportId(), ilObject\_getIdsForTitle(), ilObject\_getLastUpdateOfObjects(), ilObject\_getObjectsByType(), ilObject\_getObjectsDataForType(), ilObject\_lookupCreationDate(), ilObject\_lookupDeletedDate(), ilObject\_lookupImportId(), ilObject\_lookupObjIdByImportId(), ilObject\_writeDescription(), ilDatabaseEnvironmentValidObjective\checkDefaultEngine(), ilDatabaseEnvironmentValidObjective\checkRowFormat(), ilObjectActivation\createDefaultEntry(), ilDBUpdate\execQuery(), ilAdvancedMDFieldDefinition\exists(), ilExAssignment\fixInstructionFileOrdering(), ilObject\fixMissingTitles(), ilObject\getAllOwnedRepositoryObjects(), ilBenchmark\getCurrentRecordNumber(), ilBenchmark\getDbBenchRecords(), ilMDCopyrightSelectionEntry\getDefault(), ilDatabasePopulatedObjective\getDefaultEngine(), ilPageObject\getEditLock(), ilPageObject\getEditLockInfo(), ilEventItems\getEventsForItemOrderedByStartingTime(), ilPageObject\getHistoryEntries(), ilPageObject\getHistoryInfo(), ilObjOrgUnit\getIconsCache(), ilAdvancedMDFieldDefinition\getInstance(), ilObjectActivation\getItem(), ilObject\getLongDescriptions(), ilConditionHandler\getNumberOfConditionsOfTrigger(), ilRecommendedContentDBRepository\getRecommendationsOfRoles(), ilSkillResources\getTriggerLevelsForRefId(), ilObjectActivation\hasChangeableTimings(), ilGlossaryTermReferences\hasReferences(), ilObjectActivation\hasTimings(), ilExAssignment\instructionFileExistsInDb(), ilFavouritesDBRepository\loadData(), ilObjOrgUnit\loadRootOrgRefIdAndId(), ilDidacticTemplateSettings\lookupAssignedObjectTypes(), ilMDCopyrightSelectionEntry\lookupCopyrightFromImport(), ilOerHarvesterObjectStatus\lookupHarvested(), ilSCTasks\lookupIdentifierForTask(), ilObjCourseReference\lookupMemberUpdateEnabled(), ilOerHarvesterObjectStatus\lookupObjIdByHarvestingId(), ilPageObject\lookupParentId(), ilCalendarCategories\lookupRemoteCalendars(), ilMDRights\lookupRightsByTypeAndCopyright(), ilTree\lookupTreesForNode(), ilPageObject\preloadActivationDataByParentId(), ilObjectActivation\preloadData(), ilContainerGlobalProfiles\read(), ilContainerLocalProfiles\read(), ilContainerMemberSkills\read(), ilContainerSkills\read(), ilObjNotificationSettings\read(), ilObjectActivation\read(), ilObjLTIAdministration\readReleaseObjects(), ilPageObject\releasePageLock(), ilTreeImplementationSwitch\renumberNestedSet(), SurveySearch\search(), and ILIAS\Notes\Setup\ilNotesDBUpdateSteps\step_1().

Here is the caller graph for this function:

queryF()

ilDBInterface::queryF	(	string	$query,
		array	$types,
		array	$values
	)

Parameters

$types

string[]

Implemented in ilDBPdo.

Referenced by ilFavouritesDBRepository\add(), ilBookingPrefBasedBookGatewayRepository\checkProcessHash(), ilMaterializedPathTree\createFromParentRelation(), ilMaterializedPathTree\createMaterializedPath(), ilWorkspaceTree\exists(), ILIAS\Style\Content\Container\ContainerDBRepository\filterByReuse(), ILIAS\Survey\Participants\InvitationsDBRepository\getAllForSurvey(), ILIAS\Survey\Participants\InvitationsDBRepository\getAllForUser(), ilExcAssMemberStateRepository\getAssignmentIdsWithGradingNeeded(), ILIAS\Style\Content\CharacteristicDBRepo\getByKey(), ILIAS\Style\Content\CharacteristicDBRepo\getByTypes(), ilRecommendedContentDBRepository\getDeclinedUserObjectRecommendations(), ilContainerFilterFieldData\getFilterSetForRefId(), ilPageObject\getHistoryEntry(), ILIAS\COPage\History\HistoryDBRepository\getMaxHistEntryPerPageOlderThanX(), ILIAS\Style\Content\Object\ObjectDBRepository\getOwnedStyles(), ilSkillTreeDBRepository\getParentNodeIdForNodeId(), ilBookingPrefBasedBookGatewayRepository\getPoolsWithOverdueBooking(), ilObjBookingPool\getPoolsWithReminders(), ilBookingPreferencesDBRepository\getPreferences(), ilExternalFeedRemoveMigration\getRemainingAmountOfSteps(), ilWorkspaceFolderUserSettingsRepository\getSortation(), ilWorkspaceFolderUserSettingsRepository\getSortationMultiple(), ilSkillTreeDBRepository\getTreeIdForNodeId(), ilObjUseBookDBRepository\getUsedBookingPools(), ilRecommendedContentDBRepository\getUserObjectRecommendations(), ilUserProfilePromptDataGateway\getUserPrompt(), ILIAS\Exercise\Submission\SubmissionDBRepository\getUserSubmissionState(), ILIAS\Survey\Settings\SettingsDBRepository\hasEnded(), ilBookingPrefBasedBookGatewayRepository\hasRun(), ilRecommendedContentDBRepository\ifExistsObjectRecommendation(), ilFavouritesDBRepository\ifIsFavourite(), ilSkillTree\initChildsData(), ilExAssignment\instructionFileOrderGetMax(), ILIAS\Style\Content\Object\ObjectDBRepository\isOwned(), ilBookingObject\lookupPoolId(), ilBookingObject\lookupTitle(), ILIAS\Style\Content\Container\ContainerDBRepository\readReuse(), ilExternalFeedRemoveMigration\step(), ILIAS\BookingManager\Setup\ilBookingManager8HotfixDBUpdateSteps\step_1(), and ILIAS\Notes\Setup\ilNotesDBUpdateSteps\step_1().

Here is the caller graph for this function:

quote()

ilDBInterface::quote	(		$value,
		string	$type
	)

Parameters

mixed

$value

Referenced by ilObject\_exists(), ilObject\_getAllReferences(), ilObject\_getIdForImportId(), ilObject\_getIdsForTitle(), ilObject\_getObjectsByType(), ilObject\_getObjectsDataForType(), ilObject\_lookupCreationDate(), ilObject\_lookupDeletedDate(), ilObject\_lookupImportId(), ilObject\_lookupObjIdByImportId(), ilObject\_writeDescription(), arHaving\asSQLStatement(), ilADTActiveRecordByType\create(), ilObjectActivation\createDefaultEntry(), ilMaterializedPathTree\createMaterializedPath(), ilContainerGlobalProfiles\delete(), ilContainerMemberSkills\delete(), ilContainerSkills\delete(), ilObjNotificationSettings\delete(), ilObjectActivation\deleteAllEntries(), ilAdvancedMDRecordScope\deleteByRecordId(), ilLORandomTestQuestionPools\deleteForObjectiveAndTestType(), ilGlossaryTermReferences\deleteReferencesOfTerm(), ilAdvancedMDFieldDefinition\exists(), ilExAssignment\fixInstructionFileOrdering(), ilObject\getAllOwnedRepositoryObjects(), ilPageObject\getAllPages(), ilMDCopyrightSelectionEntry\getDefault(), ilPageObject\getEditLock(), ilPageObject\getEditLockInfo(), ilEventItems\getEventsForItemOrderedByStartingTime(), ilPageObject\getHistoryEntries(), ilPageObject\getHistoryInfo(), ilAdvancedMDFieldDefinition\getInstance(), ilObjectActivation\getItem(), ilPageObject\getLastChangeByParent(), ilPageObject\getNewPages(), ilConditionHandler\getNumberOfConditionsOfTrigger(), ilPageObject\getPageContributors(), ilPageObject\getPagesWithLinks(), ilPageObject\getParentObjectContributors(), ilPageObject\getRecentChanges(), ilSkillResources\getTriggerLevelsForRefId(), ilObjectActivation\hasChangeableTimings(), ilGlossaryTermReferences\hasReferences(), ilObjectActivation\hasTimings(), ilPageObject\increaseViewCnt(), ilExAssignment\instructionFileDeleteOrder(), ilExAssignment\instructionFileExistsInDb(), ilExAssignment\instructionFileInsertOrder(), ilExAssignment\instructionFileOrderGetMax(), ilFavouritesDBRepository\loadData(), ilObjOrgUnit\loadRootOrgRefIdAndId(), ilOrgUnitObjectPositionSetting\lookupActive(), ilSCTasks\lookupIdentifierForTask(), ilObjCourseReference\lookupMemberUpdateEnabled(), ilOerHarvesterObjectStatus\lookupObjIdByHarvestingId(), ilPageObject\lookupParentId(), ilCalendarCategories\lookupRemoteCalendars(), ilTree\lookupTreesForNode(), ilPageObject\preloadActivationDataByParentId(), ilContainerMemberSkills\publish(), ilContainerGlobalProfiles\read(), ilContainerLocalProfiles\read(), ilContainerMemberSkills\read(), ilContainerSkills\read(), ilObjNotificationSettings\read(), ilObjectActivation\read(), ilObjLTIAdministration\readReleaseObjects(), ilPageObject\releasePageLock(), ilExAssignment\renameInstructionFile(), ilTreeImplementationSwitch\renumberNestedSet(), ilLOUserResults\resetFinalByObjective(), ilContainerGlobalProfiles\save(), ilContainerSkills\save(), ilContainerMemberSkills\saveLevelForSkills(), SurveySearch\search(), ilObject\setDeletedDates(), ilExternalFeedRemoveMigration\step(), ILIAS\Notes\Setup\ilNotesDBUpdateSteps\step_1(), ILIAS\MediaCast\Setup\ilMediaCastDBUpdateSteps\step_4(), and ilLOUserResults\updateResultLimit().

Here is the caller graph for this function:

quoteIdentifier()

ilDBInterface::quoteIdentifier	(	string	$identifier,
		bool	$check_option = false
	)

Implemented in ilDBPdo.

Referenced by arHaving\asSQLStatement(), arJoin\asStatementText(), and arStatement\wrapField().

Here is the caller graph for this function:

renameTable()

ilDBInterface::renameTable	(	string	$old_name,
		string	$new_name
	)

Implemented in ilDBPdo.

renameTableColumn()

ilDBInterface::renameTableColumn	(	string	$table_name,
		string	$column_old_name,
		string	$column_new_name
	)

Implemented in ilDBPdo.

replace()

ilDBInterface::replace	(	string	$table,
		array	$primary_keys,
		array	$other_columns
	)

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

int The number of rows affected by the manipulation

Implemented in ilDBPdo.

Referenced by ILIAS\Survey\Participants\InvitationsDBRepository\add(), ilRecommendedContentDBRepository\addRoleRecommendation(), ilObjNotificationSettings\save(), ILIAS\Notes\Setup\ilNotesDBUpdateSteps\step_1(), ILIAS\Style\Content\Container\ContainerDBRepository\updateReuse(), and ilWorkspaceFolderUserSettingsRepository\updateSortation().

Here is the caller graph for this function:

rollback()

ilDBInterface::rollback

(

)

Exceptions

ilDatabaseException

Implemented in ilDBPdo.

sanitizeMB4StringIfNotSupported()

ilDBInterface::sanitizeMB4StringIfNotSupported

(

string

$query

)

Parameters

$query

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

Returns

string sanitized query

Implemented in ilDBPdo.

sequenceExists()

ilDBInterface::sequenceExists

(

string

$sequence

)

Implemented in ilDBPdo.

setDBHost()

ilDBInterface::setDBHost

(

string

$host

)

Implemented in ilDBPdo.

setDBPassword()

ilDBInterface::setDBPassword

(

string

$password

)

Implemented in ilDBPdo.

setDBPort()

ilDBInterface::setDBPort

(

int

$port

)

Implemented in ilDBPdo.

setDBUser()

ilDBInterface::setDBUser

(

string

$user

)

Implemented in ilDBPdo.

setLimit()

ilDBInterface::setLimit	(	int	$limit,
		int	$offset = 0
	)

Implemented in ilDBPdo.

Referenced by ilObject\_getIdForImportId().

Here is the caller graph for this function:

setStorageEngine()

ilDBInterface::setStorageEngine

(

string

$storage_engine

)

Implemented in ilDBPdo.

substr()

ilDBInterface::substr

(

string

$expression

)

supports()

ilDBInterface::supports

(

string

$feature

)

Implemented in ilDBPdo.

supportsFulltext()

ilDBInterface::supportsFulltext

(

)

Implemented in ilDBPdo, and ilDBPdoMySQLInnoDB.

supportsSlave()

ilDBInterface::supportsSlave

(

)

Implemented in ilDBPdo.

supportsTransactions()

ilDBInterface::supportsTransactions

(

)

Implemented in ilDBPdo, ilDBPdoMySQL, ilDBPdoMySQLGalera, and ilDBPdoMySQLInnoDB.

tableColumnExists()

ilDBInterface::tableColumnExists	(	string	$table_name,
		string	$column_name
	)

Implemented in ilDBPdo.

Referenced by ILIAS\MediaCast\Setup\ilMediaCastDBUpdateSteps\step_1(), ILIAS\MediaObjects\Setup\ilMediaObjectsDBUpdateSteps\step_1(), ILIAS\MediaCast\Setup\ilMediaCastDBUpdateSteps\step_2(), ILIAS\EmployeeTalk\Setup\ilEmployeeTalkDBUpdateSteps\step_3(), ILIAS\MediaCast\Setup\ilMediaCastDBUpdateSteps\step_3(), and ILIAS\EmployeeTalk\Setup\ilEmployeeTalkDBUpdateSteps\step_6().

Here is the caller graph for this function:

tableExists()

ilDBInterface::tableExists

(

string

$table_name

)

Implemented in ilDBPdo.

Referenced by ILIAS\Portfolio\Setup\ilPortfolioDBUpdateSteps\step_1(), ILIAS\EmployeeTalk\Setup\ilEmployeeTalkDBUpdateSteps\step_2(), and ILIAS\EmployeeTalk\Setup\ilEmployeeTalkDBUpdateSteps\step_5().

Here is the caller graph for this function:

unlockTables()

ilDBInterface::unlockTables

(

)

Unlock tables locked by previous lock table calls.

Deprecated:

Use ilAtomQuery instead

Implemented in ilDBPdo.

update()

ilDBInterface::update	(	string	$table_name,
		array	$values,
		array	$where
	)

@description $where MUST contain existing columns only.

statements like [1 => ['integer', 1]] will not work, use a full query and

See also

manipulate() instead in that case.

Returns

int The number of rows affected by the manipulation

Implemented in ilDBPdo.

Referenced by ilObject\_resetDeletedDate(), ilObject\_setDeletedDate(), ilObject\_writeDescription(), ilObject\_writeImportId(), ilObject\_writeTitle(), ilBookingPrefBasedBookGatewayRepository\checkProcessHash(), ilRecommendedContentDBRepository\declineObjectRecommendation(), ilLMMenuEditor\fixImportMenuItems(), ILIAS\Style\Content\CharacteristicDBRepo\replaceParameter(), ilBookingPrefBasedBookGatewayRepository\resetRun(), ilUserProfilePromptDataGateway\saveLastUserPrompt(), and ILIAS\BookingManager\Setup\ilBookingManager8HotfixDBUpdateSteps\step_1().

Here is the caller graph for this function:

upper()

ilDBInterface::upper

(

string

$expression

)

Implemented in ilDBPdo.

useSlave()

ilDBInterface::useSlave

(

bool

$bool

)

Deprecated:

Implemented in ilDBPdo.

---

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

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