ILIAS  trunk Revision v11.0_alpha-1749-g1a06bdef097
All Data Structures Namespaces Files Functions Variables Enumerations Enumerator Modules Pages
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)
 $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)
 
 addForeignKey (string $foreign_key_name, array $field_names, string $table_name, array $reference_field_names, string $reference_table, ?ForeignKeyConstraints $on_update=null, ?ForeignKeyConstraints $on_delete=null)
 
 dropForeignKey (string $foreign_key_name, string $table_name)
 
 foreignKeyExists (string $foreign_key_name, string $table_name)
 
 buildIntegrityAnalyser ()
 
 primaryExistsByFields (string $table_name, array $fields)
 

Static Public Member Functions

static getReservedWords ()
 Get reserved words. More...
 
static isReservedWord (string $a_word)
 

Detailed Description

Member Function Documentation

◆ addForeignKey()

ilDBInterface::addForeignKey ( string  $foreign_key_name,
array  $field_names,
string  $table_name,
array  $reference_field_names,
string  $reference_table,
?ForeignKeyConstraints  $on_update = null,
?ForeignKeyConstraints  $on_delete = null 
)
Parameters
string[]$field_names
string[]$reference_field_names

Implemented in ilDBPdo.

◆ 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.

Referenced by ILIAS\EmployeeTalk\Setup\ilEmployeeTalkDBUpdateSteps\step_2().

+ Here is the caller graph for this function:

◆ addPrimaryKey()

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

◆ addTableColumn()

◆ beginTransaction()

ilDBInterface::beginTransaction ( )
Exceptions

Implemented in ilDBPdo.

◆ buildAtomQuery()

ilDBInterface::buildAtomQuery ( )

Implemented in ilDBPdo, and ilDBPdoMySQLGalera.

Referenced by ilChangeEvent\_syncObjectStats(), ilRbacAdmin\assignUserLimited(), and ilObjectActivation\createDefaultEntry().

+ Here is the caller graph for this function:

◆ buildIntegrityAnalyser()

ilDBInterface::buildIntegrityAnalyser ( )

Implemented in ilDBPdo.

◆ 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

Implemented in ilDBPdo.

◆ concat()

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

Implemented in ilDBPdo.

Referenced by ilParticipants\_getMembershipByType(), and ilParticipants\getUserMembershipAssignmentsByType().

+ Here is the caller graph for this function:

◆ 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 
)

◆ doesCollationSupportMB4Strings()

ilDBInterface::doesCollationSupportMB4Strings ( )

Implemented in ilDBPdo, and ilDBPdoMySQL.

◆ dropForeignKey()

ilDBInterface::dropForeignKey ( string  $foreign_key_name,
string  $table_name 
)

Implemented in ilDBPdo.

◆ 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.

Referenced by ILIAS\Style\Content\CharacteristicDBRepo\deleteParameter().

+ Here is the caller graph for this function:

◆ execute()

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

◆ fetchAll()

◆ fetchAssoc()

ilDBInterface::fetchAssoc ( ilDBStatement  $statement)

Implemented in ilDBPdo.

