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)
	fixDate ($value)
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)
	fixDate ($value)

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

References $ilDB, and returnDB().

Referenced by arConnectorCache\affectedRows().

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

buildQuery()

arConnectorDB::buildQuery ( ActiveRecordList  $arl )

protected

Parameters

ActiveRecordList

$arl

Returns

mixed|string

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

References $DIC, $tpl, ActiveRecordList\getArSelectCollection(), and ilUtil\sendInfo().

    {
        $method = 'asSQLStatement';

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

        //TODO: using template in the model.
        if ($arl->getDebug()) {
            global $DIC;
            $tpl = $DIC['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 32 of file class.arConnectorDB.php.

References returnDB().

Referenced by arConnectorCache\checkConnection().

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

Here is the call graph for this function:

Here is the caller graph for this function:

checkFieldExists()

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

Parameters

ActiveRecord	$ar
	$field_name

Returns

mixed

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

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

Referenced by arConnectorCache\checkFieldExists().

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

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

Here is the call graph for this function:

Here is the caller 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 149 of file class.arConnectorDB.php.

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

Referenced by arConnectorCache\checkTableExists().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

create()

arConnectorDB::create

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

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

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

Referenced by arConnectorCache\create().

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

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

arConnectorDB::delete

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

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

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

Referenced by arConnectorCache\delete().

    {
        $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:

Here is the caller graph for this function:

fixDate()

arConnectorDB::fixDate

(

$value

)

Parameters

$value

Returns

string

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

    {
        return parent::fixDate($value);
    }

installDatabase()

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

Parameters

ActiveRecord	$ar
	$fields

Returns

bool

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

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

Referenced by arConnectorCache\installDatabase().

    {
        $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:

Here is the caller graph for this function:

nextID()

arConnectorDB::nextID

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

Returns

mixed

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

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

Referenced by arConnectorCache\nextID().

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

Here is the call graph for this function:

Here is the caller graph for this function:

quote()

arConnectorDB::quote	(		$value,
			$type
	)

Parameters

$value
$type

Returns

string

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

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

Referenced by arConnectorCache\quote().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

read()

arConnectorDB::read

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

Returns

array

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

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

Referenced by arConnectorCache\read().

    {
        $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:

Here is the caller graph for this function:

readSet()

arConnectorDB::readSet

(

ActiveRecordList

$arl

)

Parameters

ActiveRecordList

$arl

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

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

Referenced by arConnectorCache\readSet().

    {
        $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:

Here is the caller graph for this function:

removeField()

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

Parameters

ActiveRecord	$ar
	$field_name

Returns

bool

Exceptions

arException

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

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

Referenced by arConnectorCache\removeField().

    {
        $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:

Here is the caller 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 204 of file class.arConnectorDB.php.

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

Referenced by arConnectorCache\renameField().

    {
        $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:

Here is the caller graph for this function:

resetDatabase()

arConnectorDB::resetDatabase

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

Returns

bool

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

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

Referenced by arConnectorCache\resetDatabase().

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

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

returnDB()

arConnectorDB::returnDB ( )

protected

Returns

ilDB

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

References $DIC, and $ilDB.

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

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        return $ilDB;
    }

Here is the caller graph for this function:

truncateDatabase()

arConnectorDB::truncateDatabase

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

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

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

Referenced by arConnectorCache\truncateDatabase().

    {
        $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:

Here is the caller graph for this function:

update()

arConnectorDB::update

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

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

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

Referenced by arConnectorCache\update().

    {
        $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:

Here is the caller graph for this function:

updateDatabase()

arConnectorDB::updateDatabase

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

Returns

bool

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

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

Referenced by arConnectorCache\updateDatabase().

    {
        $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:

Here is the caller graph for this function:

updateIndices()

arConnectorDB::updateIndices

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

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

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

Referenced by installDatabase(), updateDatabase(), and arConnectorCache\updateIndices().

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

        foreach ($arFieldList->getFields() as $i => $arField) {
            if ($arField->getIndex() === true) {
                if (!in_array($arField->getName(), $existing_indices)) {
                    if (!$ilDB->indexExistsByFields($ar->getConnectorContainerName(), array( $arField->getName() ))) {
                        $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