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

TableInfo.php

Go to the documentation of this file.

<?php

/*
 *  $Id: TableInfo.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 TableInfo {

     // FIXME
     //    - Currently all member attributes are public.  This should be fixed
     // when PHP's magic __sleep() and __wakeup() functions & serialization support
     // handles protected/private members. (if ever)

    protected $name;
    protected $columns = array();
    protected $foreignKeys = array();
    protected $indexes = array();
    protected $primaryKey;

    protected $pkLoaded = false;
    protected $fksLoaded = false;
    protected $indexesLoaded = false;
    protected $colsLoaded = false;
    
    protected $conn;
        
    protected $database;
    
    protected $dblink;
     
    protected $dbname;
    
    function __construct(DatabaseInfo $database, $name) {
        $this->database = $database;
        $this->name = $name;
        $this->conn = $database->getConnection(); // shortcut because all drivers need this for the queries    
        $this->dblink = $this->conn->getResource();
        $this->dbname = $database->getName();    
    }

    function __sleep()
    {
        return array('name', 'columns', 'foreignKeys', 'indexes', 'primaryKey');
    }
    
    function __wakeup() 
    {
        // restore chaining
        foreach($this->columns as $col) {
            $col->table = $this;
        }
    }

    abstract protected function initColumns();    
    
    abstract protected function initPrimaryKey();

    abstract protected function initForeignKeys();

    abstract protected function initIndexes();
    

    public function getPrimaryKey()
    {
        if(!$this->pkLoaded) $this->initPrimaryKey();
        return $this->primaryKey;
    }    
    
    public function getColumn($name)
    {
        if(!$this->colsLoaded) $this->initColumns();
        if (!isset($this->columns[$name])) {
            throw new SQLException("Table `".$this->name."` has no column `".$name."`");
        }
        return $this->columns[$name];
    }
    
    public function getColumns()
    {
        if(!$this->colsLoaded) $this->initColumns();
        return array_values($this->columns); // re-key numerically
    }
    
    public function getForeignKey($name)
    {
        if(!$this->fksLoaded) $this->initForeignKeys();
        if (!isset($this->foreignKeys[$name])) {
            throw new SQLException("Table `".$this->name."` has no foreign key `".$name."`");
        }
        return $this->foreignKeys[$name];
    }
    
    public function getForeignKeys()
    {
        if(!$this->fksLoaded) $this->initForeignKeys();
        return array_values($this->foreignKeys);
    }
    
    public function getIndex($name)
    {
        if(!$this->indexesLoaded) $this->initIndexes();
        if (!isset($this->indexes[$name])) {
            throw new SQLException("Table `".$this->name."` has no index `".$name."`");
        }
        return @$this->indexes[$name];
    }

    public function getIndexes()
    {
        if(!$this->indexesLoaded) $this->initIndexes();
        return array_values($this->indexes);
    }
    
    public function getIndices()
    {
        return $this->getIndexes();
    }
    
    public function getName()
    {
        return $this->name;
    }
    
    public function toString()
    {
        return $this->name;
    }
    
    public function foreignKeysLoaded()
    {
        return $this->fksLoaded;
    }
    
    public function primaryKeyLoaded()
    {
        return $this->pkLoaded;
    }
    
    public function columnsLoaded()
    {
        return $this->colsLoaded;
    }
    
    public function indexesLoaded()
    {
        return $this->indexesLoaded;
    }
    
    public function addColumn(ColumnInfo $column)
    {
        $this->columns[$column->getName()] = $column;
    }
    
    public function getDatabase()
    {
        return $this->database;
    }
}

---

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