arConnectorDB Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for arConnectorDB:

Collaboration diagram for arConnectorDB:

Public Member Functions
	__construct (?ilDBInterface $ilDB=null)
	checkConnection (ActiveRecord $activeRecord)
	nextID (ActiveRecord $activeRecord)
	installDatabase (ActiveRecord $activeRecord, array $fields)
	updateIndices (ActiveRecord $activeRecord)
	updateDatabase (ActiveRecord $activeRecord)
	resetDatabase (ActiveRecord $activeRecord)
	truncateDatabase (ActiveRecord $activeRecord)
	checkTableExists (ActiveRecord $activeRecord)
	checkFieldExists (ActiveRecord $activeRecord, string $field_name)
	removeField (ActiveRecord $activeRecord, string $field_name)
	renameField (ActiveRecord $activeRecord, string $old_name, string $new_name)
	create (ActiveRecord $activeRecord)
	read (ActiveRecord $activeRecord)
	update (ActiveRecord $activeRecord)
	delete (ActiveRecord $activeRecord)
	readSet (ActiveRecordList $activeRecordList)
	affectedRows (ActiveRecordList $activeRecordList)
	quote ($value, string $type)
Public Member Functions inherited from arConnector
	nextID (ActiveRecord $activeRecord)
	checkConnection (ActiveRecord $activeRecord)
	installDatabase (ActiveRecord $activeRecord, array $fields)
	updateDatabase (ActiveRecord $activeRecord)
	resetDatabase (ActiveRecord $activeRecord)
	truncateDatabase (ActiveRecord $activeRecord)
	checkTableExists (ActiveRecord $activeRecord)
	checkFieldExists (ActiveRecord $activeRecord, string $field_name)
	removeField (ActiveRecord $activeRecord, string $field_name)
	renameField (ActiveRecord $activeRecord, string $old_name, string $new_name)
	create (ActiveRecord $activeRecord)
	read (ActiveRecord $activeRecord)
	update (ActiveRecord $activeRecord)
	delete (ActiveRecord $activeRecord)
	readSet (ActiveRecordList $activeRecordList)
	affectedRows (ActiveRecordList $activeRecordList)
	quote (mixed $value, string $type)
	updateIndices (ActiveRecord $activeRecord)
	fixDate (string $value)

Protected Member Functions
	returnDB ()
	buildQuery (ActiveRecordList $activeRecordList)

Private Attributes
ilDBInterface	$db = null

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class arConnectorDB

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Timon Amstutz timon.nosp@m..ams.nosp@m.tutz@.nosp@m.ilub.nosp@m..unib.nosp@m.e.ch

Version

2.0.7

Definition at line 25 of file class.arConnectorDB.php.

Constructor & Destructor Documentation

__construct()

arConnectorDB::__construct

(

?ilDBInterface

$ilDB = null

)

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

References $DIC, $GLOBALS, $ilDB, and null.

    {
        if (is_null($ilDB)) {
            global $DIC;

            $this->db = $GLOBALS['ilDB'] ?? $DIC['ilDB'] ?? null;
        } else {
            $this->db = $ilDB;
        }
    }

Member Function Documentation

affectedRows()

arConnectorDB::affectedRows

(

ActiveRecordList

$activeRecordList

)

PhpParamsInspection

Definition at line 255 of file class.arConnectorDB.php.

References $ilDB, $q, buildQuery(), and returnDB().

                                                                    : int
    {
        $ilDB = $this->returnDB();
        $q = $this->buildQuery($activeRecordList);

        $set = $ilDB->query($q);

        return $ilDB->numRows($set);
    }

Here is the call graph for this function:

buildQuery()

arConnectorDB::buildQuery ( ActiveRecordList  $activeRecordList )

protected

Returns

mixed|string

Definition at line 269 of file class.arConnectorDB.php.

References $q, ActiveRecordList\getAR(), ActiveRecordList\getArConcatCollection(), ActiveRecordList\getArHavingCollection(), ActiveRecordList\getArJoinCollection(), ActiveRecordList\getArLimitCollection(), ActiveRecordList\getArOrderCollection(), ActiveRecordList\getArSelectCollection(), ActiveRecordList\getArWhereCollection(), and ActiveRecordList\setLastQuery().

