Home | Classes | Modules | Annotated | Functions | Files

TableDataSet.php

Go to the documentation of this file.

<?php

/*
 *  $Id: TableDataSet.php,v 1.3 2004/05/22 12:56:30 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>.
 * 
 * This product includes software based on the Village framework,  
 * http://share.whichever.com/index.php?SCREEN=village.
 */

require_once 'jargon/DataSet.php';
require_once 'jargon/KeyDef.php';

class TableDataSet extends DataSet 
{
  var $tableName;
  
  var $tableInfo;
  
  var $optimisticLockingCol;
  
  var $where;
  
  var $order;
  
  var $other;
  
  var $refreshOnSave = false;
  
  function TableDataSet(/*Connection*/ &$conn, $tableName, $p3 = null, $p4 = null)
  {
    if (! is_a($conn, 'Connection')) {
      trigger_error (
        "TableDataSet::TableDataSet(): parameter 1 not of type 'Connection' !",
        E_USER_ERROR
      );
    }

    $this->conn =& $conn;
    $this->columns = "*";
    $this->tableName = $tableName;
    
    if ($p4 !== null) {
      $this->columns = $p3;
      $this->keyDef = $p4;
    } 
    else if ($p3 !== null) {
      if (is_a($p3, 'KeyDef')) {
        $this->keyDef =& $p3;
      } else { // it's a string (column list)
        $this->columns = $p3;
      }
    }
  }

  function tableName() 
  {
    return $this->tableName;
  }
      
  function & tableInfo()
  {
    if ($this->tableInfo === null) {
      $dbInfo =& $this->conn->getDatabaseInfo();
      $tblInfo =& $dbInfo->getTable($this->tableName);

      if (Creole::isError($tblInfo)) {
        return $tblInfo;
      }
      $this->tableInfo =& $tblInfo;
    }
    return $this->tableInfo;
  }
           
  function & fetchRecords($p1 = 0, $p2 = null)
  {
    $this->buildSelectString();
    return parent::fetchRecords($p1, $p2);
  }

  function & addRecord()
  {
    $rec =& new Record($this, true);

    if (Creole::isError($rec)) {
      return $rec;
    }
    /* 
    * no need to check return value here as markForInsert() only returns an
    * exception, if $rec->ds is not a TableDataSet
    */
    $rec->markForInsert();
    $this->records[] =& $rec;
    return $rec;
  }

  function save() 
  {
    $i = 0;
    for($j=count($this->records); $i < $j; $i++) {
      $rec =& $this->records[$i];
      if (($e = $rec->save()) !== true) {
        return $e;
      }
    }        
    // now go through and remove any records
    // that were previously marked as a zombie by the 
    // delete process
    $this->removeDeletedRecords();
    return $i;
  }

  function removeDeletedRecords() 
  {
    // this algorythm should be a fair bit
    // faster than calling DataSet::removeRecord()
    $new_recs = array();
    for($i=0,$j=count($this->records); $i < $j; $i++) {
      $rec =& $this->records[$i];
      if (!$rec->isAZombie()) {
        $new_recs[] =& $rec;
      }
    }
    $this->records =& $new_recs;
  }

  function setOptimisticLockingColumn($olc)
  {
    $this->optimisticLockingCol = $olc;
  }

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

  function & where($where) 
  {
    if ($where == null) {
      return new DataSetException(0, "null not allowed for where clause");
    }            
    $this->where =& $where;
    return $this;
  }

  function & getWhere()
  {
    return $this->where;
  }

  function & order($order) 
  {
    if ($order === null) {
      return new DataSetException(0, "null not allowed for order clause");
    }
    $this->order =& $order;
    return $this;
  }

  function & getOrder()
  {
    return $this->order;
  }

  function & other($other) 
  {
    if ($other === null) {
      return new DataSetException(0, "null not allowed for other clause");
    }            
    $this->other =& $other;
    return $this;
  }

  function & getOther()
  {
    return $this->other;
  }

  function refresh()
  {
    for($i=0,$j=count($this->records); $i < $j; $i++) {
      $rec =& $this->records[$i];
      if (($e = $rec->refresh()) !== true) {
        return $e;
      }
    }
    return true;
  }

  function setRefreshOnSave($v)
  {
    $this->refreshOnSave = $v;
  }

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

  function getSelectSql()
  {
    return $this->selectSql;     
  }

  function buildSelectString () 
  {
    $this->selectSql = "SELECT ";
    $this->selectSql .= $this->columns;
    $this->selectSql .= " FROM " . $this->tableName;
    if ($this->where !== null && $this->where !== "") {
      $this->selectSql .= " WHERE " . $this->where;
    }
    if ($this->order !== null && $this->order !== "") {
      $this->selectSql .= " ORDER BY " . $this->order;
    }
    if ($this->other !== null && $this->other !== "") {
      $this->selectSql .= $this->other;
    }
  }
}

---

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