Referenced by ilObjUser\_checkExternalAuthAccount(), ilPageObject\_exists(), ilObject\_getAllReferences(), ilParticipants\_getAllSupportContactsOfUser(), ilObject\_getIdForImportId(), ilObject\_getIdsForTitle(), ilObject\_getLastUpdateOfObjects(), ilObject\_getObjectsByType(), ilObject\_getObjectsDataForType(), ilPageObject\_isScheduledActivation(), ilPageObject\_lookupActivationData(), ilPageObject\_lookupActive(), ilObject\_lookupCreationDate(), ilObject\_lookupDeletedDate(), ilObjGlossary\_lookupOnline(), ilChangeEvent\_syncObjectStats(), ilCourseParticipants\_updatePassed(), ilFavouritesDBRepository\add(), ilBookingPrefBasedBookGatewayRepository\checkProcessHash(), ILIAS\Test\Setup\DatabaseInconsistencyMetricsCollectedObjective\collectMantis37759(), ILIAS\Style\Content\ColorDBRepo\colorExists(), ilMaterializedPathTree\createFromParentRelation(), ilMaterializedPathTree\createMaterializedPath(), ilWorkspaceTree\exists(), ILIAS\Style\Content\CharacteristicDBRepo\exists(), ilAdvancedMDFieldDefinition\exists(), ILIAS\Style\Content\Container\ContainerDBRepository\filterByReuse(), ilLMMenuEditor\fixImportMenuItems(), ilExAssignment\fixInstructionFileOrdering(), ilObject\fixMissingTitles(), ilObject\getAllOwnedRepositoryObjects(), ilPageObject\getAllPages(), ilExcAssMemberStateRepository\getAssignmentIdsWithGradingNeeded(), ilExcAssMemberStateRepository\getAssignmentIdsWithPeerFeedbackNeeded(), ilBadgeAssignment\getBadgesForUser(), ILIAS\Style\Content\CharacteristicDBRepo\getByKey(), ILIAS\Style\Content\CharacteristicDBRepo\getByTypes(), ilBenchmark\getCurrentRecordNumber(), ilPageActivationDBRepository\getData(), ilCourseParticipants\getDateTimeOfPassed(), ilBenchmark\getDbBenchRecords(), ilMDCopyrightSelectionEntry\getDefault(), ilPageObject\getEditLock(), ilPageObject\getEditLockInfo(), ilExcMemberRepository\getExerciseIdsOfUser(), ilContainerFilterFieldData\getFilterSetForRefId(), ilPageObject\getHistoryEntries(), ilPageObject\getHistoryEntry(), ilPageObject\getHistoryInfo(), ilObjectActivation\getItem(), ilPageObject\getLastChangeByParent(), ilBadgeAssignment\getLatestTimestamp(), ilObject\getLongDescriptions(), SurveySingleChoiceQuestion\getMaxSumScore(), SurveyMultipleChoiceQuestion\getMaxSumScore(), SurveyMatrixQuestion\getMaxSumScore(), ilMediaItem\getMediaItemsForUploadHash(), ilBadgeAssignment\getNewCounter(), ilPageObject\getNewPages(), ilFileObjectRBACDatabaseSteps\getOpsID(), ILIAS\Style\Content\Object\ObjectDBRepository\getOwnedStyles(), ilPageObject\getPageContributors(), ilPageObject\getPagesWithLinks(), ilSkillTreeDBRepository\getParentNodeIdForNodeId(), ilPageObject\getParentObjectContributors(), ilCourseParticipants\getPassedUsersForObjects(), ilBookingPrefBasedBookGatewayRepository\getPoolsWithOverdueBooking(), ilObjBookingPool\getPoolsWithReminders(), ilBookingPreferencesDBRepository\getPreferences(), ilBookingPreferencesDBRepository\getPreferencesOfUser(), ilStudyProgrammeAutoMembershipsDBRepository\getProgrammesFor(), ilPageObject\getRecentChanges(), ilLMObject\getShortTitles(), ilWorkspaceFolderUserSettingsRepository\getSortation(), ilWorkspaceFolderUserSettingsRepository\getSortationMultiple(), ilExSubmission\getSubmissionsForFilename(), ilExcAssMemberStateRepository\getSubmitableAssignmentIdsOfUser(), ilSkillTreeDBRepository\getTreeIdForNodeId(), ilObjUseBookDBRepository\getUsedBookingPools(), ilGlossaryTermReferences\hasReferences(), ilBookingPrefBasedBookGatewayRepository\hasRun(), ilRecommendedContentDBRepository\ifExistsObjectRecommendation(), ilFavouritesDBRepository\ifIsFavourite(), ilSkillTree\initChildsData(), ilExAssignment\instructionFileGetFileOrderData(), ilExAssignment\instructionFileOrderGetMax(), ILIAS\Style\Content\CharacteristicDBRepo\isOutdated(), ILIAS\Style\Content\Object\ObjectDBRepository\isOwned(), ilGlossaryTermReferences\isReferenced(), ilFavouritesDBRepository\loadData(), ilObjOrgUnit\loadRootOrgRefIdAndId(), ilObjGlossary\lookup(), ilBlogPosting\lookup(), ilObjGlossary\lookupAutoGlossaries(), ilPageObject\lookupParentId(), ilBookingObject\lookupPoolId(), ilGlossaryTermReferences\lookupReferencesOfTerm(), ilBookingObject\lookupTitle(), ilPageObject\lookupTranslations(), ilPageObject\preloadActivationDataByParentId(), ilObjectActivation\preloadData(), ilObjNotificationSettings\read(), ILIAS\Style\Content\Container\ContainerDBRepository\readReuse(), ilPageObject\releasePageLock(), SurveySearch\search(), and ILIAS\Style\Content\CharacteristicDBRepo\updateColorName().

