ilDB Class Reference

Database Wrapper. More...

Inheritance diagram for ilDB:

Collaboration diagram for ilDB:

Public Member Functions
	setDBUser ($a_user)
	Set database user. More...
	getDBUser ()
	Get database user. More...
	setDBPort ($a_port)
	Set database port. More...
	getDBPort ()
	Get database port. More...
	setDBHost ($a_host)
	Set database host. More...
	getDBHost ()
	Get database host. More...
	setDBPassword ($a_password)
	Set database password. More...
	getDBPassword ()
	Get database password. More...
	setDBName ($a_name)
	Set database name. More...
	getDBName ()
	Get database name. More...
	getDSN ()
	Get DSN. More...
	getDBVersion ()
	Get DB version. More...
	getDBType ()
	Get DSN. More...
	enableResultBuffering ($a_status)
	En/disable result buffering. More...
	initFromIniFile ($tmpClientIniFile=null)
	Init db parameters from ini file. More...
	connect ($a_return_false_for_error=false)
	Open the connection. More...
	doConnect ()
	Standard way to connect to db. More...
	disconnect ()
	Disconnect. More...
	getHostDSN ()
	Should return a valid value, if host connections are possible (connectHost) to create a new database from scratch. More...
	connectHost ()
	Sets up a host connection only (no specific database used). More...
	supportsFulltext ()
	supportsSlave ()
	Supports slave. More...
	supports ($feature)
	supportsTransactions ()
	useSlave ($a_val=true)
	Use slave. More...
	handleError ($a_res, $a_info="", $a_level="")
	Handle MDB2 Errors. More...
	raisePearError ($a_message, $a_level="")
	Raise an error. More...
	createDatabase ($a_name, $a_charset="utf8", $a_collation="")
	Create database. More...
	createTable ( $a_name, $a_definition_array, $a_drop_table=false, $a_ignore_erros=false)
	Create a new table in the database. More...
	dropTable ($a_name, $a_error_if_not_existing=true)
	Drop a table. More...
	alterTable ($a_name, $a_changes)
	Alter a table in the database This method is DEPRECATED, see http://www.ilias.de/docu/goto.php?target=pg_25354_42&client_id=docu PLEASE USE THE SPECIALIZED METHODS OF THIS CLASS TO CHANGE THE DB SCHEMA. More...
	addTableColumn ($a_table, $a_column, $a_attributes)
	Add table column Use this only on aleady "abstracted" tables. More...
	dropTableColumn ($a_table, $a_column)
	Drop table column Use this only on aleady "abstracted" tables. More...
	modifyTableColumn ($a_table, $a_column, $a_attributes)
	Modify a table column Use this only on aleady "abstracted" tables. More...
	renameTableColumn ($a_table, $a_column, $a_new_column)
	Rename a table column Use this only on aleady "abstracted" tables. More...
	renameTable ($a_name, $a_new_name)
	Rename a table. More...
	addPrimaryKey ($a_table, $a_fields)
	Add a primary key to a table. More...
	getPrimaryKeyIdentifier ()
	Primary key identifier. More...
	dropPrimaryKey ($a_table)
	Drop a primary key from a table. More...
	addFulltextIndex ($a_table, $a_fields, $a_name="in")
	Add fulltext index. More...
	isFulltextIndex ($a_table, $a_name)
	Is index a fulltext index? More...
	indexExistsByFields ($a_table, $a_fields)
	Check if index exists. More...
	dropIndexByFields ($a_table, $a_fields)
	Drop index by field(s) More...
	dropIndex ($a_table, $a_name="in")
	Drop an index from a table. More...
	addUniqueConstraint ($a_table, $a_fields, $a_name="con")
	Add a unique constraint to a table. More...
	dropUniqueConstraint ($a_table, $a_name="con")
	Drop a constraint from a table. More...
	dropUniqueConstraintByFields ($a_table, $a_fields)
	Drop constraint by field(s) More...
	createSequence ($a_table_name, $a_start=1)
	Create a sequence for a table. More...
	dropSequence ($a_table_name)
	Drop a sequence for a table. More...
	checkTableName ($a_name)
	Check whether a table name is valid. More...
	checkTableColumns ($a_cols)
	Check table columns definition. More...
	checkColumn ($a_col, $a_def)
	Check column definition. More...
	checkColumnDefinition ($a_def, $a_modify_mode=false)
	Check whether a column definition is valid. More...
	checkColumnName ($a_name)
	Check whether a column name is valid. More...
	checkIndexName ($a_name)
	Check whether an index name is valid. More...
	getAllowedAttributes ()
	constraintName ($a_table, $a_constraint)
	Determine contraint name by table name and constraint name. More...
	query ($sql, $a_handle_error=true)
	Query. More...
	queryF ($a_query, $a_types, $a_values)
	Formatted query (for SELECTS). More...
	manipulateF ($a_query, $a_types, $a_values)
	Formatted manupulate (for DELETE, UPDATE, INSERT). More...
	logStatement ($sql)
	Helper function, should usually not be called. More...
	setLimit ($a_limit, $a_offset=0)
	Set limit and offset for a query. More...
	nextId ($a_table_name)
	Get next ID for an index. More...
	manipulate ($sql)
	Data manipulation. More...
	prepare ($a_query, $a_types=null, $a_result_types=null)
	Prepare a query (SELECT) statement to be used with execute. More...
	prepareManip ($a_query, $a_types=null)
	Prepare a data manipulation statement to be used with execute. More...
	execute ($a_stmt, $a_data=null)
	Execute a query statement prepared by either prepare() or prepareManip() More...
	executeMultiple ($a_stmt, $a_data)
	Execute a query statement prepared by either prepare() or prepareManip() with multiple data arrays. More...
	insert ($a_table, $a_columns)
	Convenient method for standard insert statements, example field array: More...
	update ($a_table, $a_columns, $a_where)
	Convenient method for standard update statements, example field array: More...
	replace ($a_table, $a_pk_columns, $a_other_columns)
	Replace into method. More...
	fetchAssoc ($a_set)
	Fetch row as associative array from result set. More...
	free ($a_st)
	Free a statement / result set. More...
	fetchObject ($a_set)
	Fetch row as object from result set. More...
	numRows ($a_set)
	Fetch row as associative array from result set. More...
	in ($a_field, $a_values, $negate=false, $a_type="")
	Get abstract in-clause for given array. More...
	addTypesToArray ($a_arr, $a_type, $a_cnt)
	Adds a type x times to an array. More...
	now ()
	now() More...
	concat (array $a_values, $a_allow_null=true)
	Abstraction of SQL function CONCAT. More...
	substr ($a_exp, $a_pos=1, $a_len=-1)
	Substring. More...
	upper ($a_exp)
	Upper. More...
	lower ($a_exp)
	Upper. More...
	locate ($a_needle, $a_string, $a_start_pos=1)
	Create locate string. More...
	like ($a_col, $a_type, $a_value="?", $case_insensitive=true)
	Like. More...
	equals ($a_col, $a_value, $a_type, $a_empty_or_null=false)
	Use this only on text fields. More...
	equalsNot ($a_col, $a_value, $a_type, $a_empty_or_null=false)
	Use this only on text fields. More...
	fromUnixtime ($a_expr, $a_to_text=true)
	fromUnixtime (makes timestamp out of unix timestamp) More...
	unixTimestamp ()
	Unix timestamp. More...
	tableExists ($a_table)
	Check, whether a given table exists. More...
	tableColumnExists ($a_table, $a_column_name)
	Checks for the existence of a table column. More...
	uniqueConstraintExists ($a_table, array $a_fields)
	Checks if a unique constraint exists based on the fields of the unique constraint (not the name) More...
	listTables ()
	Get all tables. More...
	sequenceExists ($a_sequence)
	Check, whether a given sequence exists. More...
	listSequences ()
	Get all sequences. More...
	quote ($a_query, $a_type=null)
	Wrapper for quote method. More...
	quoteIdentifier ($a_identifier, $check_option=false)
	Quote table and field names. More...
	beginTransaction ()
	Begin Transaction. More...
	commit ()
	Commit a transaction. More...
	rollback ()
	Rollback a transaction. More...
	lockTables ($a_tables)
	Abstraction of lock table. More...
	unlockTables ()
	Unlock tables locked by previous lock table calls. More...
	autoExecute ($a_tablename, $a_fields, $a_mode=MDB2_AUTOQUERY_INSERT, $a_where=false)
	Wrapper for Pear autoExecute. More...
	getLastInsertId ()
	Get last insert id. More...
	getOne ($sql)
	getOne. More...
	getRow ($sql, $mode=ilDBConstants::FETCHMODE_OBJECT)
	getRow. More...
	setSubType ($a_value)
	Set sub type. More...
	getSubType ()
	Get sub type. More...
	migrateAllTablesToEngine ($engine=ilDBConstants::MYSQL_ENGINE_INNODB)
	supportsEngineMigration ()
	getSequenceName ($table_name)
	buildAtomQuery ()
	sanitizeMB4StringIfNotSupported ($query)
	Parameters $query string to sanitize, all MB4-Characters like emojis will re replaced with ??? Returns string sanitized query More...
	doesCollationSupportMB4Strings ()
	cast ($a_field_name, $a_dest_type)
Public Member Functions inherited from PEAR
	__construct ($error_class=null)
	Constructor. More...
	_PEAR ()
	Destructor (the emulated type of...). More...
	registerShutdownFunc ($func, $args=array())
	Use this function to register a shutdown method for static classes. More...
	isError ($data, $code=null)
	Tell whether a value is a PEAR error. More...
	expectError ($code=' *')
	This method is used to tell which errors you expect to get. More...
	popExpect ()
	This method pops one element off the expected error codes stack. More...
	_checkDelExpect ($error_code)
	This method checks unsets an error code if available. More...
	delExpect ($error_code)
	This method deletes all occurences of the specified element from the expected error codes stack. More...
&	raiseError ($message=null, $code=null, $mode=null, $options=null, $userinfo=null, $error_class=null, $skipmsg=false)
	This method is a wrapper that returns an instance of the configured error class with this object's default error handling applied. More...
&	throwError ($message=null, $code=null, $userinfo=null)
	Simpler form of raiseError with fewer options. More...
	staticPushErrorHandling ($mode, $options=null)
	staticPopErrorHandling ()
	pushErrorHandling ($mode, $options=null)
	Push a new error handler on top of the error handler options stack. More...
	popErrorHandling ()
	Pop the last error handler used. More...
	loadExtension ($ext)
	OS independant PHP extension load. More...
Public Member Functions inherited from ilDBInterface
	query ($query)
	Run a (read-only) Query on the database. More...
	fetchAll ($query_result, $fetch_mode=ilDBConstants::FETCHMODE_ASSOC)
	addIndex ($table_name, $fields, $index_name='', $fulltext=false)
	substr ($a_exp)
	loadModule ($module)
	dropFulltextIndex ($a_table, $a_name)
	setStorageEngine ($storage_engine)
	getStorageEngine ()
	groupConcat ($a_field_name, $a_seperator=",", $a_order=null)

Static Public Member Functions
static	getReservedWords ()
	Get reserved words. More...
static	isDbError ($a_res)
	Check error. More...
static	isReservedWord ($a_word)
	Checks whether a word is a reserved word in one of the supported databases. More...
Static Public Member Functions inherited from PEAR
static &	getStaticProperty ($class, $var)
	If you have a class that's mostly/entirely static, and you need static properties, you can use this method to simulate them. More...
static	setErrorHandling ($mode=null, $options=null)
	Sets how errors generated by this object should be handled. More...

Data Fields
const	LOCK_WRITE = 1
const	LOCK_READ = 2
	$error_class
	$db
	$result
	$allowed_attributes
	$sub_type
