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

TableDataSet.php

Go to the documentation of this file.

<?php

/*
 *  $Id: TableDataSet.php,v 1.3 2004/03/20 04:16:51 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>.
 * 
 * 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 {
    
    private $tableName;
    
    private $tableInfo;
    
    private $optimisticLockingCol;
    
    private $where;
    
    private $order;
    
    private $other;
    
    private $refreshOnSave = false;
    
    public function __construct(Connection $conn, $tableName, $p3 = null, $p4 = null)
    {
        $this->conn = $conn;
        $this->columns = "*";
        $this->tableName = $tableName;
        
        if ($p4 !== null) {
            $this->columns = $p3;
            $this->keyDef = $p4;
        } elseif ($p3 !== null) {
            if ($p3 instanceof KeyDef) {
                $this->keyDef = $p3;
            } else { // it's a string (column list)
                $this->columns = $p3;
            }
        }
    }

    public function tableName() 
    {
        return $this->tableName;
    }
        
    public function tableInfo()
    {
        if ($this->tableInfo === null) {
            $this->tableInfo = $this->conn->getDatabaseInfo()->getTable($this->tableName);
        }
        return $this->tableInfo;
    }
             
    public function fetchRecords($p1 = 0, $p2 = null)
    {
        $this->buildSelectString();
        return parent::fetchRecords($p1, $p2);
    }

    public function addRecord()
    {
        $rec = new Record($this, true);
        $rec->markForInsert();
        $this->records[] = $rec;
        return $rec;
    }

    public function save() 
    {
        $j = 0;
        foreach($this->records as $rec) {
            $rec->save();
            $j++;
        }        
        // now go through and remove any records
        // that were previously marked as a zombie by the 
        // delete process
        $this->removeDeletedRecords();
        return $j;
    }

    public function removeDeletedRecords() 
    {
        // this algorythm should be a fair bit
        // faster than calling DataSet::removeRecord()
        $new_recs = array();
        foreach($this->records as $rec) {
            if (!$rec->isAZombie()) {
                $new_recs[] = $rec;
            }
        }
        $this->records = $new_recs;
    }

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

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

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

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

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

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

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

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

    public function refresh()
    {
        foreach($this->records as $rec) {
            $rec->refresh($this->conn);
        }
    }

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

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

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

    private 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[php5] library.