+ Here is the caller graph for this function:

◆ fetchObject()

◆ foreignKeyExists()

ilDBInterface::foreignKeyExists ( string  $foreign_key_name,
string  $table_name 
)

Implemented in ilDBPdo.

◆ 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[]

Referenced by ilDBPdo\setDBType().

+ Here is the caller graph for this function:

◆ 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 ilParticipants\_getAllSupportContactsOfUser(), ilObject\_getLastUpdateOfObjects(), ilParticipants\_getMembershipByType(), ilObject\_prepareCloneSelection(), ilRbacAdmin\assignUserLimited(), ILIAS\Style\Content\Container\ContainerDBRepository\filterByReuse(), ilObject\fixMissingTitles(), ilObject\getAllOwnedRepositoryObjects(), ilExcAssMemberStateRepository\getAssignmentIdsWithGradingNeeded(), ilExcAssMemberStateRepository\getAssignmentIdsWithPeerFeedbackNeeded(), ILIAS\Style\Content\CharacteristicDBRepo\getByTypes(), ilPageActivationDBRepository\getData(), ilObject\getLongDescriptions(), ILIAS\Style\Content\Object\ObjectDBRepository\getOwnedStyles(), ilCourseParticipants\getPassedUsersForObjects(), ilStudyProgrammeAutoMembershipsDBRepository\getProgrammesFor(), ilRecommendedContentDBRepository\getRecommendationsOfRoles(), ilWorkspaceFolderUserSettingsRepository\getSortationMultiple(), ilExSubmission\getSubmissionsForFilename(), ilExcAssMemberStateRepository\getSubmitableAssignmentIdsOfUser(), ilParticipants\getUserMembershipAssignmentsByType(), ilObjectActivation\hasChangeableTimings(), ilObjectActivation\hasTimings(), ilGlossaryTermReferences\isReferenced(), ilFavouritesDBRepository\loadData(), ilMDRights\lookupRightsByTypeAndCopyright(), ilObjectActivation\preloadData(), ilCOPageDataSet\readData(), ilObject\setDeletedDates(), ILIAS\Style\Content\CharacteristicDBRepo\updateColorName(), ILIAS\TermsOfService\Consumer\usersWhoDidntAgree(), and ILIAS\DataProtection\Consumer\usersWhoDidntAgree().

+ 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()

◆ 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$moduleManager|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
arraytable definitions
Deprecated:
Use ilAtomQuery instead

Implemented in ilDBPdo.

◆ lower()

ilDBInterface::lower ( string  $expression)

Implemented in ilDBPdo.

◆ manipulate()

◆ manipulateF()

ilDBInterface::manipulateF ( string  $query,
array  $types,
array  $values 
)
Parameters
$typesstring[]
Returns
int The number of rows affected by the manipulation

Implemented in ilDBPdo.

Referenced by ilTree\_removeEntry(), ilPageObject\_writeActive(), ilPageObject\_writeParentId(), ilFavouritesDBRepository\add(), ilMaterializedPathTree\createMaterializedPath(), ILIAS\Portfolio\Administration\PortfolioRoleAssignmentDBRepository\delete(), ILIAS\Survey\Code\CodeDBRepo\delete(), ILIAS\Survey\Code\CodeDBRepo\deleteAll(), ILIAS\Style\Content\CharacteristicDBRepo\deleteCharacteristic(), ILIAS\BookingManager\BookingProcess\SelectedObjectsDBRepository\deleteSelectedObjects(), ilExSubmission\deleteUser(), ilLMMenuEditor\fixImportMenuItems(), ilForumTopic\movePosts(), 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(), ILIAS\Exercise\Assignment\Mandatory\RandomAssignmentsDBRepository\saveAssignmentsOfUser(), ilObjSurvey\saveCompletionStatus(), ilContainerFilterFieldData\saveFilterSetForRefId(), ilBookingPreferencesDBRepository\savePreferences(), ilBookingPreferencesDBRepository\savePreferencesOfUser(), ILIAS\Style\Content\CharacteristicDBRepo\saveTitles(), ILIAS\Wiki\Setup\ilWiki8HotfixDBUpdateSteps\step_1(), ILIAS\Portfolio\Setup\ilPortfolioDBUpdateSteps\step_2(), ilTestRandomQuestionSetStagingPoolQuestionList\updateSourceQuestionPoolId(), ILIAS\Survey\Execution\RunDBRepository\updateTime(), and ilObjUseBookDBRepository\updateUsedBookingPools().

