interface.ilDBInterface.php

Go to the documentation of this file.

<?php

interface ilDBInterface
{

    public function doesCollationSupportMB4Strings();

    public function sanitizeMB4StringIfNotSupported($query);

    public static function getReservedWords();


    public function initFromIniFile($tmpClientIniFile = null);


    public function connect($return_false_on_error = false);


    public function nextId($table_name);


    public function createTable($table_name, $fields, $drop_table = false, $ignore_erros = false);


    public function addPrimaryKey($table_name, $primary_keys);


    public function createSequence($table_name, $start = 1);


    public function getSequenceName($table_name);


    public function tableExists($table_name);


    public function tableColumnExists($table_name, $column_name);


    public function addTableColumn($table_name, $column_name, $attributes);


    public function dropTable($table_name, $error_if_not_existing = true);


    public function renameTable($old_name, $new_name);


    public function query($query);


    public function fetchAll($query_result, $fetch_mode = ilDBConstants::FETCHMODE_ASSOC);


    public function dropSequence($table_name);


    public function dropTableColumn($table_name, $column_name);


    public function renameTableColumn($table_name, $column_old_name, $column_new_name);


    public function insert($table_name, $values);


    public function fetchObject($query_result);


    public function update($table_name, $values, $where);


    public function manipulate($query);


    public function fetchAssoc($query_result);


    public function numRows($query_result);


    public function quote($value, $type);


    public function addIndex($table_name, $fields, $index_name = '', $fulltext = false);


    public function indexExistsByFields($table_name, $fields);

    //  public function fetchRow($fetchMode = ilDBConstants::FETCHMODE_ASSOC);

    public function getDSN();


    public function getDBType();


    public function lockTables($tables);


    public function unlockTables();


    public function in($field, $values, $negate = false, $type = "");


    public function queryF($query, $types, $values);


    public function manipulateF($query, $types, $values);


    public function useSlave($bool);


    public function setLimit($limit, $offset);


    public function like($column, $type, $value = "?", $case_insensitive = true);


    public function now();


    public function replace($table, $primaryKeys, $otherColumns);


    public function equals($columns, $value, $type, $emptyOrNull = false);


    public function setDBUser($user);


    public function setDBPort($port);


    public function setDBPassword($password);


    public function setDBHost($host);


    public function upper($a_exp);


    public function lower($a_exp);


    public function substr($a_exp);

    public function prepare($a_query, $a_types = null, $a_result_types = null);


    public function prepareManip($a_query, $a_types = null);


    public function enableResultBuffering($a_status);


    public function execute($stmt, $data = array());

    public function sequenceExists($sequence);


    public function listSequences();



    //
    // type-specific methods
    //

    public function supports($feature);


    public function supportsFulltext();


    public function supportsSlave();


    public function supportsTransactions();

    //
    //
    //
    public function listTables();


    public function loadModule($module);


    public function getAllowedAttributes();


    public function concat(array $values, $allow_null = true);


    public function locate($a_needle, $a_string, $a_start_pos = 1);


    public function quoteIdentifier($identifier, $check_option = false);


    public function modifyTableColumn($table, $column, $attributes);


    public function free($a_st);


    public function checkTableName($a_name);


    public static function isReservedWord($a_word);


    public function beginTransaction();


    public function commit();


    public function rollback();


    public function constraintName($a_table, $a_constraint);


    public function dropIndex($a_table, $a_name = "i1");


    public function createDatabase($a_name, $a_charset = "utf8", $a_collation = "");


    public function dropIndexByFields($table_name, $afields);


    public function getPrimaryKeyIdentifier();


    public function addFulltextIndex($table_name, $afields, $a_name = 'in');


    public function dropFulltextIndex($a_table, $a_name);


    public function isFulltextIndex($a_table, $a_name);


    public function setStorageEngine($storage_engine);


    public function getStorageEngine();


    public function buildAtomQuery();


    public function groupConcat($a_field_name, $a_seperator = ",", $a_order = null);


    public function cast($a_field_name, $a_dest_type);
}

interface ilDBPdoInterface extends ilDBInterface
{

    public function getServerVersion($native = false);


    public function queryCol($query, $type = ilDBConstants::FETCHMODE_DEFAULT, $colnum = 0);


    public function queryRow($query, $types = null, $fetchmode = ilDBConstants::FETCHMODE_DEFAULT);


    public function escape($value, $escape_wildcards = false);


    public function escapePattern($text);


    public function migrateAllTablesToEngine($engine = ilDBConstants::MYSQL_ENGINE_INNODB);


    public function supportsEngineMigration();


    public function migrateAllTablesToCollation($collation = ilDBConstants::MYSQL_COLLATION_UTF8MB4);


    public function supportsCollationMigration();


    public function addUniqueConstraint($table, $fields, $name = "con");


    public function dropUniqueConstraint($table, $name = "con");


    public function dropUniqueConstraintByFields($table, $fields);


    public function checkIndexName($name);


    public function getLastInsertId();


    public function prepare($query, $types = null, $result_types = null);


    public function uniqueConstraintExists($table, array $fields);


    public function dropPrimaryKey($table_name);


    public function executeMultiple($stmt, $data);


    public function fromUnixtime($expr, $to_text = true);


    public function unixTimestamp();


    public function autoExecute($tablename, $fields, $mode = ilDBConstants::MDB2_AUTOQUERY_INSERT, $where = false);


    public function getDBVersion();
}