Home | Classes | Modules | Annotated | Functions | Files

TableInfo.php

Go to the documentation of this file.

<?php

/*
 *  $Id: TableInfo.php,v 1.3 2004/04/27 19:18:16 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 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)

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

  var $pkLoaded = false;
  var $fksLoaded = false;
  var $indexesLoaded = false;
  var $colsLoaded = false;

  var $conn;

  var $database;

  var $dblink;

  var $dbname;

  function TableInfo(/*DatabaseInfo*/ &$database, $name) 
  {
    if (! is_a($database, 'DatabaseInfo')) {
      trigger_error(
        "TableInfo::TableInfo(): parameter 1 not of type 'DatabaseInfo' !",
        E_USER_ERROR
      );
    }
    $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
    for($i=0,$j=count($this->columns); $i < $j; $i++) {
      $col =& $this->columns[$i];
      $col->table =& $this;
    }
  }

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

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

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

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


  function & getPrimaryKey()
  {
    if(!$this->pkLoaded) {
      if (($e = $this->initPrimaryKey()) !== true) {
        return $e;
      }
    }
    return $this->primaryKey;
  }

  function & getColumn($name)
  {
    if(!$this->colsLoaded) {
      if (($e = $this->initColumns()) !== true) {
        return $e;
      }
    }
    
    if (!isset($this->columns[$name])) {
      return new SQLException(CREOLE_ERROR_NOSUCHFIELD, "Table `".$this->name."` has no column `".$name."`");
    }
    
    return $this->columns[$name];
  }

  function & getColumns()
  {
    if(!$this->colsLoaded) {
      if (($e = $this->initColumns()) !== true) {
        return $e;
      }
    }
    return array_values($this->columns); // re-key numerically
  }

  function & getForeignKey($name)
  {
    if(!$this->fksLoaded) {
      if (($e = $this->initForeignKeys()) !== true) {
        return $e;
      }
    }
    if (!isset($this->foreignKeys[$name])) {
      return new SQLException(CREOLE_ERROR_NOSUCHFIELD, "Table `".$this->name."` has no foreign key `".$name."`");
    }
    return $this->foreignKeys[$name];
  }

  function & getForeignKeys()
  {
    if(!$this->fksLoaded) {
      if (($e = $this->initForeignKeys()) !== true) {
        return $e;
      }
    }
    
    return array_values($this->foreignKeys);
  }

  function & getIndex($name)
  {
    if(!$this->indexesLoaded) {
      if (($e = $this->initIndexes()) !== true) {
        return $e;
      }
    }
    if (!isset($this->indexes[$name])) {
      return new SQLException(CREOLE_ERROR_NOSUCHFIELD, "Table `".$this->name."` has no index `".$name."`");
    }
    return @$this->indexes[$name];
  }

  function & getIndexes()
  {
    if(!$this->indexesLoaded) {
      if (($e = $this->initIndexes()) !== true) {
        return $e;
      }
    }
    return array_values($this->indexes);
  }

  function & getIndices()
  {
    return $this->getIndexes();
  }

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

  function toString()
  {
    return $this->name;
  }

  function foreignKeysLoaded()
  {
    return $this->fksLoaded;
  }

  function primaryKeyLoaded()
  {
    return $this->pkLoaded;
  }

  function columnsLoaded()
  {
    return $this->colsLoaded;
  }

  function indexesLoaded()
  {
    return $this->indexesLoaded;
  }

  function addColumn(/*ColumnInfo*/ &$column)
  {
      if (! is_a($column, 'ColumnInfo')) {
        trigger_error(
          "TableInfo::addColumn(): parameter 1 not of type 'ColumnInfo' !",
          E_USER_ERROR
        );
      }
    $this->columns[$column->getName()] =& $column;
  }

  function & getDatabase()
  {
    return $this->database;
  }
}

---

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