+ Here is the caller graph for this function:

◆ modifyTableColumn()

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

◆ nextId()

ilDBInterface::nextId ( string  $table_name)

◆ 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()

◆ 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.

Implemented in ilDBPdo.

Referenced by ilChatroomAppEventListener\dbCachePrepare().

+ Here is the caller graph for this function:

◆ 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 ilPageObject\_exists(), ilObject\_exists(), ilObject\_getAllReferences(), ilParticipants\_getAllSupportContactsOfUser(), ilObject\_getIdForImportId(), ilObject\_getIdsForTitle(), ilObject\_getLastUpdateOfObjects(), ilParticipants\_getMembershipByType(), ilObject\_getObjectsByType(), ilObject\_getObjectsDataForType(), ilParticipants\_hasPassed(), ilParticipants\_isBlocked(), ilParticipants\_isSubscriber(), ilPageObject\_lookupContainsDeactivatedElements(), ilObject\_lookupCreationDate(), ilObject\_lookupDeletedDate(), ilObject\_lookupImportId(), ilObject\_lookupObjIdByImportId(), ilObjGlossary\_lookupOnline(), ilObject\_prepareCloneSelection(), ilChangeEvent\_syncObjectStats(), ilCourseParticipants\_updatePassed(), ilObject\_writeDescription(), ilRbacAdmin\assignUserLimited(), ilDatabaseEnvironmentValidObjective\checkDefaultEngine(), ilDatabaseEnvironmentValidObjective\checkRowFormat(), ILIAS\Test\Setup\DatabaseInconsistencyMetricsCollectedObjective\collectMantis37759(), ILIAS\Style\Content\ColorDBRepo\colorExists(), ILIAS\Notes\NoteSettingsDBRepository\commentsActive(), ILIAS\Notes\NoteSettingsDBRepository\commentsActiveMultiple(), ilObjectActivation\createDefaultEntry(), ilOrgUnitOperationRegisteredObjective\doesOperationExistInContext(), ilDBUpdate\execQuery(), ilAdvancedMDFieldDefinition\exists(), ilExAssignment\fixInstructionFileOrdering(), ilObject\fixMissingTitles(), ilObjLTIAdministration\getActiveObjectTypes(), ilObject\getAllOwnedRepositoryObjects(), ilPageObject\getAllPages(), ilOrgUnitOperationContextRegisteredObjective\getContextId(), ilOrgUnitOperationRegisteredObjective\getContextId(), ilBenchmark\getCurrentRecordNumber(), ilCourseParticipants\getDateTimeOfPassed(), ilBenchmark\getDbBenchRecords(), ilMDCopyrightSelectionEntry\getDefault(), ilDatabasePopulatedObjective\getDefaultEngine(), ilPageObject\getEditLock(), ilPageObject\getEditLockInfo(), ilEventItems\getEventsForItemOrderedByStartingTime(), ilPageObject\getHistoryEntries(), ilPageObject\getHistoryInfo(), ilObjOrgUnit\getIconsCache(), ilOrgUnitTypeTranslation\getInstance(), ilLPStatusSurveyFinished\getInvitations(), ilObjectActivation\getItem(), ilPageObject\getLastChangeByParent(), ilObject\getLongDescriptions(), ilPageObject\getNewPages(), ilConditionHandler\getNumberOfConditionsOfTrigger(), ilPageObject\getPagesWithLinks(), ilCourseParticipants\getPassedUsersForObjects(), ilStudyProgrammeAutoMembershipsDBRepository\getProgrammesFor(), ilPageObject\getRecentChanges(), ilRecommendedContentDBRepository\getRecommendationsOfRoles(), ILIAS\COPage\PC\PCDefinition\getRecords(), ilLMObject\getShortTitles(), ilExSubmission\getSubmissionsForFilename(), ilParticipants\getUserMembershipAssignmentsByType(), ILIAS\Exercise\Submission\SubmissionRepository\getUsersWithSubmission(), shibUser\getUsrIdByExtId(), ilObjectActivation\hasChangeableTimings(), ilGlossaryTermReferences\hasReferences(), ilObjectActivation\hasTimings(), ilExAssignment\instructionFileExistsInDb(), ilExAssignment\instructionFileGetFileOrderData(), ilGlossaryTermReferences\isReferenced(), ilFavouritesDBRepository\loadData(), ILIAS\BookingManager\Schedule\SchedulesDBRepository\loadDataOfPool(), ilObjOrgUnit\loadRootOrgRefIdAndId(), shibUser\loginExists(), ilObjGlossary\lookup(), ilBlogPosting\lookup(), ilDidacticTemplateSettings\lookupAssignedObjectTypes(), ilObjGlossary\lookupAutoGlossaries(), ilSCTasks\lookupIdentifierForTask(), ilObjCourseReference\lookupMemberUpdateEnabled(), ilPageObject\lookupParentId(), ilGlossaryTermReferences\lookupReferencesOfTerm(), ilCalendarCategories\lookupRemoteCalendars(), ilMDRights\lookupRightsByTypeAndCopyright(), ilParticipants\lookupSubscribers(), ilParticipants\lookupSubscribersData(), ilPageObject\lookupTranslations(), ilTree\lookupTreesForNode(), ilPageObject\preloadActivationDataByParentId(), ilObjectActivation\preloadData(), ilObjNotificationSettings\read(), ilObjectActivation\read(), ilObjLTIAdministration\readReleaseObjects(), ilPageObject\releasePageLock(), ilTreeImplementationSwitch\renumberNestedSet(), SurveySearch\search(), ILIAS\TermsOfService\Consumer\usersWhoDidntAgree(), ILIAS\DataProtection\Consumer\usersWhoDidntAgree(), and ilWikiStat\writeData().

