arConnectorDB Class Reference

Class arConnectorDB. More...

Inheritance diagram for arConnectorDB:

Collaboration diagram for arConnectorDB:

Public Member Functions
	checkConnection (ActiveRecord $ar)
	nextID (ActiveRecord $ar)
	installDatabase (ActiveRecord $ar, $fields)
	updateIndices (ActiveRecord $ar)
	updateDatabase (ActiveRecord $ar)
	resetDatabase (ActiveRecord $ar)
	truncateDatabase (ActiveRecord $ar)
	checkTableExists (ActiveRecord $ar)
	checkFieldExists (ActiveRecord $ar, $field_name)
	removeField (ActiveRecord $ar, $field_name)
	renameField (ActiveRecord $ar, $old_name, $new_name)
	create (ActiveRecord $ar)
	read (ActiveRecord $ar)
	update (ActiveRecord $ar)
	delete (ActiveRecord $ar)
	readSet (ActiveRecordList $arl)
	affectedRows (ActiveRecordList $arl)
	quote ($value, $type)
Public Member Functions inherited from arConnector
	nextID (ActiveRecord $ar)
	checkConnection (ActiveRecord $ar)
	installDatabase (ActiveRecord $ar, $fields)
	updateDatabase (ActiveRecord $ar)
	resetDatabase (ActiveRecord $ar)
	truncateDatabase (ActiveRecord $ar)
	checkTableExists (ActiveRecord $ar)
	checkFieldExists (ActiveRecord $ar, $field_name)
	removeField (ActiveRecord $ar, $field_name)
	renameField (ActiveRecord $ar, $old_name, $new_name)
	create (ActiveRecord $ar)
	read (ActiveRecord $ar)
	update (ActiveRecord $ar)
	delete (ActiveRecord $ar)
	readSet (ActiveRecordList $arl)
	affectedRows (ActiveRecordList $arl)
	quote ($value, $type)
	updateIndices (ActiveRecord $ar)

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

Detailed Description

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 12 of file class.arConnectorDB.php.

Member Function Documentation

affectedRows()

arConnectorDB::affectedRows

(

ActiveRecordList

$arl

)

Parameters

ActiveRecordList

$arl

Returns

int

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

References $ilDB, and returnDB().

                                                            {
                $ilDB = $this->returnDB();
                $q = self::buildQuery($arl);

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

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

Here is the call graph for this function:

buildQuery()

arConnectorDB::buildQuery ( ActiveRecordList  $arl )

protected

Parameters

ActiveRecordList

$arl

Returns

mixed|string

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

References $tpl, ActiveRecordList\getArConcatCollection(), ActiveRecordList\getArJoinCollection(), ActiveRecordList\getArLimitCollection(), ActiveRecordList\getArOrderCollection(), ActiveRecordList\getArSelectCollection(), ActiveRecordList\getArWhereCollection(), ActiveRecordList\getDebug(), ilUtil\sendInfo(), and ActiveRecordList\setLastQuery().

                                                             {
                // SELECTS
                $q = $arl->getArSelectCollection()->asSQLStatement();
                // Concats
                $q .= $arl->getArConcatCollection()->asSQLStatement();
                $q .= ' FROM '.$arl->getAR()->getConnectorContainerName();
                // JOINS
                $q .= $arl->getArJoinCollection()->asSQLStatement();
                // WHERE
                $q .= $arl->getArWhereCollection()->asSQLStatement();
                // ORDER
                $q .= $arl->getArOrderCollection()->asSQLStatement();
                // LIMIT
                $q .= $arl->getArLimitCollection()->asSQLStatement();

                //TODO: using template in the model.
                if ($arl->getDebug()) {
                        global $tpl;
                        if ($tpl instanceof ilTemplate) {
                                ilUtil::sendInfo($q);
                        } else {
                                var_dump($q); // FSX
                        }
                }
                $arl->setLastQuery($q);

                return $q;
        }

Here is the call graph for this function:

checkConnection()

arConnectorDB::checkConnection

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

Returns

bool

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

References returnDB().

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

Here is the call graph for this function:

checkFieldExists()

arConnectorDB::checkFieldExists	(	ActiveRecord	$ar,
			$field_name
	)

Parameters

ActiveRecord	$ar
	$field_name

Returns

mixed

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

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

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

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

Here is the call graph for this function:

checkTableExists()

arConnectorDB::checkTableExists

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

Returns

mixed

: 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 140 of file class.arConnectorDB.php.

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

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

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

Here is the call graph for this function:

create()

arConnectorDB::create

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

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

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

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

Here is the call graph for this function:

delete()

arConnectorDB::delete

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

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

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

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

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

Here is the call graph for this function:

installDatabase()

arConnectorDB::installDatabase	(	ActiveRecord	$ar,
			$fields
	)

Parameters

ActiveRecord	$ar
	$fields

Returns

bool

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

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

                                                                   {
                $ilDB = $this->returnDB();
                $ilDB->createTable($ar->getConnectorContainerName(), $fields);
                $arFieldList = $ar->getArFieldList();
                if ($arFieldList->getPrimaryField()->getName()) {
                        $ilDB->addPrimaryKey($ar->getConnectorContainerName(), array( $arFieldList->getPrimaryField()->getName() ));
                }
                if ($ar->getArFieldList()->getPrimaryField()->getSequence() AND ! $ilDB->sequenceExists($ar->getConnectorContainerName())) {
                        $ilDB->createSequence($ar->getConnectorContainerName());
                }
                $this->updateIndices($ar);

                return true;
        }

Here is the call graph for this function:

nextID()

arConnectorDB::nextID

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

Returns

mixed

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

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

                                                 {
                return $this->returnDB()->nextId($ar->getConnectorContainerName());
        }

Here is the call graph for this function:

quote()

arConnectorDB::quote	(		$value,
			$type
	)

Parameters

$value
$type

Returns

string

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

References $ilDB, and returnDB().

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

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

Here is the call graph for this function:

read()

arConnectorDB::read

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

Returns

array

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

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

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

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

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

                return $records;
        }