Data Fields inherited from PEAR
	$_debug = false
	$_default_error_mode = null
	$_default_error_options = null
	$_default_error_handler = ''
	$_error_class = 'PEAR_Error'
	$_expected_errors = array()

Protected Member Functions
	initConnection ()
	Initialize the database connection. More...
	initHostConnection ()
	Initialize the host connection (no specific database) More...
	loadMDB2Extensions ()
	load additional mdb2 extensions and set their constants More...
	getCreateTableOptions ()
	Get options for the create table statement. More...

Detailed Description

Database Wrapper.

this class should extend PEAR::DB, add error Management in case of a db-error in any database query the ilDB-class raises an error

Author

Peter Gabriel peter.nosp@m.@gab.nosp@m.riel-.nosp@m.onli.nosp@m.ne.ne.nosp@m.t

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 29 of file class.ilDB.php.

Member Function Documentation

addFulltextIndex()

ilDB::addFulltextIndex	(		$a_table,
			$a_fields,
			$a_name = "in"
	)

Add fulltext index.

Implements ilDBInterface.

Definition at line 929 of file class.ilDB.php.

Referenced by dropPrimaryKey().

    {
        return false;
    }

Here is the caller graph for this function:

addPrimaryKey()

ilDB::addPrimaryKey	(		$a_table,
			$a_fields
	)

Add a primary key to a table.

Parameters

string	table name
array	fields for primary key
string	key name

Implements ilDBInterface.

Definition at line 839 of file class.ilDB.php.

References $r, array, constraintName(), getPrimaryKeyIdentifier(), and handleError().

    {
        $manager = $this->db->loadModule('Manager');
        
        $fields = array();
        foreach ($a_fields as $f) {
            $fields[$f] = array();
        }
        $definition = array(
            'primary' => true,
            'fields' => $fields
        );
        $r = $manager->createConstraint(
            $a_table,
            $this->constraintName($a_table, $this->getPrimaryKeyIdentifier()),
            $definition
        );

        return $this->handleError($r, "addPrimaryKey(" . $a_table . ")");
    }

Here is the call graph for this function:

addTableColumn()

ilDB::addTableColumn	(		$a_table,
			$a_column,
			$a_attributes
	)

Add table column Use this only on aleady "abstracted" tables.

Parameters

string	table name
string	column name
array	attributes array("length" => 10, "default" => "t")

Implements ilDBInterface.

Definition at line 637 of file class.ilDB.php.

References $r, array, checkColumnDefinition(), checkColumnName(), handleError(), and raisePearError().

    {
        $manager = $this->db->loadModule('Manager');

        if (!$this->checkColumnName($a_column)) {
            $this->raisePearError("ilDB Error: addTableColumn(" . $a_table . ", " . $a_column . ")<br />" .
                $this->error_str);
        }
        if (!$this->checkColumnDefinition($a_attributes)) {
            $this->raisePearError("ilDB Error: addTableColumn(" . $a_table . ", " . $a_column . ")<br />" .
                $this->error_str);
        }
        
        $changes = array(
            "add" => array(
                $a_column => $a_attributes
                )
            );

        $r = $manager->alterTable($a_table, $changes, false);

        return $this->handleError($r, "addTableColumn(" . $a_table . ", " . $a_column . ")");
    }

Here is the call graph for this function:

addTypesToArray()

ilDB::addTypesToArray	(		$a_arr,
			$a_type,
			$a_cnt
	)

Adds a type x times to an array.

Definition at line 1798 of file class.ilDB.php.

References $a_type, and array.

    {
        if (!is_array($a_arr)) {
            $a_arr = array();
        }
        if ($a_cnt > 0) {
            $type_arr = array_fill(0, $a_cnt, $a_type);
        } else {
            $type_arr = array();
        }
        return array_merge($a_arr, $type_arr);
    }

addUniqueConstraint()

ilDB::addUniqueConstraint	(		$a_table,
			$a_fields,
			$a_name = "con"
	)

Add a unique constraint to a table.

Parameters

string	table name
array	fields being unique
string	index name

Definition at line 1015 of file class.ilDB.php.

References $r, array, checkIndexName(), constraintName(), handleError(), and raisePearError().

    {
        $manager = $this->db->loadModule('Manager');
        
        // check index name
        if (!$this->checkIndexName($a_name)) {
            $this->raisePearError("ilDB Error: addUniqueConstraint(" . $a_table . "," . $a_name . ")<br />" .
                $this->error_str);
        }
        
        $fields = array();
        foreach ($a_fields as $f) {
            $fields[$f] = array();
        }
        $definition = array(
            'unique' => true,
            'fields' => $fields
        );
        
        $r = $manager->createConstraint($a_table, $this->constraintName($a_table, $a_name), $definition);

        return $this->handleError($r, "addUniqueConstraint(" . $a_table . ")");
    }

Here is the call graph for this function:

alterTable()

ilDB::alterTable	(		$a_name,
			$a_changes
	)

Alter a table in the database This method is DEPRECATED, see http://www.ilias.de/docu/goto.php?target=pg_25354_42&client_id=docu PLEASE USE THE SPECIALIZED METHODS OF THIS CLASS TO CHANGE THE DB SCHEMA.

Definition at line 617 of file class.ilDB.php.

References $r, array, and handleError().

    {
        if ($a_options == "") {
            $a_options = array();
        }
        
        $manager = $this->db->loadModule('Manager');
        $r = $manager->alterTable($a_name, $a_changes, false);

        return $this->handleError($r, "alterTable(" . $a_name . ")");
    }

Here is the call graph for this function:

autoExecute()

ilDB::autoExecute	(		$a_tablename,
			$a_fields,
			$a_mode = MDB2_AUTOQUERY_INSERT,
			$a_where = false
	)

Wrapper for Pear autoExecute.

Parameters

string	tablename
array	fields values
int	MDB2_AUTOQUERY_INSERT or MDB2_AUTOQUERY_UPDATE
string	where condition (e.g. "obj_id = '7' AND ref_id = '5'")

Returns

mixed a new DB_result/DB_OK or a DB_Error, if fail

Definition at line 2233 of file class.ilDB.php.

References $res, and handleError().

    {
        $res = $this->db->autoExecute($a_tablename, $a_fields, $a_mode, $a_where);

        return $this->handleError($res, "autoExecute(" . $a_tablename . ")");
    }

Here is the call graph for this function:

beginTransaction()

ilDB::beginTransaction

(

)

Begin Transaction.

Please note that we currently do not use savepoints.

Returns

boolean MDB2_OK on success

Implements ilDBInterface.

Definition at line 2173 of file class.ilDB.php.

References $res, handleError(), and raisePearError().

    {
        if (!$this->db->supports('transactions')) {
            $this->raisePearError("ilDB::beginTransaction: Transactions are not supported.", $this->error_class->FATAL);
        }
        $res = $this->db->beginTransaction();
        
        return $this->handleError($res, "beginTransaction()");
    }

Here is the call graph for this function:

buildAtomQuery()

ilDB::buildAtomQuery

(

)

Returns

Implements ilDBInterface.

Definition at line 2373 of file class.ilDB.php.

    {
        require_once('./Services/Database/classes/Atom/class.ilAtomQueryLock.php');

        return new ilAtomQueryLock($this);
    }

cast()

ilDB::cast	(		$a_field_name,
			$a_dest_type
	)

Implements ilDBInterface.

Definition at line 2413 of file class.ilDB.php.

    {
        $manager = $this->db->loadModule('Manager');
        return $manager->getQueryUtils()->cast($a_field_name, $a_dest_type);
    }

checkColumn()

ilDB::checkColumn	(		$a_col,
			$a_def
	)

Check column definition.

Definition at line 1164 of file class.ilDB.php.

References checkColumnDefinition(), and checkColumnName().