+ Here is the caller graph for this function:

◆ queryF()

ilDBInterface::queryF ( string  $query,
array  $types,
array  $values 
)
Parameters
$typesstring[]

Implemented in ilDBPdo.

Referenced by ilObjUser\_checkExternalAuthAccount(), ilPageObject\_isScheduledActivation(), ilPageObject\_lookupActivationData(), ilPageObject\_lookupActive(), ilFavouritesDBRepository\add(), ilBookingPrefBasedBookGatewayRepository\checkProcessHash(), ilMaterializedPathTree\createFromParentRelation(), ilMaterializedPathTree\createMaterializedPath(), ilWorkspaceTree\exists(), ILIAS\Style\Content\CharacteristicDBRepo\exists(), ILIAS\Survey\Code\CodeDBRepo\exists(), ILIAS\Notes\Export\UserImageExporter\exportUserImagesForRepObjId(), ILIAS\Style\Content\Container\ContainerDBRepository\filterByReuse(), ILIAS\UI\Component\Legacy\Content\Filter\MemberDBRepo\filterObjIdsByTutorialSupport(), ILIAS\UI\Component\Legacy\Content\Filter\ObjectDBRepo\filterObjIdsByType(), ilLMMenuEditor\fixImportMenuItems(), ILIAS\Survey\Settings\SettingsDBRepository\getAccessSettings(), ILIAS\Survey\Code\CodeDBRepo\getAll(), ILIAS\Portfolio\Administration\PortfolioRoleAssignmentDBRepository\getAllAssignmentData(), ILIAS\Survey\Code\CodeDBRepo\getAllData(), ILIAS\Survey\Participants\InvitationsDBRepository\getAllForSurvey(), ILIAS\Survey\Participants\InvitationsDBRepository\getAllForUser(), ILIAS\Survey\Survey360\AppraiseeDBRepository\getAppraiseesForRater(), ilExcAssMemberStateRepository\getAssignmentIdsWithGradingNeeded(), ilExcAssMemberStateRepository\getAssignmentIdsWithPeerFeedbackNeeded(), ILIAS\Exercise\Assignment\Mandatory\RandomAssignmentsDBRepository\getAssignmentsOfUser(), ilBadgeAssignment\getBadgesForUser(), ILIAS\Survey\Code\CodeDBRepo\getByCodeId(), ILIAS\Notes\NoteDBRepository\getById(), ILIAS\Style\Content\CharacteristicDBRepo\getByKey(), ILIAS\Style\Content\CharacteristicDBRepo\getByTypes(), ILIAS\Survey\Code\CodeDBRepo\getByUserKey(), ILIAS\Survey\Survey360\AppraiseeDBRepository\getClosedAppraiseesForSurveys(), ILIAS\Survey\Execution\RunDBRepository\getCurrentRunId(), ilPageActivationDBRepository\getData(), ilRecommendedContentDBRepository\getDeclinedUserObjectRecommendations(), ilExcMemberRepository\getExerciseIdsOfUser(), ilContainerFilterFieldData\getFilterSetForRefId(), ILIAS\Survey\Execution\RunDBRepository\getFinishedAppraiseesForRater(), ILIAS\Survey\Execution\RunDBRepository\getFinishedSurveysOfUser(), ilPageObject\getHistoryEntry(), ILIAS\LegalDocuments\Provide\History\HistoryDBRepository\getHistoryNumbersOlderEqualThanNr(), ilBadgeAssignment\getLatestTimestamp(), ILIAS\LegalDocuments\Provide\History\HistoryDBRepository\getMaxDeletableNr(), SurveySingleChoiceQuestion\getMaxSumScore(), SurveyMultipleChoiceQuestion\getMaxSumScore(), SurveyMatrixQuestion\getMaxSumScore(), ilMediaItem\getMediaItemsForUploadHash(), ilBadgeAssignment\getNewCounter(), ILIAS\Survey\Settings\SettingsDBRepository\getObjIdsForSurveyIds(), ilFileObjectRBACDatabaseSteps\getOpsID(), ILIAS\Style\Content\Object\ObjectDBRepository\getOwnedStyles(), ilPageObject\getPageContributors(), ilSkillTreeDBRepository\getParentNodeIdForNodeId(), ilPageObject\getParentObjectContributors(), ilBookingPrefBasedBookGatewayRepository\getPoolsWithOverdueBooking(), ilObjBookingPool\getPoolsWithReminders(), ilBookingPreferencesDBRepository\getPreferences(), ilBookingPreferencesDBRepository\getPreferencesOfUser(), ILIAS\BookingManager\BookingProcess\SelectedObjectsDBRepository\getSelectedObjects(), ilWorkspaceFolderUserSettingsRepository\getSortation(), ilWorkspaceFolderUserSettingsRepository\getSortationMultiple(), ILIAS\Survey\Execution\RunDBRepository\getState(), ilExcAssMemberStateRepository\getSubmitableAssignmentIdsOfUser(), ILIAS\Portfolio\Administration\PortfolioRoleAssignmentDBRepository\getTemplatesForRoles(), ILIAS\Skill\Profile\SkillProfileDBRepository\getTreeId(), ilSkillTreeDBRepository\getTreeIdForNodeId(), ILIAS\Survey\Survey360\AppraiseeDBRepository\getUnclosedSurveysForAppraisee(), ILIAS\Survey\Execution\RunDBRepository\getUnfinishedSurveysOfUser(), ilObjUseBookDBRepository\getUsedBookingPools(), ILIAS\Notes\NoteDBRepository\getUserCount(), ilRecommendedContentDBRepository\getUserObjectRecommendations(), ILIAS\Exercise\Submission\SubmissionRepository\getUserSubmissionState(), ILIAS\Survey\Settings\SettingsDBRepository\hasEnded(), ilBookingPrefBasedBookGatewayRepository\hasRun(), ilRecommendedContentDBRepository\ifExistsObjectRecommendation(), ilFavouritesDBRepository\ifIsFavourite(), ilSkillTree\initChildsData(), ilExAssignment\instructionFileOrderGetMax(), ILIAS\Blog\ReadingTime\ReadingTimeDBRepo\isActivated(), ILIAS\Style\Content\CharacteristicDBRepo\isOutdated(), ILIAS\Style\Content\Object\ObjectDBRepository\isOwned(), ilBookingObject\lookupPoolId(), ilBookingObject\lookupTitle(), ILIAS\Style\Content\Container\ContainerDBRepository\readReuse(), ILIAS\Style\Content\CharacteristicDBRepo\replaceParameter(), ILIAS\Setup\ilBookingManager8HotfixDBUpdateSteps\step_1(), ILIAS\Setup\ilNotesDBUpdateSteps\step_3(), ILIAS\MediaObjects\Setup\ilMediaObjectsDBUpdateSteps\step_3(), ILIAS\Wiki\Setup\ilWikiDBUpdateSteps\step_6(), and ILIAS\Style\Content\CharacteristicDBRepo\updateColorName().

