interface.ilDBInterface.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
use ILIAS\components\Database\Integrity\Integrity;
use ILIAS\components\Database\PDO\FieldDefinition\ForeignKeyConstraints;
 
interface ilDBInterface
{
    public function doesCollationSupportMB4Strings(): bool;
 
    public function sanitizeMB4StringIfNotSupported(string $query): string;
 
    public static function getReservedWords(): array;
 
    public function initFromIniFile(?ilIniFile $ini = null): void;
 
    public function connect(bool $return_false_on_error = false): ?bool;
 
    public function nextId(string $table_name): int;
 
    public function createTable(
        string $table_name,
        array $fields,
        bool $drop_table = false,
        bool $ignore_erros = false
    ): bool;
 
    public function addPrimaryKey(string $table_name, array $primary_keys): bool;
 
    public function createSequence(string $table_name, int $start = 1): bool;
 
    public function getSequenceName(string $table_name): string;
 
    public function tableExists(string $table_name): bool;
 
    public function tableColumnExists(string $table_name, string $column_name): bool;
 
    public function addTableColumn(string $table_name, string $column_name, array $attributes): bool;
 
    public function dropTable(string $table_name, bool $error_if_not_existing = true): bool;
 
    public function renameTable(string $old_name, string $new_name): bool;
 
    public function query(string $query): ilDBStatement;
 
    public function fetchAll(ilDBStatement $statement, int $fetch_mode = ilDBConstants::FETCHMODE_ASSOC): array;
 
    public function dropSequence(string $table_name): bool;
 
    public function dropTableColumn(string $table_name, string $column_name): bool;
 
    public function renameTableColumn(string $table_name, string $column_old_name, string $column_new_name): bool;
 
    public function insert(string $table_name, array $values): int;
 
    public function fetchObject(ilDBStatement $query_result): ?stdClass;
 
    public function update(string $table_name, array $values, array $where): int;
 
    public function manipulate(string $query): int;
 
    public function fetchAssoc(ilDBStatement $statement): ?array;
 
    public function numRows(ilDBStatement $statement): int;
 
    public function quote($value, string $type): string;
 
    public function addIndex(string $table_name, array $fields, string $index_name = '', bool $fulltext = false): bool;
 
    public function indexExistsByFields(string $table_name, array $fields): bool;
 
    public function getDSN(): string;
 
    public function getDBType(): string;
 
    public function lockTables(array $tables): void;
 
    public function unlockTables(): void;
 
    public function in(string $field, array $values, bool $negate = false, string $type = ""): string;
 
    public function queryF(string $query, array $types, array $values): ilDBStatement;
 
    public function manipulateF(string $query, array $types, array $values): int;
 
    public function useSlave(bool $bool): bool;
 
    public function setLimit(int $limit, int $offset = 0): void;
 
    public function like(string $column, string $type, string $value = "?", bool $case_insensitive = true): string;
 
    public function now(): string;
 
    public function replace(string $table, array $primary_keys, array $other_columns): int;
 
    public function equals(string $columns, $value, string $type, bool $emptyOrNull = false): string;
 
    public function setDBUser(string $user): void;
 
    public function setDBPort(int $port): void;
 
    public function setDBPassword(string $password): void;
 
    public function setDBHost(string $host): void;
 
    public function upper(string $expression): string;
 
    public function lower(string $expression): string;
 
    public function substr(string $expression): string;
 
    public function prepare(string $a_query, ?array $a_types = null, ?array $a_result_types = null): ilDBStatement;
 
    public function prepareManip(string $a_query, ?array $a_types = null): ilDBStatement;
 
    public function enableResultBuffering(bool $a_status): void;
 
    public function execute(ilDBStatement $stmt, array $data = []): ilDBStatement;
 
    public function sequenceExists(string $sequence): bool;
 
    public function listSequences(): array;
 
    public function supports(string $feature): bool;
 
    public function supportsFulltext(): bool;
 
    public function supportsSlave(): bool;
 
    public function supportsTransactions(): bool;
 
    public function listTables(): array;
 
    public function loadModule(string $module);
 
    public function getAllowedAttributes(): array;
 
    public function concat(array $values, bool $allow_null = true): string;
 
    public function locate(string $needle, string $string, int $start_pos = 1): string;
 
    public function quoteIdentifier(string $identifier, bool $check_option = false): string;
 
    public function modifyTableColumn(string $table, string $column, array $attributes): bool;
 
    public function free(ilDBStatement $a_st): void;
 
    public function checkTableName(string $a_name): bool;
 
    public static function isReservedWord(string $a_word): bool;
 
    public function beginTransaction(): bool;
 
    public function commit(): bool;
 
    public function rollback(): bool;
 
    public function constraintName(string $a_table, string $a_constraint): string;
 
    public function dropIndex(string $a_table, string $a_name = "i1"): bool;
 
    public function createDatabase(string $a_name, string $a_charset = "utf8", string $a_collation = ""): bool;
 
    public function dropIndexByFields(string $table_name, array $afields): bool;
 
    public function getPrimaryKeyIdentifier(): string;
 
    public function addFulltextIndex(string $table_name, array $afields, string $a_name = 'in'): bool;
 
    public function dropFulltextIndex(string $a_table, string $a_name): bool;
 
    public function isFulltextIndex(string $a_table, string $a_name): bool;
 
    public function setStorageEngine(string $storage_engine): void;
 
    public function getStorageEngine(): string;
 
    public function buildAtomQuery(): ilAtomQuery;
 
    public function groupConcat(string $a_field_name, string $a_seperator = ",", ?string $a_order = null): string;
 
    public function cast(string $a_field_name, string $a_dest_type): string;
 
    public function 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
    ): bool;
 
    public function dropForeignKey(string $foreign_key_name, string $table_name): bool;
 
    public function foreignKeyExists(string $foreign_key_name, string $table_name): bool;
 
    public function buildIntegrityAnalyser(): Integrity;
 
    public function primaryExistsByFields(string $table_name, array $fields): bool;
}