Home | Classes | Modules | Annotated | Hierarchy | Functions | Files

DatabaseInfo.php

Go to the documentation of this file.

<?php

/*
 *  $Id: DatabaseInfo.php,v 1.11 2004/03/20 04:16:50 hlellelid 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>.
 */

abstract class DatabaseInfo {
    
    protected $tables = array();
    
    protected $sequences = array();

    protected $tablesLoaded = false;
    
    protected $seqsLoaded = false;        
    
    protected $conn;
    
    protected $dbname;
    
    protected $dblink;
    
    public function __construct(Connection $conn)
    {
        $this->conn = $conn;    
        $this->dblink = $conn->getResource();
        $dsn = $conn->getDSN();
        $this->dbname = $dsn['database'];
    }

    public 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
        foreach($this->tables as $tbl) {
            $tbl->database = $this;
            $tbl->dbname = $this->dbname;
            $tbl->dblink = $this->dblink;
            $tbl->schema = $this->schema;
        }
    }
    
    public function getConnection()
    {
        return $this->conn;
    }
    
    public function getTable($name)
    {        
        if(!$this->tablesLoaded) $this->initTables();
        if (!isset($this->tables[strtoupper($name)])) {
            throw new SQLException("Database `".$this->name."` has no table `".$name."`");
        }
        return $this->tables[ strtoupper($name) ];
    }        
    
    public function getTables()
    {
        if(!$this->tablesLoaded) $this->initTables();
        return array_values($this->tables); //re-key [numerically]
    }
        
    public function addTable(TableInfo $table)
    {
        $this->tables[strtoupper($table->getName())] = $table;
    }
    
    abstract protected function initTables();
    
    // 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.
    
    abstract protected function initSequences();
    
    public function isSequence($key)
    {
        if(!$this->seqsLoaded) $this->initSequences();
        return isset($this->sequences[ strtoupper($key) ]);
    }
    
    public function getSequences()
    {
        if(!$this->seqsLoaded) $this->initSequences();
        return array_values($this->sequences); //re-key [numerically]
    }
    
}

---

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