+ Here is the caller graph for this function:

◆ quote()

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

Referenced by ilParticipants\_deleteAllEntries(), ilParticipants\_deleteUser(), ilPageObject\_exists(), ilObject\_exists(), ILIAS\UI\Component\Legacy\Content\Filter\ObjectDBRepo\_filterObjIdsByOnlineOffline(), ilObject\_getAllReferences(), ilParticipants\_getAllSupportContactsOfUser(), ilObject\_getIdForImportId(), ilObject\_getIdsForTitle(), ilParticipants\_getMembershipByType(), ilObject\_getObjectsByType(), ilObject\_getObjectsDataForType(), ilParticipants\_hasPassed(), ilParticipants\_isBlocked(), ilParticipants\_isSubscriber(), ilPageObject\_lookupContainsDeactivatedElements(), ilObject\_lookupCreationDate(), ilObject\_lookupDeletedDate(), ilObject\_lookupImportId(), ilObject\_lookupObjIdByImportId(), ilObjGlossary\_lookupOnline(), ilChangeEvent\_syncObjectStats(), ilCourseParticipants\_updatePassed(), ilObject\_writeDescription(), ilRbacAdmin\assignUserLimited(), arHaving\asSQLStatement(), ILIAS\Style\Content\ColorDBRepo\colorExists(), ilADTActiveRecordByType\create(), ilObjectActivation\createDefaultEntry(), ilMaterializedPathTree\createMaterializedPath(), ILIAS\Wiki\Page\PageDBRepository\delete(), ilObjNotificationSettings\delete(), ilObjectActivation\deleteAllEntries(), ilAdvancedMDRecordScope\deleteByRecordId(), ilLORandomTestQuestionPools\deleteForObjectiveAndTestType(), ILIAS\Skill\Usage\UsageDBRepository\deleteHistoryUsagesLowerEqualThan(), ILIAS\Style\Content\CharacteristicDBRepo\deleteParameter(), ilGlossaryTermReferences\deleteReferencesOfTerm(), ilOrgUnitOperationRegisteredObjective\doesOperationExistInContext(), ilAdvancedMDFieldDefinition\exists(), ilExAssignment\fixInstructionFileOrdering(), ilObjLTIAdministration\getActiveObjectTypes(), ilObject\getAllOwnedRepositoryObjects(), ilPageObject\getAllPages(), ILIAS\Survey\Execution\RunDBRepository\getById(), ILIAS\MediaPool\MediaPoolRepository\getContentSnippets(), ilOrgUnitOperationContextRegisteredObjective\getContextId(), ilOrgUnitOperationRegisteredObjective\getContextId(), ilCourseParticipants\getDateTimeOfPassed(), ilMDCopyrightSelectionEntry\getDefault(), ilPageObject\getEditLock(), ilPageObject\getEditLockInfo(), ilEventItems\getEventsForItemOrderedByStartingTime(), ilPageObject\getHistoryEntries(), ilPageObject\getHistoryInfo(), ILIAS\Skill\Usage\UsageDBRepository\getHistoryUsagesLowerEqualThan(), ilOrgUnitTypeTranslation\getInstance(), ilLPStatusSurveyFinished\getInvitations(), ilObjectActivation\getItem(), ilPageObject\getLastChangeByParent(), ILIAS\Exercise\Submission\SubmissionRepository\getMaxAmountOfSubmittedFiles(), ILIAS\MediaPool\MediaPoolRepository\getMediaObjects(), ilPageObject\getNewPages(), ilConditionHandler\getNumberOfConditionsOfTrigger(), ilPageObject\getPageContributors(), ilPageObject\getPagesWithLinks(), ilPageObject\getParentObjectContributors(), ilCourseParticipants\getPassedUsersForObjects(), ilWikiUserHTMLExport\getProcess(), ilStudyProgrammeAutoMembershipsDBRepository\getProgrammesFor(), ILIAS\Notes\NoteDBRepository\getQuery(), ilPageObject\getRecentChanges(), ILIAS\Survey\Execution\RunDBRepository\getRunsForUser(), ilLMObject\getShortTitles(), ilExSubmission\getSubmissionsForFilename(), ilParticipants\getUserMembershipAssignmentsByType(), shibUser\getUsrIdByExtId(), ilObjectActivation\hasChangeableTimings(), ilGlossaryTermReferences\hasReferences(), ilObjectActivation\hasTimings(), ilPageObject\increaseViewCnt(), ilExAssignment\instructionFileDeleteOrder(), ilExAssignment\instructionFileExistsInDb(), ilExAssignment\instructionFileInsertOrder(), ilExAssignment\instructionFileOrderGetMax(), ilGlossaryTermReferences\isReferenced(), ilFavouritesDBRepository\loadData(), ilObjOrgUnit\loadRootOrgRefIdAndId(), shibUser\loginExists(), ilObjGlossary\lookup(), ilBlogPosting\lookup(), ilOrgUnitObjectPositionSetting\lookupActive(), ilObjGlossary\lookupAutoGlossaries(), ilSCTasks\lookupIdentifierForTask(), ilObjCourseReference\lookupMemberUpdateEnabled(), ilPageObject\lookupParentId(), ilLTIDataConnector\lookupRecordIdByGlobalSettingsAndRefId(), ilGlossaryTermReferences\lookupReferencesOfTerm(), ilCalendarCategories\lookupRemoteCalendars(), ilParticipants\lookupSubscribers(), ilParticipants\lookupSubscribersData(), ilPageObject\lookupTranslations(), ilTree\lookupTreesForNode(), ilPageObject\preloadActivationDataByParentId(), ilObjNotificationSettings\read(), ilObjectActivation\read(), ilObjLTIAdministration\readReleaseObjects(), ilPageObject\releasePageLock(), ilExAssignment\renameInstructionFile(), ilTreeImplementationSwitch\renumberNestedSet(), ilLOUserResults\resetFinalByObjective(), ilContainerSortingSettings\save(), ilExAssignment\saveInstructionFilesOrderOfAssignment(), SurveySearch\search(), ilObject\setDeletedDates(), ilLOUserResults\updateResultLimit(), ilWikiStat\writeData(), and ilLMObject\writeShortTitle().