Referenced by checkTableColumns().

    {
        if (!$this->checkColumnName($a_col)) {
            return false;
        }

        if (!$this->checkColumnDefinition($a_def)) {
            return false;
        }
        
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkColumnDefinition()

ilDB::checkColumnDefinition	(		$a_def,
			$a_modify_mode = false
	)

Check whether a column definition is valid.

Parameters

array

definition array

Definition at line 1182 of file class.ilDB.php.

References $allowed_attributes, and array.

Referenced by addTableColumn(), checkColumn(), and modifyTableColumn().

    {
        // check valid type
        if (!in_array($a_def["type"], array("text", "integer", "float", "date", "time", "timestamp", "clob", "blob"))) {
            switch ($a_def["type"]) {
                case "boolean":
                    $this->error_str = "Invalid column type '" . $a_def["type"] . "'. Use integer(1) instead.";
                    break;

                case "decimal":
                    $this->error_str = "Invalid column type '" . $a_def["type"] . "'. Use float or integer instead.";
                    break;
                    
                default:
                    $this->error_str = "Invalid column type '" . $a_def["type"] . "'. Allowed types are: " .
                        "text, integer, float, date, time, timestamp, clob and blob.";
            }
        }
        
        // check used attributes
        $allowed_attributes = $this->allowed_attributes;
        
        foreach ($a_def as $k => $v) {
            if ($k != "type" && !in_array($k, $allowed_attributes[$a_def["type"]])) {
                $this->error_str = "Attribute '" . $k . "' is not allowed for column type '" . $a_def["type"] . "'.";
                return false;
            }
        }
        
        // type specific checks
        switch ($a_def["type"]) {
            case "text":
                if ($a_def["length"] < 1 || $a_def["length"] > 4000) {
                    if (!$a_modify_mode || isset($a_def["length"])) {
                        $this->error_str = "Invalid length '" . $a_def["length"] . "' for type text." .
                            " Length must be >=1 and <= 4000.";
                        return false;
                    }
                }
                break;

            case "integer":
                if (!in_array($a_def["length"], array(1, 2, 3, 4, 8))) {
                    if (!$a_modify_mode || isset($a_def["length"])) {
                        $this->error_str = "Invalid length '" . $a_def["length"] . "' for type integer." .
                            " Length must be 1, 2, 3, 4 or 8 (bytes).";
                        return false;
                    }
                }
                if ($a_def["unsigned"]) {
                    $this->error_str = "Unsigned attribut must not be true for type integer.";
                    return false;
                }
                break;
        }
        
        return true;
    }

Here is the caller graph for this function:

checkColumnName()

ilDB::checkColumnName

(

$a_name

)

Check whether a column name is valid.

Parameters

string

$a_name

Definition at line 1246 of file class.ilDB.php.

References isReservedWord(), and substr().

Referenced by addTableColumn(), checkColumn(), and renameTableColumn().

    {
        if (!preg_match("/^[a-z]+[_a-z0-9]*$/", $a_name)) {
            $this->error_str = "Invalid column name '" . $a_name . "'. Column name must only contain _a-z0-9 and must start with a-z.";
            return false;
        }
        
        if ($this->isReservedWord($a_name)) {
            $this->error_str = "Invalid column name '" . $a_name . "' (Reserved Word).";
            return false;
        }
        
        if (strtolower(substr($a_name, 0, 4)) == "sys_") {
            $this->error_str = "Invalid column name '" . $a_name . "'. Name must not start with 'sys_'.";
            return false;
        }

        if (strlen($a_name) > 30) {
            $this->error_str = "Invalid column name '" . $a_name . "'. Maximum column identifer length is 30 bytes.";
            return false;
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkIndexName()

ilDB::checkIndexName

(

$a_name

)

Check whether an index name is valid.

Parameters

string

$a_name

Definition at line 1276 of file class.ilDB.php.

References isReservedWord().

Referenced by addUniqueConstraint(), and dropPrimaryKey().

    {
        if (!preg_match("/^[a-z]+[_a-z0-9]*$/", $a_name)) {
            $this->error_str = "Invalid column name '" . $a_name . "'. Column name must only contain _a-z0-9 and must start with a-z.";
            return false;
        }
        
        if ($this->isReservedWord($a_name)) {
            $this->error_str = "Invalid column name '" . $a_name . "' (Reserved Word).";
            return false;
        }
        
        if (strlen($a_name) > 3) {
            $this->error_str = "Invalid index name '" . $a_name . "'. Maximum index identifer length is 3 bytes.";
            return false;
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkTableColumns()

ilDB::checkTableColumns

(

$a_cols

)

Check table columns definition.

Parameters

array

definition array

Definition at line 1150 of file class.ilDB.php.

References $def, and checkColumn().

Referenced by createTable().

    {
        foreach ($a_cols as $col => $def) {
            if (!$this->checkColumn($col, $def)) {
                return false;
            }
        }
        
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkTableName()

ilDB::checkTableName

(

$a_name

)

Check whether a table name is valid.

Parameters

string

$a_name

Implements ilDBInterface.

Definition at line 1120 of file class.ilDB.php.

References isReservedWord(), and substr().

Referenced by createTable(), and renameTable().

    {
        if (!preg_match("/^[a-z]+[_a-z0-9]*$/", $a_name)) {
            $this->error_str = "Table name must only contain _a-z0-9 and must start with a-z.";
            return false;
        }
        
        if ($this->isReservedWord($a_name)) {
            $this->error_str = "Invalid table name '" . $a_name . "' (Reserved Word).";
            return false;
        }

        if (strtolower(substr($a_name, 0, 4)) == "sys_") {
            $this->error_str = "Invalid table name '" . $a_name . "'. Name must not start with 'sys_'.";
            return false;
        }

        if (strlen($a_name) > 22) {
            $this->error_str = "Invalid table name '" . $a_name . "'. Maximum table identifer length is 22 bytes.";
            return false;
        }
        
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

commit()

ilDB::commit

(

)

Commit a transaction.

Implements ilDBInterface.

Definition at line 2186 of file class.ilDB.php.

References $res, and handleError().

    {
        $res = $this->db->commit();
        
        return $this->handleError($res, "commit()");
    }

Here is the call graph for this function:

concat()

ilDB::concat	(	array	$a_values,
			$a_allow_null = true
	)

Abstraction of SQL function CONCAT.

Parameters

array	$a_values	array( array('title','text'), array('description','clob'), array('some text','text');
bool	$a_allow_null

Returns

Implements ilDBInterface.

Definition at line 1830 of file class.ilDB.php.

    {
        if (!count($a_values)) {
            return ' ';
        }

        $concat = ' CONCAT(';
        $first = true;
        foreach ($a_values as $field_info) {
            $val = $field_info[0];
            
            if (!$first) {
                $concat .= ',';
            }
            
            if ($a_allow_null) {
                $concat .= 'COALESCE(';
            }
            $concat .= $val;
            
            if ($a_allow_null) {
                $concat .= ",''";
                $concat .= ')';
            }
            
            $first = false;
        }
        $concat .= ') ';
        return $concat;
    }

connect()

ilDB::connect

(

$a_return_false_for_error = false

)

Open the connection.

Implements ilDBInterface.

Definition at line 234 of file class.ilDB.php.

References array, doConnect(), getDSN(), handleError(), initConnection(), isDbError(), MDB2\isError(), loadMDB2Extensions(), MDB2_PORTABILITY_ALL, PEAR_ERROR_CALLBACK, raisePearError(), and PEAR\setErrorHandling().

    {
        //set up error handling
        $this->error_class = new ilErrorHandling();
        $this->setErrorHandling(PEAR_ERROR_CALLBACK, array($this->error_class,'errorHandler'));
        //echo $this->getDSN();
        //check dsn
        if ($this->getDSN() == "") {
            $this->raisePearError("No DSN given");
        }

        //connect to database
        $this->doConnect();
        
        if ($a_return_false_for_error && MDB2::isError($this->db)) {
            return false;
        }
            
        $this->loadMDB2Extensions();
        
        // set empty value portability to PEAR::DB behaviour
        if (!$this->isDbError($this->db)) {
            $this->db->setOption('portability', MDB2_PORTABILITY_ALL);
        }
        //check error
        $this->handleError($this->db);
        
        // anything, that must be done to initialize the connection
        $this->initConnection();

        return true;
    }

Here is the call graph for this function:

connectHost()

ilDB::connectHost

(

)

Sets up a host connection only (no specific database used).

This is optional during the setup procudure to create databases from scratch.

Definition at line 312 of file class.ilDB.php.

References array, MDB2\connect(), getHostDSN(), handleError(), initHostConnection(), isDbError(), MDB2\isError(), loadMDB2Extensions(), MDB2_PORTABILITY_EMPTY_TO_NULL, MDB2_PORTABILITY_FIX_CASE, PEAR_ERROR_CALLBACK, raisePearError(), and PEAR\setErrorHandling().

    {
        //set up error handling
        $this->error_class = new ilErrorHandling();
        $this->setErrorHandling(PEAR_ERROR_CALLBACK, array($this->error_class,'errorHandler'));
        
        //check dsn
        if ($this->getHostDSN() == "") {
            $this->raisePearError("No Host DSN given");
        }

        //connect to database
        $this->db = MDB2::connect(
            $this->getHostDSN(),
            array("use_transactions" => true)
        );
        if ($a_return_false_for_error && MDB2::isError($this->db)) {
            return false;
        }
            
        $this->loadMDB2Extensions();
        
        // set empty value portability to PEAR::DB behaviour
        if (!$this->isDbError($this->db)) {
            $cur = ($this->db->getOption("portability") & MDB2_PORTABILITY_EMPTY_TO_NULL);
            $this->db->setOption("portability", $this->db->getOption("portability") - $cur);

            $cur = ($this->db->getOption("portability") & MDB2_PORTABILITY_FIX_CASE);
            $this->db->setOption("portability", $this->db->getOption("portability") - $cur);
        }

        //check error
        $this->handleError($this->db);
        
        // anything, that must be done to initialize the connection
        $this->initHostConnection();

        return true;
    }

Here is the call graph for this function:

constraintName()

ilDB::constraintName	(		$a_table,
			$a_constraint
	)

Determine contraint name by table name and constraint name.

In MySQL these are "unique" per table, but they must be "globally" unique in oracle. (so this one is overwritten there)

Implements ilDBInterface.

Definition at line 1306 of file class.ilDB.php.

Referenced by ilDBMySQL\addFulltextIndex(), addPrimaryKey(), addUniqueConstraint(), ilDBMySQL\dropFulltextIndex(), dropIndex(), dropPrimaryKey(), and dropUniqueConstraint().

    {
        return $a_constraint;
    }

Here is the caller graph for this function:

createDatabase()

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

Create database.

Implements ilDBInterface.

Definition at line 500 of file class.ilDB.php.

References query().

    {
        if ($a_collation != "") {
            $sql = "CREATE DATABASE " . $a_name .
                " CHARACTER SET " . $a_charset .
                " COLLATE " . $a_collation;
        } else {
            $sql = "CREATE DATABASE " . $a_name .
                " CHARACTER SET " . $a_charset;
        }

        return $this->query($sql, false);
    }

Here is the call graph for this function:

createSequence()

ilDB::createSequence	(		$a_table_name,
			$a_start = 1
	)

Create a sequence for a table.

Implements ilDBInterface.

Definition at line 1093 of file class.ilDB.php.

References $r, and handleError().

    {
        $manager = $this->db->loadModule('Manager');

        $r = $manager->createSequence($a_table_name, $a_start);

        return $this->handleError($r, "createSequence(" . $a_table_name . ")");
    }

Here is the call graph for this function:

createTable()

ilDB::createTable	(		$a_name,
			$a_definition_array,
			$a_drop_table = false,
			$a_ignore_erros = false
	)

Create a new table in the database.

Parameters

string	table name
array	definition array: array("col1" => array("type" => "text", ...))
boolean	drop table automatically, if it already exists

Implements ilDBInterface.

Definition at line 522 of file class.ilDB.php.

References $options, $r, checkTableColumns(), checkTableName(), dropTable(), getCreateTableOptions(), handleError(), and raisePearError().

      {
        // check table name
        if (!$this->checkTableName($a_name) && !$a_ignore_erros) {
            $this->raisePearError("ilDB Error: createTable(" . $a_name . ")<br />" .
                $this->error_str);
        }
        
        // check definition array
        if (!$this->checkTableColumns($a_definition_array) && !$a_ignore_erros) {
            $this->raisePearError("ilDB Error: createTable(" . $a_name . ")<br />" .
                $this->error_str);
        }

        if ($a_drop_table) {
            $this->dropTable($a_name, false);
        }
        
        $options = $this->getCreateTableOptions();
        
        $manager = $this->db->loadModule('Manager');
        $r = $manager->createTable($a_name, $a_definition_array, $options);

        return $this->handleError($r, "createTable(" . $a_name . ")");
    }

Here is the call graph for this function:

disconnect()

ilDB::disconnect

(

)

Disconnect.

Definition at line 281 of file class.ilDB.php.

    {
        $this->db->disconnect();
    }

doConnect()

ilDB::doConnect

(

)

Standard way to connect to db.

Definition at line 270 of file class.ilDB.php.

References array, MDB2\connect(), and getDSN().

Referenced by connect().

    {
        $this->db = MDB2::connect(
            $this->getDSN(),
            array("use_transactions" => true)
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

doesCollationSupportMB4Strings()

ilDB::doesCollationSupportMB4Strings

(

)

Implements ilDBInterface.

Definition at line 2404 of file class.ilDB.php.

Referenced by sanitizeMB4StringIfNotSupported().

    {
        return false;
    }

Here is the caller graph for this function:

dropIndex()

ilDB::dropIndex	(		$a_table,
			$a_name = "in"
	)

Drop an index from a table.

Note: The index must have been created using MDB2

Parameters

string	table name
string	index name

Implements ilDBInterface.

Definition at line 995 of file class.ilDB.php.

References $r, constraintName(), ilDBInterface\dropFulltextIndex(), handleError(), and isFulltextIndex().

Referenced by dropIndexByFields().

    {
        $manager = $this->db->loadModule('Manager');
        
        if (!$this->isFulltextIndex($a_table, $a_name)) {
            $r = $manager->dropIndex($a_table, $this->constraintName($a_table, $a_name));
        } else {
            $this->dropFulltextIndex($a_table, $a_name);
        }

        return $this->handleError($r, "dropIndex(" . $a_table . ")");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

dropIndexByFields()

ilDB::dropIndexByFields	(		$a_table,
			$a_fields
	)

Drop index by field(s)

Parameters

type	$a_table
type	$a_fields

Returns

boolean

Implements ilDBInterface.

Definition at line 971 of file class.ilDB.php.

References $def, array, and dropIndex().

    {
        $manager = $this->db->loadModule('Manager');
        $reverse = $this->db->loadModule('Reverse');
        if ($manager) {
            foreach ($manager->listTableIndexes($a_table) as $idx_name) {
                $def = $reverse->getTableIndexDefinition($a_table, $idx_name);
                $idx_fields = array_keys((array) $def['fields']);
                
                if ($idx_fields === $a_fields) {
                    return $this->dropIndex($a_table, $idx_name);
                }
            }
        }
        return false;
    }

Here is the call graph for this function:

dropPrimaryKey()

ilDB::dropPrimaryKey

(

$a_table

)

Drop a primary key from a table.

Parameters

string	table name
string	key name

Definition at line 874 of file class.ilDB.php.

References $r, addFulltextIndex(), ilDBInterface\addIndex(), array, checkIndexName(), constraintName(), getPrimaryKeyIdentifier(), handleError(), raisePearError(), and supportsFulltext().

    {
        $manager = $this->db->loadModule('Manager');
        
        $r = $manager->dropConstraint(
            $a_table,
            $this->constraintName($a_table, $this->getPrimaryKeyIdentifier()),
            true
        );

        return $this->handleError($r, "dropPrimaryKey(" . $a_table . ")");
    }

Here is the call graph for this function:

dropSequence()

ilDB::dropSequence

(

$a_table_name

)

Drop a sequence for a table.

Implements ilDBInterface.

Definition at line 1106 of file class.ilDB.php.

References $r, and handleError().

    {
        $manager = $this->db->loadModule('Manager');
        
        $r = $manager->dropSequence($a_table_name);

        return $this->handleError($r, "dropSequence(" . $a_table_name . ")");
    }

Here is the call graph for this function:

dropTable()

ilDB::dropTable	(		$a_name,
			$a_error_if_not_existing = true
	)

Drop a table.

Parameters

string	table name
boolean	raise an error, if table not exists

Implements ilDBInterface.

Definition at line 568 of file class.ilDB.php.

References $i, $r, getDBType(), handleError(), listTables(), and substr().

Referenced by createTable().

    {
        if (!$a_error_if_not_existing) {
            $tables = $this->listTables();
            if (!in_array($a_name, $tables)) {
                return;
            }
        }
        
        $manager = $this->db->loadModule('Manager');

        if ($this->getDBType() == "oracle") {
            // drop table constraints
            $constraints = $manager->listTableConstraints($a_name);
            $this->handleError($constraints, "dropTable(" . $a_name . "), listTableConstraints");
            foreach ($constraints as $c) {
                if (substr($c, 0, 4) != "sys_") {
                    $r = $manager->dropConstraint($a_name, $c);
                    $this->handleError($r, "dropTable(" . $a_name . "), dropConstraint");
                }
            }

            // drop table indexes
            $indexes = $manager->listTableIndexes($a_name);
            $this->handleError($indexes, "dropTable(" . $a_name . "), listTableIndexes");
            foreach ($indexes as $i) {
                $r = $manager->dropIndex($a_name, $i);
                $this->handleError($r, "dropTable(" . $a_name . "), dropIndex");
            }
        }

        // drop sequence
        $seqs = $manager->listSequences();
        if (in_array($a_name, $seqs)) {
            $r = $manager->dropSequence($a_name);
            $this->handleError($r, "dropTable(" . $a_name . "), dropSequence");
        }
        
        // drop table
        $r = $manager->dropTable($a_name);

        return $this->handleError($r, "dropTable(" . $a_name . ")");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

dropTableColumn()

ilDB::dropTableColumn	(		$a_table,
			$a_column
	)

Drop table column Use this only on aleady "abstracted" tables.

Parameters

string	table name
string	column name

Implements ilDBInterface.

Definition at line 668 of file class.ilDB.php.

References $r, array, and handleError().

    {
        $manager = $this->db->loadModule('Manager');

        $changes = array(
            "remove" => array(
                $a_column => array()
                )
            );

        $r = $manager->alterTable($a_table, $changes, false);

        return $this->handleError($r, "dropTableColumn(" . $a_table . ", " . $a_column . ")");
    }

Here is the call graph for this function:

dropUniqueConstraint()

ilDB::dropUniqueConstraint	(		$a_table,
			$a_name = "con"
	)

Drop a constraint from a table.

Note: The constraint must have been created using MDB2

Parameters

string	table name
string	constraint name

Definition at line 1046 of file class.ilDB.php.

References $r, constraintName(), and handleError().

Referenced by dropUniqueConstraintByFields().

    {
        $manager = $this->db->loadModule('Manager');

        $r = $manager->dropConstraint(
            $a_table,
            $this->constraintName($a_table, $a_name),
            false
        );

        return $this->handleError($r, "dropUniqueConstraint(" . $a_table . ")");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

dropUniqueConstraintByFields()

ilDB::dropUniqueConstraintByFields	(		$a_table,
			$a_fields
	)

Drop constraint by field(s)

Parameters

string	table name
array	fields array

Definition at line 1065 of file class.ilDB.php.

References dropUniqueConstraint().

    {
        if (is_file("./Services/Database/classes/class.ilDBAnalyzer.php")) {
            include_once("./Services/Database/classes/class.ilDBAnalyzer.php");
        } else {
            include_once("../Services/Database/classes/class.ilDBAnalyzer.php");
        }
        $analyzer = new ilDBAnalyzer();
        $cons = $analyzer->getConstraintsInformation($a_table);
        foreach ($cons as $c) {
            if ($c["type"] == "unique" && count($a_fields) == count($c["fields"])) {
                $all_in = true;
                foreach ($a_fields as $f) {
                    if (!isset($c["fields"][$f])) {
                        $all_in = false;
                    }
                }
                if ($all_in) {
                    return $this->dropUniqueConstraint($a_table, $c['name']);
                }
            }
        }
        return false;
    }

Here is the call graph for this function:

enableResultBuffering()

ilDB::enableResultBuffering

(

$a_status

)

En/disable result buffering.

Parameters

bool

$a_status

Implements ilDBInterface.

Definition at line 202 of file class.ilDB.php.

    {
        $this->db->setOption('result_buffering', $a_status);
    }

equals()

ilDB::equals	(		$a_col,
			$a_value,
			$a_type,
			$a_empty_or_null = false
	)

Use this only on text fields.

Implements ilDBInterface.

Definition at line 1949 of file class.ilDB.php.

References $a_type, and quote().

    {
        if (!$a_empty_or_null || $a_value != "") {
            return $a_col . " = " . $this->quote($a_value, $a_type);
        } else {
            return "(" . $a_col . " = '' OR $a_col IS NULL)";
        }
    }

Here is the call graph for this function:

equalsNot()

ilDB::equalsNot	(		$a_col,
			$a_value,
			$a_type,
			$a_empty_or_null = false
	)

Use this only on text fields.

Definition at line 1961 of file class.ilDB.php.

References $a_type, and quote().

    {
        if (!$a_empty_or_null) {
            return $a_col . " <> " . $this->quote($a_value, $a_type);
        }
        if ($a_value != "") {
            return "(" . $a_col . " <> " . $this->quote($a_value, $a_type) . " OR " .
                $a_col . " IS NULL)";
        } else {
            return "(" . $a_col . " <> '' AND $a_col IS NOT NULL)";
        }
    }

Here is the call graph for this function:

execute()

ilDB::execute	(		$a_stmt,
			$a_data = null
	)

Execute a query statement prepared by either prepare() or prepareManip()

Parameters

object	Resource handle of the prepared query.
array	Array of data (to be used for placeholders)

Returns

mixed A result handle or MDB2_OK on success, a MDB2 error on failure

Implements ilDBInterface.

Definition at line 1512 of file class.ilDB.php.

References $res, and handleError().

    {
        $res = $a_stmt->execute($a_data);

        return $this->handleError($res, "execute(" . $a_stmt->query . ")");
    }

Here is the call graph for this function:

executeMultiple()

ilDB::executeMultiple	(		$a_stmt,
			$a_data
	)

Execute a query statement prepared by either prepare() or prepareManip() with multiple data arrays.

Parameters

object	Resource handle of the prepared query.
array	Array of array of data (to be used for placeholders)

Returns

mixed A result handle or MDB2_OK on success, a MDB2 error on failure

Definition at line 1528 of file class.ilDB.php.

References $res, and handleError().

    {
        $res = $this->db->extended->executeMultiple($a_stmt, $a_data);

        return $this->handleError($res, "executeMultiple(" . $a_stmt->query . ")");
    }

Here is the call graph for this function:

fetchAssoc()

ilDB::fetchAssoc

(

$a_set

)

Fetch row as associative array from result set.

Parameters

mixed

result set

Implements ilDBInterface.

Definition at line 1724 of file class.ilDB.php.

References ilDBConstants\FETCHMODE_ASSOC.

Referenced by assLongMenu\calculateReachedPoints(), assLongMenu\getCorrectAnswersForGap(), assLongMenu\getCorrectAnswersForQuestionSolution(), assLongMenu\getPointsForGap(), ilDBMySQL\isFulltextIndex(), assLongMenu\loadCorrectAnswerData(), assLongMenu\loadFromDb(), and ilTestArchiver\updateTestArchive().

    {
        return $a_set->fetchRow(ilDBConstants::FETCHMODE_ASSOC);
    }

Here is the caller graph for this function:

fetchObject()

ilDB::fetchObject

(

$a_set

)

Fetch row as object from result set.

Parameters

object

result set

Implements ilDBInterface.

Definition at line 1742 of file class.ilDB.php.

References ilDBConstants\FETCHMODE_OBJECT.

    {
        return $a_set->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
    }

free()

ilDB::free

(

$a_st

)

Free a statement / result set.

Implements ilDBInterface.

Definition at line 1732 of file class.ilDB.php.

Referenced by insert(), replace(), and update().

    {
        return $a_st->free();
    }

Here is the caller graph for this function:

fromUnixtime()

ilDB::fromUnixtime	(		$a_expr,
			$a_to_text = true
	)

fromUnixtime (makes timestamp out of unix timestamp)

Parameters

string	expression
boolean	typecasting to text y/n

Definition at line 1980 of file class.ilDB.php.

    {
        return "FROM_UNIXTIME(" . $a_expr . ")";
    }

getAllowedAttributes()

ilDB::getAllowedAttributes

(

)

Returns

array

Implements ilDBInterface.

Definition at line 1296 of file class.ilDB.php.

References $allowed_attributes.

    {
        return $this->allowed_attributes;
    }

getCreateTableOptions()

ilDB::getCreateTableOptions ( )

protected

Get options for the create table statement.

Returns

array

Definition at line 557 of file class.ilDB.php.

References array.

Referenced by createTable().

    {
        return array();
    }

Here is the caller graph for this function:

getDBHost()

ilDB::getDBHost

(

)

Get database host.

Parameters

string

database host

Definition at line 123 of file class.ilDB.php.

Referenced by ilDBOracle\getDSN(), ilDBPostgreSQL\getDSN(), and ilDBMySQL\getDSN().

    {
        return $this->db_host;
    }

Here is the caller graph for this function:

getDBName()

ilDB::getDBName

(

)

Get database name.

Parameters

string

database name

Definition at line 163 of file class.ilDB.php.

References getDSN().

Referenced by ilDBOracle\getDSN(), ilDBPostgreSQL\getDSN(), and ilDBMySQL\getDSN().

    {
        return $this->db_name;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDBPassword()

ilDB::getDBPassword

(

)

Get database password.

Parameters

string

database password

Definition at line 143 of file class.ilDB.php.

Referenced by ilDBOracle\getDSN(), ilDBPostgreSQL\getDSN(), ilDBMySQL\getDSN(), and ilDBMySQL\getHostDSN().

    {
        return $this->db_password;
    }

Here is the caller graph for this function:

getDBPort()

ilDB::getDBPort

(

)

Get database port.

Parameters

string

database port

Definition at line 103 of file class.ilDB.php.

Referenced by ilDBOracle\getDSN(), and ilDBMySQL\getDSN().

    {
        return $this->db_port;
    }

Here is the caller graph for this function:

getDBType()

ilDB::getDBType ( )

abstract

Get DSN.

This must be overwritten in DBMS specific class.

Implements ilDBInterface.

Referenced by dropTable(), and getDBVersion().

Here is the caller graph for this function:

getDBUser()

ilDB::getDBUser

(

)

Get database user.

Parameters

string

database user

Definition at line 83 of file class.ilDB.php.

Referenced by ilDBOracle\getDSN(), ilDBPostgreSQL\getDSN(), ilDBMySQL\getDSN(), and ilDBMySQL\getHostDSN().

    {
        return $this->db_user;
    }

Here is the caller graph for this function:

getDBVersion()

ilDB::getDBVersion

(

)

Get DB version.

Definition at line 176 of file class.ilDB.php.

References getDBType().

    {
        return "Unknown";
    }

Here is the call graph for this function:

getDSN()

ilDB::getDSN ( )

abstract

Get DSN.

This must be overwritten in DBMS specific class.

Implements ilDBInterface.

Referenced by connect(), doConnect(), and getDBName().

Here is the caller graph for this function:

getHostDSN()

ilDB::getHostDSN

(

)

Should return a valid value, if host connections are possible (connectHost) to create a new database from scratch.

Returns

string host dsn (similar to dsn WITHOUT a specific database name)

Definition at line 303 of file class.ilDB.php.

Referenced by connectHost().

    {
        return false;
    }

Here is the caller graph for this function:

getLastInsertId()

ilDB::getLastInsertId

(

)

Get last insert id.

Definition at line 2249 of file class.ilDB.php.

References $res, and MDB2\isError().

    {
        $res = $this->db->lastInsertId();
        if (MDB2::isError($res)) {
            return false;
        }
        return $res;
    }

Here is the call graph for this function:

getOne()

ilDB::getOne

(

$sql

)

getOne.

DEPRECATED. Should not be used anymore.

this is the wrapper itself. Runs a query and returns the first column of the first row or in case of an error, jump to errorpage

Parameters

string

Returns

object DB

Definition at line 2267 of file class.ilDB.php.

References $r, ilDBConstants\FETCHMODE_ASSOC, handleError(), and MDB2\isError().

    {
        //$r = $this->db->getOne($sql);
        $set = $this->db->query($sql);
        
        $this->handleError($set, "getOne(" . $sql . ")");
        
        if (!MDB2::isError($set)) {
            $r = $set->fetchRow(ilDBConstants::FETCHMODE_ASSOC);
    
            return $r[0];
        }
    }

Here is the call graph for this function:

getPrimaryKeyIdentifier()

ilDB::getPrimaryKeyIdentifier

(

)

Primary key identifier.

Implements ilDBInterface.

Definition at line 863 of file class.ilDB.php.

Referenced by addPrimaryKey(), and dropPrimaryKey().

    {
        return "PRIMARY";
    }

Here is the caller graph for this function:

getReservedWords()

static ilDB::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.

Implements ilDBInterface.

Definition at line 192 of file class.ilDB.php.

References array.

    {
        return array();
    }

getRow()

ilDB::getRow	(		$sql,
			$mode = ilDBConstants::FETCHMODE_OBJECT
	)

getRow.

DEPRECATED. Should not be used anymore

this is the wrapper itself. query a string, and return the resultobject, or in case of an error, jump to errorpage

Parameters

string

Returns

object DB

Definition at line 2290 of file class.ilDB.php.

References $data, $r, array, ilDBInterface\fetchAll(), ilDBConstants\FETCHMODE_ASSOC, handleError(), and query().

    {
        $set = $this->query($sql);
        $r = $set->fetchRow($mode);
        //$r = $this->db->getrow($sql,$mode);

        $this->handleError($r, "getRow(" . $sql . ")");
        
        return $r;
    } //end function

Here is the call graph for this function:

getSequenceName()

ilDB::getSequenceName

(

$table_name

)

Parameters

$table_name

Returns

string

Implements ilDBInterface.

Definition at line 2364 of file class.ilDB.php.

    {
        return $this->db->getSequenceName($table_name);
    }

getSubType()

ilDB::getSubType

(

)

Get sub type.

Returns

string

Definition at line 2334 of file class.ilDB.php.

References $sub_type.

Referenced by ilDBMySQL\isMySQLi().

    {
        return $this->sub_type;
    }

Here is the caller graph for this function:

handleError()

ilDB::handleError	(		$a_res,
			$a_info = "",
			$a_level = ""
	)

Handle MDB2 Errors.

Parameters

mixed

result set or anything that is a MDB2::error if something went wrong

Definition at line 423 of file class.ilDB.php.

References $ilLog, and MDB2\isError().

Referenced by addPrimaryKey(), addTableColumn(), addUniqueConstraint(), alterTable(), autoExecute(), beginTransaction(), commit(), connect(), connectHost(), createSequence(), createTable(), dropIndex(), ilDBOracle\dropPrimaryKey(), dropPrimaryKey(), dropSequence(), dropTable(), dropTableColumn(), dropUniqueConstraint(), execute(), executeMultiple(), getOne(), getRow(), insert(), manipulate(), modifyTableColumn(), nextId(), prepare(), prepareManip(), ilDBMySQL\query(), query(), renameTable(), renameTableColumn(), ilDBPostgreSQL\replace(), ilDBOracle\replace(), replace(), rollback(), and update().

    {
        global $ilLog;

        if (MDB2::isError($a_res)) {
            if ($a_level == "") {
                $a_level = $this->error_class->FATAL;
            }

            // :TODO: ADT (jluetzen)

            // if(!$this->exception)
            if (true) {
                // Show stack
                try {
                    throw new Exception();
                } catch (Exception $e) {
                    $stack = $e->getTraceAsString();
                }

                if (is_object($ilLog)) {
                    $ilLog->logStack();
                }
                //                              $this->raisePearError("ilDB Error: " . $a_info . "<br />" . $a_res->getMessage() . "<br />" . $a_res->getUserInfo() . "<br />"
                //                                                    . $stack, $a_level);

                throw new ilDatabaseException("ilDB Error: " . $a_info . "<br />" . $a_res->getMessage() . "<br />" . $a_res->getUserInfo() . "<br />"
                                              . $stack, $a_level);
            }
        }

        return $a_res;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

in()

ilDB::in	(		$a_field,
			$a_values,
			$negate = false,
			$a_type = ""
	)

Get abstract in-clause for given array.

Returns an array "field_name IN (?,?,?,...)" depending on the size of the array

Example: $ids = array(10,12,18); $st = $ilDB->prepare("SELECT * FROM table ". "WHERE ".$ilDB->in("id", $ids), $ilDB->addTypesToArray($types, "integer", count($ids))); $set = $ilDB->execute($st, $ids);

Implements ilDBInterface.

Definition at line 1772 of file class.ilDB.php.

References $a_type, and quote().

    {
        if (count($a_values) == 0) {
            // BEGIN fixed mantis #0014191:
            //return " 1=2 ";           // return a false statement on empty array
            return $negate ? ' 1=1 ' : ' 1=2 ';
            // END fixed mantis #0014191:
        }
        if ($a_type == "") {            // untyped: used ? for prepare/execute
            $str = $a_field . (($negate) ? " NOT" : "") . " IN (?" . str_repeat(",?", count($a_values) - 1) . ")";
        } else {                                        // typed, use values for query/manipulate
            $str = $a_field . (($negate) ? " NOT" : "") . " IN (";
            $sep = "";
            foreach ($a_values as $v) {
                $str.= $sep . $this->quote($v, $a_type);
                $sep = ",";
            }
            $str.= ")";
        }

        return $str;
    }

Here is the call graph for this function:

indexExistsByFields()

ilDB::indexExistsByFields	(		$a_table,
			$a_fields
	)

Check if index exists.

Parameters

type	$a_table
type	$a_fields

Implements ilDBInterface.

Definition at line 948 of file class.ilDB.php.

References $def, and array.

    {
        $manager = $this->db->loadModule('Manager');
        $reverse = $this->db->loadModule('Reverse');
        if ($manager) {
            foreach ($manager->listTableIndexes($a_table) as $idx_name) {
                $def = $reverse->getTableIndexDefinition($a_table, $idx_name);
                $idx_fields = array_keys((array) $def['fields']);
                
                if ($idx_fields === $a_fields) {
                    return true;
                }
            }
        }
        return false;
    }

initConnection()

ilDB::initConnection ( )

protected

Initialize the database connection.

Definition at line 293 of file class.ilDB.php.

Referenced by connect().

    {
    }

Here is the caller graph for this function:

initFromIniFile()

ilDB::initFromIniFile

(

$tmpClientIniFile = null

)

Init db parameters from ini file.

Parameters

$tmpClientIniFile

overwrite global client ini file if is set to an object

Implements ilDBInterface.

Definition at line 211 of file class.ilDB.php.

References setDBHost(), setDBName(), setDBPassword(), setDBPort(), and setDBUser().

    {
        global $ilClientIniFile;
        
        //overwrite global client ini file if local parameter is set
        if (is_object($tmpClientIniFile)) {
            $clientIniFile = $tmpClientIniFile;
        } else {
            $clientIniFile = $ilClientIniFile;
        }
            
        if (is_object($clientIniFile)) {
            $this->setDBUser($clientIniFile ->readVariable("db", "user"));
            $this->setDBHost($clientIniFile ->readVariable("db", "host"));
            $this->setDBPort($clientIniFile ->readVariable("db", "port"));
            $this->setDBPassword($clientIniFile ->readVariable("db", "pass"));
            $this->setDBName($clientIniFile ->readVariable("db", "name"));
        }
    }

Here is the call graph for this function:

initHostConnection()

ilDB::initHostConnection ( )

protected

Initialize the host connection (no specific database)

Definition at line 355 of file class.ilDB.php.

Referenced by connectHost().

    {
    }

Here is the caller graph for this function:

insert()

ilDB::insert	(		$a_table,
			$a_columns
	)

Convenient method for standard insert statements, example field array:

array("field1" => array("text", $name), "field2" => array("integer", $id))

Implements ilDBInterface.

Definition at line 1541 of file class.ilDB.php.

References $r, array, free(), handleError(), manipulateF(), and MDB2_PREPARE_MANIP.

Referenced by ilDBPostgreSQL\replace(), and ilDBOracle\replace().

    {
        $fields = array();
        $field_values = array();
        $placeholders = array();
        $types = array();
        $values = array();
        $lobs = false;
        $lob = array();
        foreach ($a_columns as $k => $col) {
            $fields[] = $k;
            $placeholders[] = "%s";
            $placeholders2[] = ":$k";
            $types[] = $col[0];
            
            // integer auto-typecast (this casts bool values to integer)
            if ($col[0] == 'integer' && !is_null($col[1])) {
                $col[1] = (int) $col[1];
            }
            
            $values[] = $col[1];
            $field_values[$k] = $col[1];
            if ($col[0] == "blob" || $col[0] == "clob") {
                $lobs = true;
                $lob[$k] = $k;
            }
        }
        if ($lobs) {    // lobs -> use prepare execute (autoexecute broken in PEAR 2.4.1)
            $st = $this->db->prepare("INSERT INTO " . $a_table . " (" . implode($fields, ",") . ") VALUES (" .
                implode($placeholders2, ",") . ")", $types, MDB2_PREPARE_MANIP, $lob);
            
            $this->handleError($st, "insert / prepare/execute(" . $a_table . ")");
            
            $r = $st->execute($field_values);
            
            
            //$r = $this->db->extended->autoExecute($a_table, $field_values, MDB2_AUTOQUERY_INSERT, null, $types);
            $this->handleError($r, "insert / prepare/execute(" . $a_table . ")");
            $this->free($st);
        } else {        // if no lobs are used, take simple manipulateF
            $q = "INSERT INTO " . $a_table . " (" . implode($fields, ",") . ") VALUES (" .
                implode($placeholders, ",") . ")";
            $r = $this->manipulateF($q, $types, $values);
        }
        return $r;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isDbError()

static ilDB::isDbError (   $a_res )

static

Check error.

Definition at line 488 of file class.ilDB.php.

References MDB2\isError().

Referenced by connect(), connectHost(), and loadMDB2Extensions().

    {
        return MDB2::isError($a_res);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isFulltextIndex()

ilDB::isFulltextIndex	(		$a_table,
			$a_name
	)

Is index a fulltext index?

Implements ilDBInterface.

Definition at line 937 of file class.ilDB.php.

Referenced by dropIndex().

    {
        return false;
    }

Here is the caller graph for this function:

isReservedWord()

static ilDB::isReservedWord (   $a_word )

static

Checks whether a word is a reserved word in one of the supported databases.

Implements ilDBInterface.

Definition at line 1315 of file class.ilDB.php.

References $DIC.

Referenced by checkColumnName(), checkIndexName(), checkTableName(), and ilDatabaseReservedWordsTest\testReservedMDB2().

    {
        require_once('./Services/Database/classes/PDO/FieldDefinition/class.ilDBPdoMySQLFieldDefinition.php');
        global $DIC;
        $ilDBPdoMySQLFieldDefinition = new ilDBPdoMySQLFieldDefinition($DIC['ilDB']);

        return $ilDBPdoMySQLFieldDefinition->isReserved($a_word);
    }

Here is the caller graph for this function:

like()

ilDB::like	(		$a_col,
			$a_type,
			$a_value = "?",
			$case_insensitive = true
	)

Like.

Parameters

string

column type; must be "text" or "clob" ("blob" added for lng_data)

Implements ilDBInterface.

Definition at line 1923 of file class.ilDB.php.

References $a_type, array, quote(), and raisePearError().

    {
        if (!in_array($a_type, array("text", "clob", "blob"))) {
            $this->raisePearError("Like: Invalid column type '" . $a_type . "'.", $this->error_class->FATAL);
        }
        if ($a_value == "?") {
            if ($case_insensitive) {
                return "UPPER(" . $a_col . ") LIKE(UPPER(?))";
            } else {
                return $a_col . " LIKE(?)";
            }
        } else {
            if ($case_insensitive) {
                // Always quote as text
                return " UPPER(" . $a_col . ") LIKE(UPPER(" . $this->quote($a_value, 'text') . "))";
            } else {
                // Always quote as text
                return " " . $a_col . " LIKE(" . $this->quote($a_value, 'text') . ")";
            }
        }
    }

Here is the call graph for this function:

listSequences()

ilDB::listSequences

(

)

Get all sequences.

Returns

array Array of sequence names

Implements ilDBInterface.

Definition at line 2113 of file class.ilDB.php.

References $r, and MDB2\isError().

Referenced by sequenceExists().

    {
        $manager = $this->db->loadModule('Manager');
        $r = $manager->listSequences();

        if (!MDB2::isError($r)) {
            return $r;
        }
        
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

listTables()

ilDB::listTables

(

)

Get all tables.

Returns

array Array of table names

Implements ilDBInterface.

Definition at line 2078 of file class.ilDB.php.

References $r, and MDB2\isError().

Referenced by dropTable(), and tableExists().

    {
        $manager = $this->db->loadModule('Manager');
        $r = $manager->listTables();

        if (!MDB2::isError($r)) {
            return $r;
        }
        
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

loadMDB2Extensions()

ilDB::loadMDB2Extensions ( )

protected

load additional mdb2 extensions and set their constants

protected

Definition at line 474 of file class.ilDB.php.

References isDbError(), MDB2_AUTOQUERY_DELETE, MDB2_AUTOQUERY_INSERT, MDB2_AUTOQUERY_SELECT, and MDB2_AUTOQUERY_UPDATE.

Referenced by connect(), and connectHost().

    {
        if (!$this->isDbError($this->db)) {
            $this->db->loadModule('Extended');
            define('DB_AUTOQUERY_SELECT', MDB2_AUTOQUERY_SELECT);
            define('DB_AUTOQUERY_INSERT', MDB2_AUTOQUERY_INSERT);
            define('DB_AUTOQUERY_UPDATE', MDB2_AUTOQUERY_UPDATE);
            define('DB_AUTOQUERY_DELETE', MDB2_AUTOQUERY_DELETE);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

locate()

ilDB::locate	(		$a_needle,
			$a_string,
			$a_start_pos = 1
	)

Create locate string.

Parameters

string	$a_needle
string	$a_string
int	$a_start_pos	[optional]

Returns

Implements ilDBInterface.

Definition at line 1905 of file class.ilDB.php.

    {
        $locate = ' LOCATE( ';
        $locate .= $a_needle;
        $locate .= ',';
        $locate .= $a_string;
        $locate .= ',';
        $locate .= $a_start_pos;
        $locate .= ') ';
        return $locate;
    }

lockTables()

ilDB::lockTables (   $a_tables )

abstract

Abstraction of lock table.

Parameters

array

table definitions

Deprecated:

Use ilAtomQuery instead

Returns

Implements ilDBInterface.

Referenced by rollback().

Here is the caller graph for this function:

logStatement()

ilDB::logStatement

(

$sql

)

Helper function, should usually not be called.

Definition at line 1405 of file class.ilDB.php.

References $table, and substr().

    {
        $pos1 = strpos(strtolower($sql), "from ");
        $table = "";
        if ($pos1 > 0) {
            $tablef = substr($sql, $pos1+5);
            $pos2 = strpos(strtolower($tablef), " ");
            if ($pos2 > 0) {
                $table =substr($tablef, 0, $pos2);
            } else {
                $table = $tablef;
            }
        }
        if (trim($table) != "") {
            if (!is_array($this->ttt) || !in_array($table, $this->ttt)) {
                echo "<br>" . $table;
                $this->ttt[] = $table;
            }
        } else {
            echo "<br><b>" . $sql . "</b>";
        }
    }

Here is the call graph for this function:

lower()

ilDB::lower

(

$a_exp

)

Upper.

Parameters

string

expression

Returns

string upper sql string

Implements ilDBInterface.

Definition at line 1893 of file class.ilDB.php.

    {
        return " LOWER(" . $a_exp . ") ";
    }

manipulate()

ilDB::manipulate

(

$sql

)

Data manipulation.

This statement should be used for DELETE, UPDATE and INSERT statements.

Example:

• "DELETE * FROM data WHERE id =".$ilDB->quote($id, "integer");

Parameters

string

DML string

Returns

int affected rows

Implements ilDBInterface.

Definition at line 1459 of file class.ilDB.php.

References $ilBench, $r, and handleError().

Referenced by manipulateF(), ilDBPostgreSQL\replace(), and ilDBOracle\replace().

    {
        global $ilBench;

        if (is_object($ilBench)) {
            $ilBench->startDbBench($sql);
        }
        $r = $this->db->exec($sql);
        if (is_object($ilBench)) {
            $ilBench->stopDbBench();
        }

        return $this->handleError($r, "manipulate(" . $sql . ")");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

manipulateF()

ilDB::manipulateF	(		$a_query,
			$a_types,
			$a_values
	)

Formatted manupulate (for DELETE, UPDATE, INSERT).

Use s as placeholder!

Parameters

string	query
array	type array
arraay	value array

Implements ilDBInterface.

Definition at line 1387 of file class.ilDB.php.

References $query, $t, array, manipulate(), quote(), and raisePearError().

Referenced by assLongMenu\clearAnswerSpecificDataFromDb(), insert(), replace(), assLongMenu\saveAdditionalQuestionDataToDb(), and update().

    {
        if (!is_array($a_types) || !is_array($a_values) ||
            count($a_types) != count($a_values)) {
            $this->raisePearError("ilDB::manipulateF: types and values must be arrays of same size. ($a_query)");
        }
        $quoted_values = array();
        foreach ($a_types as $k => $t) {
            $quoted_values[] = $this->quote($a_values[$k], $t);
        }
        $query = vsprintf($a_query, $quoted_values);
        
        return $this->manipulate($query);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

migrateAllTablesToEngine()

ilDB::migrateAllTablesToEngine

(

$engine = ilDBConstants::MYSQL_ENGINE_INNODB

)

Parameters

string

$engine

Returns

array

Definition at line 2345 of file class.ilDB.php.

References array.

    {
        return array();
    }

modifyTableColumn()

ilDB::modifyTableColumn	(		$a_table,
			$a_column,
			$a_attributes
	)

Modify a table column Use this only on aleady "abstracted" tables.

Parameters

string	table name
string	column name
array	attributes to be changed, e.g. array("length" => 10, "default" => "t")

Implements ilDBInterface.

Definition at line 691 of file class.ilDB.php.

References $def, $r, $type, array, checkColumnDefinition(), handleError(), and raisePearError().

    {
        $manager = $this->db->loadModule('Manager');
        $reverse = $this->db->loadModule('Reverse');
        $def = $reverse->getTableFieldDefinition($a_table, $a_column);
        
        $this->handleError($def, "modifyTableColumn(" . $a_table . ")");

        if (is_file("./Services/Database/classes/class.ilDBAnalyzer.php")) {
            include_once("./Services/Database/classes/class.ilDBAnalyzer.php");
        } else {
            include_once("../Services/Database/classes/class.ilDBAnalyzer.php");
        }
        $analyzer = new ilDBAnalyzer();
        $best_alt = $analyzer->getBestDefinitionAlternative($def);
        $def = $def[$best_alt];
        unset($def["nativetype"]);
        unset($def["mdb2type"]);

        // check attributes
        $type = ($a_attributes["type"] != "")
            ? $a_attributes["type"]
            : $def["type"];
        foreach ($def as $k => $v) {
            if ($k != "type" && !in_array($k, $this->allowed_attributes[$type])) {
                unset($def[$k]);
            }
        }
        $check_array = $def;
        foreach ($a_attributes as $k => $v) {
            $check_array[$k] = $v;
        }
        if (!$this->checkColumnDefinition($check_array, true)) {
            $this->raisePearError("ilDB Error: modifyTableColumn(" . $a_table . ", " . $a_column . ")<br />" .
                $this->error_str);
        }

        // oracle workaround: do not set null, if null already given
        if ($this->getDbType() == "oracle") {
            if ($def["notnull"] == true && ($a_attributes["notnull"] == true
                || !isset($a_attributes["notnull"]))) {
                unset($def["notnull"]);
                unset($a_attributes["notnull"]);
            }
            if ($def["notnull"] == false && ($a_attributes["notnull"] == false
                || !isset($a_attributes["notnull"]))) {
                unset($def["notnull"]);
                unset($a_attributes["notnull"]);
            }
        }
        foreach ($a_attributes as $a => $v) {
            $def[$a] = $v;
        }
        
        $a_attributes["definition"] = $def;
        
        $changes = array(
            "change" => array(
                $a_column => $a_attributes
                )
            );

        $r = $manager->alterTable($a_table, $changes, false);

        return $this->handleError($r, "modifyTableColumn(" . $a_table . ")");
    }

Here is the call graph for this function:

nextId()

ilDB::nextId

(

$a_table_name

)

Get next ID for an index.

Implements ilDBInterface.

Definition at line 1439 of file class.ilDB.php.

References $r, and handleError().

    {
        // we do not create missing sequences automatically here
        // otherwise misspelled statements result in additional tables
        // please create sequences explicitly in the db update script
        $r = $this->db->nextId($a_table_name, false);

        return $this->handleError($r, "nextId(" . $a_table_name . ")");
    }

Here is the call graph for this function:

now()

ilDB::now

(

)

now()

Implements ilDBInterface.

Definition at line 1815 of file class.ilDB.php.

    {
        return "now()";
    }

numRows()

ilDB::numRows

(

$a_set

)

Fetch row as associative array from result set.

Parameters

object

result set

Implements ilDBInterface.

Definition at line 1752 of file class.ilDB.php.

    {
        return $a_set->numRows();
    }

prepare()

ilDB::prepare	(		$a_query,
			$a_types = null,
			$a_result_types = null
	)

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

Parameters

String	Query String
Array	Placeholder Types

Returns

Resource handle for the prepared query on success, a MDB2 error on failure.

Implements ilDBInterface.

Definition at line 1482 of file class.ilDB.php.

References $res, and handleError().

    {
        $res = $this->db->prepare($a_query, $a_types, $a_result_types);
        
        return $this->handleError($res, "prepare(" . $a_query . ")");
    }

Here is the call graph for this function:

prepareManip()

ilDB::prepareManip	(		$a_query,
			$a_types = null
	)

Prepare a data manipulation statement to be used with execute.

Parameters

String	Query String
Array	Placeholder Types

Returns

Resource handle for the prepared query on success, a MDB2 error on failure.

Implements ilDBInterface.

Definition at line 1497 of file class.ilDB.php.

References $res, handleError(), and MDB2_PREPARE_MANIP.

    {
        $res = $this->db->prepare($a_query, $a_types, MDB2_PREPARE_MANIP);
        
        return $this->handleError($res, "prepareManip(" . $a_query . ")");
    }

Here is the call graph for this function:

query()

ilDB::query	(		$sql,
			$a_handle_error = true
	)

Query.

Example:

• "SELECT * FROM data"

For multiple similar queries/manipulations you may use prepare() and execute().

Parameters

string

Returns

ilPDOStatement DB

Definition at line 1339 of file class.ilDB.php.

References $ilBench, $r, and handleError().

Referenced by ilCourseArchives\__read(), ilRbacSystem\checkAccessOfUser(), createDatabase(), ilRbacReview\getOperation(), ilRbacReview\getOperations(), ilRbacReview\getOperationsOnTypeString(), getRow(), ilDBOracle\initConnection(), ilRbacReview\isDeleted(), ilRbacSystem\preloadRbacPaCache(), queryF(), ilParticipants\readSubscriberData(), ilParticipants\readSubscribers(), ilRbacReview\roleExists(), and ilTestArchiver\updateTestArchive().

    {
        global $ilBench;

        if (is_object($ilBench)) {
            $ilBench->startDbBench($sql);
        }
        $r = $this->db->query($sql);
        if (is_object($ilBench)) {
            $ilBench->stopDbBench();
        }
        
        if ($a_handle_error) {
            return $this->handleError($r, "query(" . $sql . ")");
        }

        return $r;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

queryF()

ilDB::queryF	(		$a_query,
			$a_types,
			$a_values
	)

Formatted query (for SELECTS).

Use s as placeholder!

Parameters

string	query
array	type array
arraay	value array

Implements ilDBInterface.

Definition at line 1365 of file class.ilDB.php.

References $query, $t, array, query(), quote(), and raisePearError().

Referenced by assLongMenu\loadFromDb().

    {
        if (!is_array($a_types) || !is_array($a_values) ||
            count($a_types) != count($a_values)) {
            $this->raisePearError("ilDB::queryF: Types and values must be arrays of same size. ($a_query)");
        }
        $quoted_values = array();
        foreach ($a_types as $k => $t) {
            $quoted_values[] = $this->quote($a_values[$k], $t);
        }
        $query = vsprintf($a_query, $quoted_values);
        
        return $this->query($query);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

quote()

ilDB::quote	(		$a_query,
			$a_type = null
	)

Wrapper for quote method.

Implements ilDBInterface.

Definition at line 2133 of file class.ilDB.php.

References $a_type, and raisePearError().

Referenced by equals(), equalsNot(), ilRbacReview\getAssignableChildRoles(), ilTree\getNodeDataByType(), ilTree\getPathFull(), ilDBPostgreSQL\groupConcat(), ilDBMySQL\groupConcat(), in(), ilDBOracle\like(), like(), manipulateF(), queryF(), ilDBPostgreSQL\replace(), ilDBOracle\replace(), update(), and ilTestArchiver\updateTestArchive().

    {
        if ($a_query == "" && is_null($a_type)) {
            $a_query = "";
        }
        
        // Performance fix
        if ($a_type == 'integer' && !is_null($a_query)) {
            return (int) $a_query;
        }
        
        if ($a_type == "blob" || $a_type == "clob") {
            $this->raisePearError("ilDB::quote: Quoting not allowed on type '" . $a_type . "'. Please use ilDB->insert and ilDB->update to write clobs.", $this->error_class->FATAL);
        }

        return $this->db->quote($a_query, $a_type);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

quoteIdentifier()

ilDB::quoteIdentifier	(		$a_identifier,
			$check_option = false
	)

Quote table and field names.

Note: IF POSSIBLE, THIS METHOD SHOULD NOT BE USED. Rename your table or field, if it conflicts with a reserved word.

Implements ilDBInterface.

Definition at line 2158 of file class.ilDB.php.

    {
        return $this->db->quoteIdentifier($a_identifier);
    }

raisePearError()

ilDB::raisePearError	(		$a_message,
			$a_level = ""
	)

Raise an error.

Definition at line 460 of file class.ilDB.php.

References PEAR\raiseError().

Referenced by addTableColumn(), addUniqueConstraint(), beginTransaction(), connect(), connectHost(), createTable(), dropPrimaryKey(), ilDBOracle\like(), like(), manipulateF(), modifyTableColumn(), queryF(), quote(), renameTable(), and renameTableColumn().

    {
        if ($a_level == "") {
            $a_level = $this->error_class->FATAL;
        }
        //echo "<br>-ilDB:raising-$a_message-$a_level-";
        $this->raiseError($a_message, $a_level);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renameTable()

ilDB::renameTable	(		$a_name,
			$a_new_name
	)

Rename a table.

Parameters

string	old table name
string	new table name

Implements ilDBInterface.

Definition at line 812 of file class.ilDB.php.

References $r, array, checkTableName(), handleError(), and raisePearError().

    {
        // check table name
        if (!$this->checkTableName($a_new_name)) {
            $this->raisePearError("ilDB Error: renameTable(" . $a_name . "," . $a_new_name . ")<br />" .
                $this->error_str);
        }

        $manager = $this->db->loadModule('Manager');
        $r = $manager->alterTable($a_name, array("name" => $a_new_name), false);
        
        // The abstraction_progress is no longer used in ILIAS, see http://www.ilias.de/mantis/view.php?id=19513
        //              $query = "UPDATE abstraction_progress ".
        //                      "SET table_name = ".$this->db->quote($a_new_name,'text')." ".
        //                      "WHERE table_name = ".$this->db->quote($a_name,'text');
        //              $this->db->query($query);

        return $this->handleError($r, "renameTable(" . $a_name . "," . $a_new_name . ")");
    }

Here is the call graph for this function:

renameTableColumn()

ilDB::renameTableColumn	(		$a_table,
			$a_column,
			$a_new_column
	)

Rename a table column Use this only on aleady "abstracted" tables.

Parameters

string	table name
string	old column name
string	new column name

Implements ilDBInterface.

Definition at line 766 of file class.ilDB.php.

References $def, $r, array, checkColumnName(), handleError(), and raisePearError().

    {
        // check table name
        if (!$this->checkColumnName($a_new_column)) {
            $this->raisePearError("ilDB Error: renameTableColumn(" . $a_table . "," . $a_column . "," . $a_new_column . ")<br />" .
                $this->error_str);
        }

        $manager = $this->db->loadModule('Manager');
        $reverse = $this->db->loadModule('Reverse');
        $def = $reverse->getTableFieldDefinition($a_table, $a_column);
        
        $this->handleError($def, "renameTableColumn(" . $a_table . "," . $a_column . "," . $a_new_column . ")");

        if (is_file("./Services/Database/classes/class.ilDBAnalyzer.php")) {
            include_once("./Services/Database/classes/class.ilDBAnalyzer.php");
        } else {
            include_once("../Services/Database/classes/class.ilDBAnalyzer.php");
        }

        $analyzer = new ilDBAnalyzer();
        $best_alt = $analyzer->getBestDefinitionAlternative($def);
        $def = $def[$best_alt];
        unset($def["nativetype"]);
        unset($def["mdb2type"]);
        
        $f["definition"] = $def;
        $f["name"] = $a_new_column;
        
        $changes = array(
            "rename" => array(
                $a_column => $f
                )
            );

        $r = $manager->alterTable($a_table, $changes, false);

        return $this->handleError($r, "renameTableColumn(" . $a_table . "," . $a_column . "," . $a_new_column . ")");
    }

Here is the call graph for this function:

replace()

ilDB::replace	(		$a_table,
			$a_pk_columns,
			$a_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" => ...)

Implements ilDBInterface.

Definition at line 1674 of file class.ilDB.php.

References $r, array, free(), handleError(), manipulateF(), and MDB2_PREPARE_MANIP.

    {
        // this is the mysql implementation
        $a_columns = array_merge($a_pk_columns, $a_other_columns);
        $fields = array();
        $field_values = array();
        $placeholders = array();
        $types = array();
        $values = array();
        $lobs = false;
        $lob = array();
        foreach ($a_columns as $k => $col) {
            $fields[] = $k;
            $placeholders[] = "%s";
            $placeholders2[] = ":$k";
            $types[] = $col[0];
            
            // integer auto-typecast (this casts bool values to integer)
            if ($col[0] == 'integer' && !is_null($col[1])) {
                $col[1] = (int) $col[1];
            }
            
            $values[] = $col[1];
            $field_values[$k] = $col[1];
            if ($col[0] == "blob" || $col[0] == "clob") {
                $lobs = true;
                $lob[$k] = $k;
            }
        }
        if ($lobs) {    // lobs -> use prepare execute (autoexecute broken in PEAR 2.4.1)
            $st = $this->db->prepare("REPLACE INTO " . $a_table . " (" . implode($fields, ",") . ") VALUES (" .
                implode($placeholders2, ",") . ")", $types, MDB2_PREPARE_MANIP, $lob);
            $this->handleError($st, "insert / prepare/execute(" . $a_table . ")");
            $r = $st->execute($field_values);
            //$r = $this->db->extended->autoExecute($a_table, $field_values, MDB2_AUTOQUERY_INSERT, null, $types);
            $this->handleError($r, "insert / prepare/execute(" . $a_table . ")");
            $this->free($st);
        } else {        // if no lobs are used, take simple manipulateF
            $q = "REPLACE INTO " . $a_table . " (" . implode($fields, ",") . ") VALUES (" .
                implode($placeholders, ",") . ")";
            $r = $this->manipulateF($q, $types, $values);
        }
        return $r;
    }

Here is the call graph for this function:

rollback()

ilDB::rollback

(

)

Rollback a transaction.

Implements ilDBInterface.

Definition at line 2196 of file class.ilDB.php.

References $res, handleError(), lockTables(), and unlockTables().

    {
        $res = $this->db->rollback();
        
        return $this->handleError($res, "rollback()");
    }

Here is the call graph for this function:

sanitizeMB4StringIfNotSupported()

ilDB::sanitizeMB4StringIfNotSupported

(

$query

)

Parameters

$query

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

Returns

string sanitized query

Implements ilDBInterface.

Definition at line 2384 of file class.ilDB.php.

References $query, doesCollationSupportMB4Strings(), and ilDBConstants\MB4_REPLACEMENT.

    {
        if (!$this->doesCollationSupportMB4Strings()) {
            $query_replaced = preg_replace(
                '/[\x{10000}-\x{10FFFF}]/u',
                ilDBConstants::MB4_REPLACEMENT,
                $query
            );
            if (!empty($query_replaced)) {
                return $query_replaced;
            }
        }

        return $query;
    }

Here is the call graph for this function:

sequenceExists()

ilDB::sequenceExists

(

$a_sequence

)

Check, whether a given sequence exists.

Parameters

string

sequence name

Returns

boolean true, if sequence exists

Implements ilDBInterface.

Definition at line 2096 of file class.ilDB.php.

References listSequences().

    {
        $sequences = $this->listSequences();
        
        if (is_array($sequences)) {
            if (in_array($a_sequence, $sequences)) {
                return true;
            }
        }
        return false;
    }

Here is the call graph for this function:

setDBHost()

ilDB::setDBHost

(

$a_host

)

Set database host.

Parameters

string

database host

Implements ilDBInterface.

Definition at line 113 of file class.ilDB.php.

Referenced by initFromIniFile().

    {
        $this->db_host = $a_host;
    }

Here is the caller graph for this function:

setDBName()

ilDB::setDBName

(

$a_name

)

Set database name.

Parameters

string

database name

Definition at line 153 of file class.ilDB.php.

Referenced by initFromIniFile().

    {
        $this->db_name = $a_name;
    }

Here is the caller graph for this function:

setDBPassword()

ilDB::setDBPassword

(

$a_password

)

Set database password.

Parameters

string

database password

Implements ilDBInterface.

Definition at line 133 of file class.ilDB.php.

Referenced by initFromIniFile().

    {
        $this->db_password = $a_password;
    }

Here is the caller graph for this function:

setDBPort()

ilDB::setDBPort

(

$a_port

)

Set database port.

Parameters

string

database port

Implements ilDBInterface.

Definition at line 93 of file class.ilDB.php.

Referenced by initFromIniFile().

    {
        $this->db_port = $a_port;
    }

Here is the caller graph for this function:

setDBUser()

ilDB::setDBUser

(

$a_user

)

Set database user.

Parameters

string

database user

Implements ilDBInterface.

Definition at line 73 of file class.ilDB.php.

Referenced by initFromIniFile().

    {
        $this->db_user = $a_user;
    }

Here is the caller graph for this function:

setLimit()

ilDB::setLimit	(		$a_limit,
			$a_offset = 0
	)

Set limit and offset for a query.

Implements ilDBInterface.

Definition at line 1431 of file class.ilDB.php.

    {
        $this->db->setLimit($a_limit, $a_offset);
    }

setSubType()

ilDB::setSubType

(

$a_value

)

Set sub type.

Parameters

string

$a_value

Definition at line 2324 of file class.ilDB.php.

References string.

    {
        $this->sub_type = (string) $a_value;
    }

substr()

ilDB::substr	(		$a_exp,
			$a_pos = 1,
			$a_len = -1
	)

Substring.

Parameters

Definition at line 1867 of file class.ilDB.php.

Referenced by checkColumnName(), checkTableName(), dropTable(), logStatement(), and ilDBMySQL\setMaxAllowedPacket().

    {
        $lenstr = "";
        if ($a_len > -1) {
            $lenstr = ", " . $a_len;
        }
        return " SUBSTR(" . $a_exp . ", " . $a_pos . $lenstr . ") ";
    }

Here is the caller graph for this function:

supports()

ilDB::supports

(

$feature

)

Parameters

$feature

Returns

bool

Implements ilDBInterface.

Definition at line 379 of file class.ilDB.php.

References supportsFulltext(), supportsSlave(), and supportsTransactions().

    {
        switch ($feature) {
            case 'transaction':
                return $this->supportsTransactions();
            case 'fulltext':
                return $this->supportsFulltext();
            case 'slave':
                return $this->supportsSlave();
            default:
                return false;
        }
    }

Here is the call graph for this function:

supportsEngineMigration()

ilDB::supportsEngineMigration

(

)

Returns

bool

Definition at line 2354 of file class.ilDB.php.

    {
        return false;
    }

supportsFulltext()

ilDB::supportsFulltext

(

)

Returns

bool

Implements ilDBInterface.

Definition at line 359 of file class.ilDB.php.

Referenced by dropPrimaryKey(), and supports().

    {
        return false;
    }

Here is the caller graph for this function:

supportsSlave()

ilDB::supportsSlave

(

)

Supports slave.

Parameters

Implements ilDBInterface.

Definition at line 370 of file class.ilDB.php.

Referenced by supports(), and useSlave().

    {
        return false;
    }

Here is the caller graph for this function:

supportsTransactions()

ilDB::supportsTransactions

(

)

Returns

bool

Implements ilDBInterface.

Definition at line 397 of file class.ilDB.php.

Referenced by supports().

    {
        // we generally do not want ilDB to support transactions, only PDO-instances
        return false;
    }

Here is the caller graph for this function:

tableColumnExists()

ilDB::tableColumnExists	(		$a_table,
			$a_column_name
	)

Checks for the existence of a table column.

Parameters

string	$a_table	The table name which should be examined
string	$a_column_name	The name of the column

Returns

boolean TRUE if the table column exists, FALSE otherwise

Implements ilDBInterface.

Definition at line 2023 of file class.ilDB.php.

References $r, and MDB2\isError().

    {
        $column_visibility = false;
        $manager = $this->db->loadModule('Manager');
        $r = $manager->listTableFields($a_table);

        if (!MDB2::isError($r)) {
            foreach ($r as $field) {
                if ($field == $a_column_name) {
                    $column_visibility = true;
                }
            }
        }

        return $column_visibility;
    }

Here is the call graph for this function:

tableExists()

ilDB::tableExists

(

$a_table

)

Check, whether a given table exists.

Parameters

string

table name

Returns

boolean true, if table exists

Implements ilDBInterface.

Definition at line 2004 of file class.ilDB.php.

References listTables().

    {
        $tables = $this->listTables();

        if (is_array($tables)) {
            if (in_array($a_table, $tables)) {
                return true;
            }
        }
        return false;
    }

Here is the call graph for this function:

uniqueConstraintExists()

ilDB::uniqueConstraintExists	(		$a_table,
		array	$a_fields
	)

Checks if a unique constraint exists based on the fields of the unique constraint (not the name)

Parameters

string	$a_table	table name
array	$a_fields	array of field names (strings)

Returns

bool false if no unique constraint with the given fields exists

Definition at line 2047 of file class.ilDB.php.

    {
        if (is_file("./Services/Database/classes/class.ilDBAnalyzer.php")) {
            include_once("./Services/Database/classes/class.ilDBAnalyzer.php");
        } else {
            include_once("../Services/Database/classes/class.ilDBAnalyzer.php");
        }
        $analyzer = new ilDBAnalyzer();
        $cons = $analyzer->getConstraintsInformation($a_table);
        foreach ($cons as $c) {
            if ($c["type"] == "unique" && count($a_fields) == count($c["fields"])) {
                $all_in = true;
                foreach ($a_fields as $f) {
                    if (!isset($c["fields"][$f])) {
                        $all_in = false;
                    }
                }
                if ($all_in) {
                    return true;
                }
            }
        }
        return false;
    }

unixTimestamp()

ilDB::unixTimestamp

(

)

Unix timestamp.

Definition at line 1988 of file class.ilDB.php.

    {
        return "UNIX_TIMESTAMP()";
    }

unlockTables()

ilDB::unlockTables ( )

abstract

Unlock tables locked by previous lock table calls.

Deprecated:

Use ilAtomQuery instead

Returns

Implements ilDBInterface.

Referenced by rollback().

Here is the caller graph for this function:

update()

ilDB::update	(		$a_table,
			$a_columns,
			$a_where
	)

Convenient method for standard update statements, example field array:

array("field1" => array("text", $name), // will use "%s" "field2" => array("integer", $id), // will use "%s"

Example where array: array("id" => array("integer", $id))

Implements ilDBInterface.

Definition at line 1596 of file class.ilDB.php.

References $r, array, free(), handleError(), manipulateF(), MDB2_PREPARE_MANIP, and quote().

    {
        $fields = array();
        $field_values = array();
        $placeholders = array();
        $types = array();
        $values = array();
        $lobs = false;
        $lob = array();
        foreach ($a_columns as $k => $col) {
            $fields[] = $k;
            $placeholders[] = "%s";
            $placeholders2[] = ":$k";
            $types[] = $col[0];
            
            // integer auto-typecast (this casts bool values to integer)
            if ($col[0] == 'integer' && !is_null($col[1])) {
                $col[1] = (int) $col[1];
            }

            $values[] = $col[1];
            $field_values[$k] = $col[1];
            if ($col[0] == "blob" || $col[0] == "clob") {
                $lobs = true;
                $lob[$k] = $k;
            }
        }
        
        if ($lobs) {
            $q = "UPDATE " . $a_table . " SET ";
            $lim = "";
            foreach ($fields as $k => $field) {
                $q.= $lim . $field . " = " . $placeholders2[$k];
                $lim = ", ";
            }
            $q.= " WHERE ";
            $lim = "";
            foreach ($a_where as $k => $col) {
                $q.= $lim . $k . " = " . $this->quote($col[1], $col[0]);
                $lim = " AND ";
            }
            $st = $this->db->prepare($q, $types, MDB2_PREPARE_MANIP, $lob);
            $r = $st->execute($field_values);
            
            //$r = $this->db->extended->autoExecute($a_table, $field_values, MDB2_AUTOQUERY_INSERT, null, $types);
            $this->handleError($r, "update / prepare/execute(" . $a_table . ")");
            $this->free($st);
        } else {
            foreach ($a_where as $k => $col) {
                $types[] = $col[0];
                $values[] = $col[1];
                $field_values[$k] = $col;
            }
            $q = "UPDATE " . $a_table . " SET ";
            $lim = "";
            foreach ($fields as $k => $field) {
                $q.= $lim . $field . " = " . $placeholders[$k];
                $lim = ", ";
            }
            $q.= " WHERE ";
            $lim = "";
            foreach ($a_where as $k => $col) {
                $q.= $lim . $k . " = %s";
                $lim = " AND ";
            }
            
            $r = $this->manipulateF($q, $types, $values);
        }
        return $r;
    }

Here is the call graph for this function:

upper()

ilDB::upper

(

$a_exp

)

Upper.

Parameters

string

expression

Returns

string upper sql string

Implements ilDBInterface.

Definition at line 1882 of file class.ilDB.php.

    {
        return " UPPER(" . $a_exp . ") ";
    }

useSlave()

ilDB::useSlave

(

$a_val = true

)

Use slave.

Parameters

Implements ilDBInterface.

Definition at line 409 of file class.ilDB.php.

References supportsSlave().

    {
        if (!$this->supportsSlave()) {
            return false;
        }
        $this->use_slave = $a_val;
    }

Here is the call graph for this function:

Field Documentation

$allowed_attributes

ilDB::$allowed_attributes

Initial value:

= array(
            "text" => array("length", "notnull", "default", "fixed"),
            "integer" => array("length", "notnull", "default", "unsigned"),
            "float" => array("notnull", "default"),
            "date" => array("notnull", "default"),
            "time" => array("notnull", "default"),
            "timestamp" => array("notnull", "default"),
            "clob" => array("notnull", "default"),
            "blob" => array("notnull", "default")
        )

Definition at line 55 of file class.ilDB.php.

Referenced by checkColumnDefinition(), and getAllowedAttributes().

$db

ilDB::$db

Definition at line 46 of file class.ilDB.php.

$error_class

ilDB::$error_class

Definition at line 40 of file class.ilDB.php.

$result

ilDB::$result

Definition at line 52 of file class.ilDB.php.

$sub_type

ilDB::$sub_type

Definition at line 66 of file class.ilDB.php.

Referenced by getSubType().

LOCK_READ

const ilDB::LOCK_READ = 2

Definition at line 32 of file class.ilDB.php.

LOCK_WRITE

const ilDB::LOCK_WRITE = 1

Definition at line 31 of file class.ilDB.php.

---

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

• Services/Database/classes/MDB2/class.ilDB.php