class.arConnectorDB.php

Go to the documentation of this file.

<?php
require_once('class.arConnector.php');
require_once(dirname(__FILE__) . '/../Exception/class.arException.php');

class arConnectorDB extends arConnector {

        protected function returnDB() {
                global $ilDB;

                return $ilDB;
        }


        public function checkConnection(ActiveRecord $ar) {
                return is_object($this->returnDB());
        }


        public function nextID(ActiveRecord $ar) {
                return $this->returnDB()->nextId($ar->getConnectorContainerName());
        }


        public function installDatabase(ActiveRecord $ar, $fields) {
                $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;
        }


        public function updateIndices(ActiveRecord $ar) {
                $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);
                                        }
                                }
                        }
                }
        }


        public function updateDatabase(ActiveRecord $ar) {
                $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;
        }


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

                return true;
        }


        public function truncateDatabase(ActiveRecord $ar) {
                $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());
                }
        }


        public function checkTableExists(ActiveRecord $ar) {
                $ilDB = $this->returnDB();

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


        public function checkFieldExists(ActiveRecord $ar, $field_name) {
                $ilDB = $this->returnDB();

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


        public function removeField(ActiveRecord $ar, $field_name) {
                $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;
                }
        }


        public function renameField(ActiveRecord $ar, $old_name, $new_name) {
                $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;
        }


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


        public function read(ActiveRecord $ar) {
                $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;
        }


        public function update(ActiveRecord $ar) {
                $ilDB = $this->returnDB();

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


        public function delete(ActiveRecord $ar) {
                $ilDB = $this->returnDB();

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


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

                return $records;
        }


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

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

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


        protected function buildQuery(ActiveRecordList $arl) {
                $ilDB = $this->returnDB();
                if ($ilDB->getDBType() == ilDBConstants::TYPE_ORACLE) {
                        $method = 'asORACLEStatement';
                } else {
                        $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 $tpl;
                        if ($tpl instanceof ilTemplate) {
                                ilUtil::sendInfo($q);
                        } else {
                                var_dump($q); // FSX
                        }
                }
                $arl->setLastQuery($q);

                return $q;
        }


        public function quote($value, $type) {
                $ilDB = $this->returnDB();

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


        public function fixDate($value) {
                $ilDB = $this->returnDB();
                if ($ilDB->getDBType() != ilDBConstants::TYPE_ORACLE) {
                        return parent::fixDate($value);
                }

                return parent::fixDate($value);
                //              return "TO_DATE('{$value}','YYYY-MM-DD HH24:MI:SS')";
        }
}