Here is the call graph for this function:

readSet()

arConnectorDB::readSet

(

ActiveRecordList

$arl

)

Parameters

ActiveRecordList

$arl

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

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

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

                return $records;
        }

Here is the call graph for this function:

removeField()

arConnectorDB::removeField	(	ActiveRecord	$ar,
			$field_name
	)

Parameters

ActiveRecord	$ar
	$field_name

Returns

bool

Exceptions

arException

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

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

                                                                   {
                $ilDB = $this->returnDB();
                if ($ilDB->tableColumnExists($ar->getConnectorContainerName(), $field_name)) {
                        //throw new arException($field_name, arException::COLUMN_DOES_NOT_EXIST);
                }
                if ($ilDB->tableColumnExists($ar->getConnectorContainerName(), $field_name)) {
                        $ilDB->dropTableColumn($ar->getConnectorContainerName(), $field_name);

                        return true;
                }
        }

Here is the call graph for this function:

renameField()

arConnectorDB::renameField	(	ActiveRecord	$ar,
			$old_name,
			$new_name
	)

Parameters

ActiveRecord	$ar
	$old_name
	$new_name

Returns

bool

Exceptions

arException

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

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

                                                                            {
                $ilDB = $this->returnDB();
                if ($ilDB->tableColumnExists($ar->getConnectorContainerName(), $old_name)) {
                        //throw new arException($old_name, arException::COLUMN_DOES_NOT_EXIST);

                        if (!$ilDB->tableColumnExists($ar->getConnectorContainerName(), $new_name)) {
                                //throw new arException($new_name, arException::COLUMN_DOES_ALREADY_EXIST);
                                $ilDB->renameTableColumn($ar->getConnectorContainerName(), $old_name, $new_name);
                        }
                }

                return true;
        }

Here is the call graph for this function:

resetDatabase()

arConnectorDB::resetDatabase

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

Returns

bool

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

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

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

                return true;
        }

Here is the call graph for this function:

returnDB()

arConnectorDB::returnDB ( )

protected

Returns

ilDB

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

References $ilDB.

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

                                      {
                global $ilDB;

                return $ilDB;
        }

Here is the caller graph for this function:

truncateDatabase()

arConnectorDB::truncateDatabase

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

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

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

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

Here is the call graph for this function:

update()

arConnectorDB::update

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

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

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

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

                $ilDB->update($ar->getConnectorContainerName(), $ar->getArrayForConnector(), array(
                        arFieldCache::getPrimaryFieldName($ar) => array(
                                arFieldCache::getPrimaryFieldType($ar),
                                $ar->getPrimaryFieldValue()
                        ),
                ));
        }

Here is the call graph for this function:

updateDatabase()

arConnectorDB::updateDatabase

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

Returns

bool

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

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

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

                return true;
        }

Here is the call graph for this function:

updateIndices()

arConnectorDB::updateIndices

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

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

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

Referenced by installDatabase(), and updateDatabase().

                                                        {
                $ilDB = $this->returnDB();
                $arFieldList = $ar->getArFieldList();
                $res = $ilDB->query('SHOW INDEX FROM ' . $ar->getConnectorContainerName());
                $existing_indices = array();
                while ($rec = $ilDB->fetchObject($res)) {
                        $existing_indices[] = $rec->column_name;
                }
                foreach ($arFieldList->getFields() as $i => $arField) {
                        if ($arField->getIndex() === true) {
                                if (!in_array($arField->getName(), $existing_indices)) {
                                        $ilDB->addIndex($ar->getConnectorContainerName(), array( $arField->getName() ), 'i' . $i);
                                }
                        }
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• Services/ActiveRecord/Connector/class.arConnectorDB.php