Referenced by affectedRows(), and readSet().

                                                                     : string
    {
        // SELECTS
        $q = $activeRecordList->getArSelectCollection()->asSQLStatement($this->db);
        // Concats
        $q .= $activeRecordList->getArConcatCollection()->asSQLStatement($this->db);
        $q .= ' FROM ' . $activeRecordList->getAR()->getConnectorContainerName();
        // JOINS
        $q .= $activeRecordList->getArJoinCollection()->asSQLStatement($this->db);
        // WHERE
        $q .= $activeRecordList->getArWhereCollection()->asSQLStatement($this->db);
        // HAVING
        $q .= $activeRecordList->getArHavingCollection()->asSQLStatement($this->db);
        // ORDER
        $q .= $activeRecordList->getArOrderCollection()->asSQLStatement($this->db);
        // LIMIT
        $q .= $activeRecordList->getArLimitCollection()->asSQLStatement($this->db);

        $activeRecordList->setLastQuery($q);

        return $q;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkConnection()

arConnectorDB::checkConnection

(

ActiveRecord

$activeRecord

)

Definition at line 48 of file class.arConnectorDB.php.

References returnDB().

                                                               : bool
    {
        return is_object($this->returnDB());
    }

Here is the call graph for this function:

checkFieldExists()

arConnectorDB::checkFieldExists	(	ActiveRecord	$activeRecord,
		string	$field_name
	)

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

References $ilDB, ActiveRecord\getConnectorContainerName(), and returnDB().

                                                                                    : bool
    {
        $ilDB = $this->returnDB();

        return $ilDB->tableColumnExists($activeRecord->getConnectorContainerName(), $field_name);
    }

Here is the call graph for this function:

checkTableExists()

arConnectorDB::checkTableExists

(

ActiveRecord

$activeRecord

)

: This is the proper ILIAS approach on how to do this BUT: This is exteremely slow (listTables is used)! However, this is not the place to fix this issue. Report.

Definition at line 142 of file class.arConnectorDB.php.

References $ilDB, ActiveRecord\getConnectorContainerName(), and returnDB().

                                                                : bool
    {
        $ilDB = $this->returnDB();

        return $ilDB->tableExists($activeRecord->getConnectorContainerName());
    }

Here is the call graph for this function:

create()

arConnectorDB::create

(

ActiveRecord

$activeRecord

)

Definition at line 185 of file class.arConnectorDB.php.

References $ilDB, ActiveRecord\getArrayForConnector(), ActiveRecord\getConnectorContainerName(), and returnDB().

                                                      : void
    {
        $ilDB = $this->returnDB();
        $ilDB->insert($activeRecord->getConnectorContainerName(), $activeRecord->getArrayForConnector());
    }

Here is the call graph for this function:

delete()

arConnectorDB::delete

(

ActiveRecord

$activeRecord

)

Definition at line 227 of file class.arConnectorDB.php.

References $ilDB, arFieldCache\getPrimaryFieldName(), arFieldCache\getPrimaryFieldType(), and returnDB().

                                                      : void
    {
        $ilDB = $this->returnDB();

        $ilDB->manipulate(
            'DELETE FROM ' . $activeRecord->getConnectorContainerName() . ' WHERE ' . arFieldCache::getPrimaryFieldName(
                $activeRecord
            ) . ' = '
            . $ilDB->quote($activeRecord->getPrimaryFieldValue(), arFieldCache::getPrimaryFieldType($activeRecord))
        );
    }

Here is the call graph for this function:

installDatabase()

arConnectorDB::installDatabase	(	ActiveRecord	$activeRecord,
		array	$fields
	)

Definition at line 61 of file class.arConnectorDB.php.

References $ilDB, ActiveRecord\getArFieldList(), ActiveRecord\getConnectorContainerName(), returnDB(), and updateIndices().

                                                                              : bool
    {
        $ilDB = $this->returnDB();
        $ilDB->createTable($activeRecord->getConnectorContainerName(), $fields);
        $arFieldList = $activeRecord->getArFieldList();
        if ($arFieldList->getPrimaryField()->getName() !== '' && $arFieldList->getPrimaryField()->getName() !== '0') {
            $ilDB->addPrimaryKey(
                $activeRecord->getConnectorContainerName(),
                [$arFieldList->getPrimaryField()->getName()]
            );
        }
        if (!$ilDB->sequenceExists($activeRecord->getConnectorContainerName()) && $activeRecord->getArFieldList(
        )->getPrimaryField()->getSequence()) {
            $ilDB->createSequence($activeRecord->getConnectorContainerName());
        }
        $this->updateIndices($activeRecord);

        return true;
    }

Here is the call graph for this function:

nextID()

arConnectorDB::nextID

(

ActiveRecord

$activeRecord

)

Returns

mixed

Definition at line 56 of file class.arConnectorDB.php.

References ActiveRecord\getConnectorContainerName(), and returnDB().

                                                      : int
    {
        return $this->returnDB()->nextId($activeRecord->getConnectorContainerName());
    }

Here is the call graph for this function:

quote()

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

Parameters

$value

Definition at line 295 of file class.arConnectorDB.php.

References $ilDB, and returnDB().

                                               : string
    {
        $ilDB = $this->returnDB();

        return $ilDB->quote($value, $type);
    }

Here is the call graph for this function:

read()

arConnectorDB::read

(

ActiveRecord

$activeRecord

)

Returns

mixed[]

Definition at line 194 of file class.arConnectorDB.php.

References $ilDB, ActiveRecord\getConnectorContainerName(), arFieldCache\getPrimaryFieldName(), arFieldCache\getPrimaryFieldType(), ActiveRecord\getPrimaryFieldValue(), and returnDB().

                                                    : array
    {
        $ilDB = $this->returnDB();

        $query = 'SELECT * FROM ' . $activeRecord->getConnectorContainerName(
        ) . ' ' . ' WHERE ' . arFieldCache::getPrimaryFieldName($activeRecord) . ' = '
            . $ilDB->quote($activeRecord->getPrimaryFieldValue(), arFieldCache::getPrimaryFieldType($activeRecord));

        $set = $ilDB->query($query);
        $records = [];
        while ($rec = $ilDB->fetchObject($set)) {
            $records[] = $rec;
        }

        return $records;
    }

Here is the call graph for this function:

readSet()

arConnectorDB::readSet

(

ActiveRecordList

$activeRecordList

)

Returns

mixed[]

Definition at line 243 of file class.arConnectorDB.php.

References $ilDB, buildQuery(), and returnDB().

                                                               : array
    {
        $ilDB = $this->returnDB();
        $set = $ilDB->query($this->buildQuery($activeRecordList));
        $records = [];
        while ($rec = $ilDB->fetchAssoc($set)) {
            $records[] = $rec;
        }

        return $records;
    }

Here is the call graph for this function:

removeField()

arConnectorDB::removeField	(	ActiveRecord	$activeRecord,
		string	$field_name
	)

Definition at line 160 of file class.arConnectorDB.php.

References $ilDB, arException\COLUMN_DOES_NOT_EXIST, ActiveRecord\getConnectorContainerName(), and returnDB().

                                                                               : bool
    {
        $ilDB = $this->returnDB();
        if (!$ilDB->tableColumnExists($activeRecord->getConnectorContainerName(), $field_name)) {
            throw new arException($field_name, arException::COLUMN_DOES_NOT_EXIST);
        }
        $ilDB->dropTableColumn($activeRecord->getConnectorContainerName(), $field_name);
        return true;
    }

Here is the call graph for this function:

renameField()

arConnectorDB::renameField	(	ActiveRecord	$activeRecord,
		string	$old_name,
		string	$new_name
	)

Definition at line 170 of file class.arConnectorDB.php.

References $ilDB, ActiveRecord\getConnectorContainerName(), and returnDB().

                                                                                               : bool
    {
        $ilDB = $this->returnDB();
        //throw new arException($old_name, arException::COLUMN_DOES_NOT_EXIST);
        if (!$ilDB->tableColumnExists($activeRecord->getConnectorContainerName(), $old_name)) {
            return true;
        }
        if ($ilDB->tableColumnExists($activeRecord->getConnectorContainerName(), $new_name)) {
            return true;
        }
        //throw new arException($new_name, arException::COLUMN_DOES_ALREADY_EXIST);
        $ilDB->renameTableColumn($activeRecord->getConnectorContainerName(), $old_name, $new_name);
        return true;
    }

Here is the call graph for this function:

resetDatabase()

arConnectorDB::resetDatabase

(

ActiveRecord

$activeRecord

)

Definition at line 118 of file class.arConnectorDB.php.

References $ilDB, ActiveRecord\getConnectorContainerName(), ActiveRecord\installDB(), and returnDB().

                                                             : bool
    {
        $ilDB = $this->returnDB();
        if ($ilDB->tableExists($activeRecord->getConnectorContainerName())) {
            $ilDB->dropTable($activeRecord->getConnectorContainerName());
        }
        $activeRecord->installDB();

        return true;
    }

Here is the call graph for this function:

returnDB()

arConnectorDB::returnDB ( )

protected

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

References $db.

Referenced by affectedRows(), checkConnection(), checkFieldExists(), checkTableExists(), create(), delete(), installDatabase(), nextID(), quote(), read(), readSet(), removeField(), renameField(), resetDatabase(), truncateDatabase(), update(), updateDatabase(), and updateIndices().

                                 : ilDBInterface
    {
        if (is_null($this->db)) {
            throw new arException("No DB-Connection available");
        }
        return $this->db;
    }

Here is the caller graph for this function:

truncateDatabase()

arConnectorDB::truncateDatabase

(

ActiveRecord

$activeRecord

)

Definition at line 129 of file class.arConnectorDB.php.

References $ilDB, ActiveRecord\getConnectorContainerName(), and returnDB().

                                                                : bool
    {
        $ilDB = $this->returnDB();
        $query = 'TRUNCATE TABLE ' . $activeRecord->getConnectorContainerName();
        $ilDB->query($query);
        if ($ilDB->tableExists($activeRecord->getConnectorContainerName() . '_seq')) {
            $ilDB->dropSequence($activeRecord->getConnectorContainerName());
            $ilDB->createSequence($activeRecord->getConnectorContainerName());
        }

        return true;
    }

Here is the call graph for this function:

update()

arConnectorDB::update

(

ActiveRecord

$activeRecord

)

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

References $ilDB, ActiveRecord\getArrayForConnector(), ActiveRecord\getConnectorContainerName(), arFieldCache\getPrimaryFieldName(), arFieldCache\getPrimaryFieldType(), ActiveRecord\getPrimaryFieldValue(), and returnDB().

                                                      : void
    {
        $ilDB = $this->returnDB();

        $ilDB->update(
            $activeRecord->getConnectorContainerName(),
            $activeRecord->getArrayForConnector(),
            [
            arFieldCache::getPrimaryFieldName($activeRecord) => [
                arFieldCache::getPrimaryFieldType($activeRecord),
                $activeRecord->getPrimaryFieldValue()
            ]
        ]
        );
    }

Here is the call graph for this function:

updateDatabase()

arConnectorDB::updateDatabase

(

ActiveRecord

$activeRecord

)

Definition at line 101 of file class.arConnectorDB.php.

References $ilDB, ActiveRecord\getArFieldList(), ActiveRecord\getConnectorContainerName(), returnDB(), and updateIndices().

                                                              : bool
    {
        $ilDB = $this->returnDB();
        foreach ($activeRecord->getArFieldList()->getFields() as $arField) {
            if (!$ilDB->tableColumnExists($activeRecord->getConnectorContainerName(), $arField->getName())) {
                $ilDB->addTableColumn(
                    $activeRecord->getConnectorContainerName(),
                    $arField->getName(),
                    $arField->getAttributesForConnector()
                );
            }
        }
        $this->updateIndices($activeRecord);

        return true;
    }

Here is the call graph for this function:

updateIndices()

arConnectorDB::updateIndices

(

ActiveRecord

$activeRecord

)

Definition at line 81 of file class.arConnectorDB.php.

References $ilDB, ActiveRecord\getArFieldList(), ActiveRecord\getConnectorContainerName(), and returnDB().

Referenced by installDatabase(), and updateDatabase().

                                                             : void
    {
        $ilDB = $this->returnDB();
        $arFieldList = $activeRecord->getArFieldList();
        $existing_indices = $ilDB->loadModule('Manager')->listTableIndexes($activeRecord->getConnectorContainerName());

        foreach ($arFieldList->getFields() as $i => $arField) {
            if (!$arField->getIndex()) {
                continue;
            }
            if (in_array($arField->getName(), $existing_indices)) {
                continue;
            }
            if ($ilDB->indexExistsByFields($activeRecord->getConnectorContainerName(), [$arField->getName()])) {
                continue;
            }
            $ilDB->addIndex($activeRecord->getConnectorContainerName(), [$arField->getName()], 'i' . $i);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$db

ilDBInterface arConnectorDB::$db = null

private

Definition at line 27 of file class.arConnectorDB.php.

Referenced by returnDB().

---

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

• components/ILIAS/ActiveRecord/Connector/class.arConnectorDB.php