Home | Classes | Modules | Annotated | Functions | Files

DatabaseInfo.php

Go to the documentation of this file.

<?php

/*
 *  $Id: DatabaseInfo.php,v 1.4 2004/04/27 19:05:15 micha Exp $
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the LGPL. For more information please see
 * <http://creole.phpdb.org>.
 */

class DatabaseInfo
{
  var $tables = array();

  var $sequences = array();

  var $tablesLoaded = false;

  var $seqsLoaded = false;

  var $conn;

  var $dbname;

  var $dblink;

  function DatabaseInfo(/*Connection*/ &$conn)
  {
    if (! is_a($conn, 'Connection')) {
      trigger_error(
        "DatabaseInfo::DatabaseInfo(): parameter 1 not of type 'Connection' !",
        E_USER_ERROR
      );
    }
  
    $this->conn =& $conn;
    $this->dblink =& $conn->getResource();
    $dsn = $conn->getDSN();
    $this->dbname = $dsn['database'];
  }

  function getName()
  {
    return $this->dbname;
  }

  function __sleep()
  {
    return array('tables','conn');
  }

  function __wakeup()
  {
    // Re-init vars from serialized connection
    $this->dbname =& $conn->database;
    $this->dblink =& $conn->connection;

    // restore chaining
    for($i=0, $j=count($this->tables); $i < $j; $i++) {
      $tbl =& $this->tables[$i];
      $tbl->database =& $this;
      $tbl->dbname = $this->dbname;
      $tbl->dblink = $this->dblink;
      $tbl->schema = $this->schema;
    }
  }

  function & getConnection()
  {
    return $this->conn;
  }

  function & getTable($name)
  {
    if(!$this->tablesLoaded) {
      if (($e = $this->initTables()) !== true) {
        return $e;
      }
    }
  
    if (!isset($this->tables[strtoupper($name)])) {
      return new SQLException(CREOLE_ERROR_NOSUCHTABLE, "Database `".$this->name."` has no table `".$name."`");
    }
    
    return $this->tables[ strtoupper($name) ];
  }

  function & getTables()
  {
    if(!$this->tablesLoaded) {
      if (($e = $this->initTables()) !== true) {
        return $e;
      }
    }
    
    return array_values($this->tables); //re-key [numerically]
  }

  function addTable(/*TableInfo*/ &$table)
  {
    if (! is_a($table, 'TableInfo')) {
      trigger_error(
        "DatabaseInfo::addTable(): parameter 1 not of type 'TableInfo' !",
        E_USER_ERROR
      );
    }
    $this->tables[strtoupper($table->getName())] =& $table;
  }

  function initTables()
  {
    trigger_error (
      "DatabaseInfo::initTables(): abstract function has to be reimplemented !",
      E_USER_ERROR
    );
  }

  // FIXME
  // Figure out sequences.  What are they exactly?  Simply columns?
  // Should this logic really be at the db level (yes & no, i think).  Maybe
  // also a Column::isSequence() method ?  PosgreSQL supports sequences obviously,
  // but currently this part of dbinfo classes is not being used.

  function initSequences()
  {
    trigger_error (
      "DatabaseInfo::initSequences(): abstract function has to be reimplemented !",
      E_USER_ERROR
    );
  }

  function isSequence($key)
  {
    if(!$this->seqsLoaded) {
      if (($e = $this->initSequences()) !== true) {
        return $e;
      }
    }
    
    return isset($this->sequences[ strtoupper($key) ]);
  }

  function getSequences()
  {
    if(!$this->seqsLoaded) {
      if (($e = $this->initSequences()) !== true) {
        return $e;
      }
    }
    
    return array_values($this->sequences); //re-key [numerically]
  }

}

---

This file is part of the Creole[php4] library.