baseline

[omp.pkp.sfu.ca.git] / lib / pkp / classes / controlledVocab / ControlledVocabDAO.inc.php

<?php

/**
 * @file ControlledVocabDAO.inc.php
 *
 * Copyright (c) 2000-2009 John Willinsky
 * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
 *
 * @class ControlledVocabDAO
 * @ingroup controlled_vocab
 * @see ControlledVocab
 *
 * @brief Operations for retrieving and modifying ControlledVocab objects.
 */

//$Id: ControlledVocabDAO.inc.php,v 1.4 2009/05/13 00:13:20 asmecher Exp $


import('controlledVocab.ControlledVocab');

class ControlledVocabDAO extends DAO {
        /**
         * Retrieve a controlled vocab by controlled vocab ID.
         * @param $controlledVocabId int
         * @return ControlledVocab
         */
        function getById($controlledVocabId) {
                $result =& $this->retrieve(
                        'SELECT * FROM controlled_vocabs WHERE controlled_vocab_id = ?', array((int) $controlledVocabId)
                );

                $returner = null;
                if ($result->RecordCount() != 0) {
                        $returner =& $this->_fromRow($result->GetRowAssoc(false));
                }
                $result->Close();
                return $returner;
        }

        /**
         * Fetch a controlled vocab by symbolic info, building it if needed.
         * @param $symbolic string
         * @param $assocType int
         * @param $assocId int
         * @return $controlledVocab
         */
        function build($symbolic, $assocType, $assocId) {
                // If one exists, fetch and return.
                $controlledVocab = $this->getBySymbolic($symbolic, $assocType, $assocId);
                if ($controlledVocab) return $controlledVocab;

                // Otherwise, build one.
                unset($controlledVocab);
                $controlledVocab = $this->newDataObject();
                $controlledVocab->setSymbolic($symbolic);
                $controlledVocab->setAssocType($assocType);
                $controlledVocab->setAssocId($assocId);
                $this->insertObject($controlledVocab);
                return $controlledVocab;
        }

        /**
         * Construct a new data object corresponding to this DAO.
         * @return ControlledVocabEntry
         */
        function newDataObject() {
                return new ControlledVocab();
        }

        /**
         * Internal function to return an ControlledVocab object from a row.
         * @param $row array
         * @return ControlledVocab
         */
        function _fromRow(&$row) {
                $controlledVocab = $this->newDataObject();
                $controlledVocab->setId($row['controlled_vocab_id']);
                $controlledVocab->setAssocType($row['assoc_type']);
                $controlledVocab->setAssocId($row['assoc_id']);
                $controlledVocab->setSymbolic($row['symbolic']);

                return $controlledVocab;
        }

        /**
         * Insert a new ControlledVocab.
         * @param $controlledVocab ControlledVocab
         * @return int
         */
        function insertObject(&$controlledVocab) {
                $this->update(
                        sprintf('INSERT INTO controlled_vocabs
                                (symbolic, assoc_type, assoc_id)
                                VALUES
                                (?, ?, ?)'),
                        array(
                                $controlledVocab->getSymbolic(),
                                (int) $controlledVocab->getAssocType(),
                                (int) $controlledVocab->getAssocId()
                        )
                );
                $controlledVocab->setId($this->getInsertId());
                return $controlledVocab->getId();
        }

        /**
         * Update an existing controlled vocab.
         * @param $controlledVocab ControlledVocab
         * @return boolean
         */
        function updateObject(&$controlledVocab) {
                $returner = $this->update(
                        sprintf('UPDATE controlled_vocabs
                                SET     symbolic = ?,
                                        assoc_type = ?,
                                        assoc_id = ?
                                WHERE   controlled_vocab_id = ?'),
                        array(
                                $controlledVocab->getSymbolic(),
                                (int) $controlledVocab->getAssocType(),
                                (int) $controlledVocab->getAssocId(),
                                (int) $controlledVocab->getId()
                        )
                );
                return $returner;
        }

        /**
         * Delete a controlled vocab.
         * @param $controlledVocab ControlledVocab
         * @return boolean
         */
        function deleteObject($controlledVocab) {
                return $this->deleteObjectById($controlledVocab->getId());
        }

        /**
         * Delete a controlled vocab by controlled vocab ID.
         * @param $controlledVocabId int
         * @return boolean
         */
        function deleteObjectById($controlledVocabId) {
                $params = array((int) $controlledVocabId);
                $controlledVocabEntryDao =& DAORegistry::getDAO('ControlledVocabEntryDAO');
                $controlledVocabEntries =& $controlledVocabEntryDao->getControlledVocabEntries($controlledVocabId);
                while ($controlledVocabEntry =& $controlledVocabEntries->next()) {
                        $controlledVocabEntryDao->deleteObject($controlledVocabEntry);
                        unset($controlledVocabEntry);
                }
                return $this->update('DELETE FROM controlled_vocabs WHERE controlled_vocab_id = ?', $params);
        }

        /**
         * Retrieve an array of controlled vocabs matching the specified
         * symbolic name and assoc info.
         * @param $symbolic string
         * @param $assocType int
         * @param $assocId int
         */
        function getBySymbolic($symbolic, $assocType, $assocId) {
                $result =& $this->retrieve(
                        'SELECT * FROM controlled_vocabs WHERE symbolic = ? AND assoc_type = ? AND assoc_id = ?',
                        array($symbolic, (int) $assocType, (int) $assocId)
                );

                $returner = null;
                if ($result->RecordCount() != 0) {
                        $returner = $this->_fromRow($result->GetRowAssoc(false));
                }
                $result->Close();
                return $returner;
        }

        /**
         * Get a list of controlled vocabulary options.
         * @param $symbolic string
         * @param $assocType int
         * @param $assocId int
         * @param $settingName string optional
         * @return array $controlledVocabEntryId => $settingValue
         */
        function enumerateBySymbolic($symbolic, $assocType, $assocId, $settingName = 'name') {
                $controlledVocab = $this->getBySymbolic($symbolic, $assocType, $assocId);
                if (!$controlledVocab) {
                        $returner = array();
                        return $returner;
                }
                return $controlledVocab->enumerate($settingName);
        }

        /**
         * Get a list of controlled vocabulary options.
         * @param $controlledVocabId int
         * @param $settingName string optional
         * @return array $controlledVocabEntryId => name
         */
        function enumerate($controlledVocabId, $settingName = 'name') {
                $result =& $this->retrieve(
                        'SELECT e.controlled_vocab_entry_id,
                                COALESCE(l.setting_value, p.setting_value, n.setting_value) AS setting_value,
                                COALESCE(l.setting_type, p.setting_type, n.setting_type) AS setting_type
                        FROM    controlled_vocab_entries e
                                LEFT JOIN controlled_vocab_entry_settings l ON (l.controlled_vocab_entry_id = e.controlled_vocab_entry_id AND l.setting_name = ? AND l.locale = ?)
                                LEFT JOIN controlled_vocab_entry_settings p ON (p.controlled_vocab_entry_id = e.controlled_vocab_entry_id AND p.setting_name = ? AND p.locale = ?)
                                LEFT JOIN controlled_vocab_entry_settings n ON (n.controlled_vocab_entry_id = e.controlled_vocab_entry_id AND n.setting_name = ? AND n.locale = ?)
                        WHERE   e.controlled_vocab_id = ?
                        ORDER BY e.seq',
                        array(
                                $settingName, Locale::getLocale(),              // Current locale
                                $settingName, Locale::getPrimaryLocale(),       // Primary locale
                                $settingName, '',                               // No locale
                                (int) $controlledVocabId
                        )
                );

                $returner = array();
                while (!$result->EOF) {
                        $row = $result->GetRowAssoc(false);
                        $returner[$row['controlled_vocab_entry_id']] = $this->convertFromDB(
                                $row['setting_value'],
                                $row['setting_type']
                        );
                        $result->MoveNext();
                }
                $result->Close();

                return $returner;
        }

        /**
         * Get the ID of the last inserted controlled vocab.
         * @return int
         */
        function getInsertId() {
                return parent::getInsertId('controlled_vocabs', 'controlled_vocab_id');
        }
}

?>