+ Here is the caller graph for this function:

◆ quoteIdentifier()

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

Implemented in ilDBPdo.

Referenced by arHaving\asSQLStatement(), 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
stringtable name
arrayprimary key values: array("field1" => array("text", $name), "field2" => ...)
arrayother values: array("field1" => array("text", $name), "field2" => ...)
Returns
int The number of rows affected by the manipulation

Implemented in ilDBPdo.

Referenced by ILIAS\Notes\NoteSettingsDBRepository\activateComments(), ILIAS\Portfolio\Administration\PortfolioRoleAssignmentDBRepository\add(), ILIAS\Survey\Participants\InvitationsDBRepository\add(), ilRecommendedContentDBRepository\addRoleRecommendation(), ilObjNotificationSettings\save(), ilLMTracker\trackLastPageAccess(), ILIAS\Style\Content\Container\ContainerDBRepository\updateReuse(), and ilWorkspaceFolderUserSettingsRepository\updateSortation().

+ Here is the caller graph for this function:

◆ rollback()

ilDBInterface::rollback ( )
Exceptions

Implemented in ilDBPdo.

◆ sanitizeMB4StringIfNotSupported()

ilDBInterface::sanitizeMB4StringIfNotSupported ( string  $query)
Parameters
$querystring 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(), ilPageObject\getLastChangeByParent(), and ilExAssignment\instructionFileGetFileOrderData().

+ 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 ( )

◆ tableColumnExists()

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

◆ tableExists()

ilDBInterface::tableExists ( string  $table_name)

◆ unlockTables()

ilDBInterface::unlockTables ( )

Unlock tables locked by previous lock table calls.

Deprecated:
Use ilAtomQuery instead

Implemented in ilDBPdo.

◆ update()

◆ 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: