Home | Classes | Modules | Annotated | Functions | Files

ResultSetCommon.php

Go to the documentation of this file.

<?php
/*
 *  $Id: ResultSetCommon.php,v 1.4 2004/05/06 19:47:34 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>.
 */

require_once 'creole/ResultSet.php';

class ResultSetCommon extends ResultSet
{
  var $fetchmode;

  var $conn;

  var $result;

  var $cursorPos = 0;

  var $fields;

  var $ignoreAssocCase = false;

  function ResultSetCommon(/*Connection*/ &$conn, &$result, $fetchmode = null)
  {
    if (! is_a($conn, 'Connection')) {
      trigger_error (
        "ResultSetCommon::ResultSetCommon(): parameter 1 not of type 'Connection' !",
        E_USER_ERROR
      );
    }

    $this->conn =& $conn;
    $this->result =& $result;
    
    if ($fetchmode !== null) {
      $this->fetchmode = $fetchmode;
    } else {
      $this->fetchmode = ResultSet::FETCHMODE_ASSOC(); // default
    }
    
    $this->ignoreAssocCase = (($conn->getFlags() & Creole::NO_ASSOC_LOWER()) === Creole::NO_ASSOC_LOWER());
    
    register_shutdown_function(array($this, '__ResultSetCommon'));
  }

  function __ResultSetCommon()
  {
    $this->close();
  }
  
  function & getIterator()
  {
      require_once 'creole/ResultSetIterator.php';
      return new ResultSetIterator($this);
  }

  function & getResource()
  {
      return $this->result;
  }

  function isIgnoreAssocCase()
  {
      return $this->ignoreAssocCase;
  }

  function setFetchmode($mode)
  {
      $this->fetchmode = $mode;
  }

  function getFetchmode()
  {
      return $this->fetchmode;
  }

  function & previous()
  {
    // Go back 2 spaces so that we can then advance 1 space.
    $ok = $this->seek($this->cursorPos - 2);
    if ($ok === false) {
        $this->beforeFirst();
        return false;
    }
    return $this->next();
  }

  function relative($offset)
  {
      // which absolute row number are we seeking
      $pos = $this->cursorPos + ($offset - 1);
      $ok = $this->seek($pos);

      if ($ok === false) {
          if ($pos < 0) {
              $this->beforeFirst();
          } else {
              $this->afterLast();
          }
      } else {
          $ok = $this->next();
      }

      return $ok;
  }

  function absolute($pos)
  {
      $ok = $this->seek( $pos - 1 ); // compensate for next() factor
      if ($ok === false) {
          if ($pos - 1 < 0) {
              $this->beforeFirst();
          } else {
              $this->afterLast();
          }
      } else {
          $ok = $this->next();
      }
      return $ok;
  }

  function & first()
  {
      if($this->cursorPos !== 0) { $this->seek(0); }
      return $this->next();
  }

  function & last()
  {
    $last = $this->getRecordCount();
    if (Creole::isError($last)) {
      return $last;
    }

    if($this->cursorPos !==  ($last = $last - 1)) {
      $this->seek( $last );
    }

    return $this->next();
  }

  function beforeFirst()
  {
      $this->cursorPos = 0;
  }


  function afterLast()
  {
    $rc = $this->getRecordCount();
    if (Creole::isError($rc)) {
      return $rc;
    }

    $this->cursorPos = $rc + 1;
    return true;
  }


  function isAfterLast()
  {
      return ($this->cursorPos === $this->getRecordCount() + 1);
  }

  function isBeforeFirst()
  {
      return ($this->cursorPos === 0);
  }

  function getCursorPos()
  {
      return $this->cursorPos;
  }

  function & getRow()
  {
      return $this->fields;
  }

  function get($column)
  {
      $idx = (is_int($column) ? $column - 1 : $column);
      if (!array_key_exists($idx, $this->fields)) {
        return new SQLException(CREOLE_ERROR_INVALID, "Invalid resultset column: " . $column);
      }
      return $this->fields[$idx];
  }

  function getArray($column)
  {
      $idx = (is_int($column) ? $column - 1 : $column);
      if (!array_key_exists($idx, $this->fields)) {
        return new SQLException(CREOLE_ERROR_INVALID, "Invalid resultset column: " . $column);
      }
      if ($this->fields[$idx] === null) { return null; }
      return (array) unserialize($this->fields[$idx]);
  }

  function getBoolean($column)
  {
      $idx = (is_int($column) ? $column - 1 : $column);
      if (!array_key_exists($idx, $this->fields)) {
        return new SQLException(CREOLE_ERROR_INVALID, "Invalid resultset column: " . $column);
      }
      if ($this->fields[$idx] === null) { return null; }
      return (boolean) $this->fields[$idx];
  }

  function getBlob($column)
  {
    $idx = (is_int($column) ? $column - 1 : $column);
    if (!array_key_exists($idx, $this->fields)) {
      return new SQLException(CREOLE_ERROR_INVALID, "Invalid resultset column: " . $column);
    }

    if ($this->fields[$idx] === null) { return null; }
    require_once 'creole/util/Blob.php';
    $b = new Blob();
    $b->setContents($this->fields[$idx]);
    return $b;
  }

  function getClob($column)
  {
    $idx = (is_int($column) ? $column - 1 : $column);
    if (!array_key_exists($idx, $this->fields)) {
      return new SQLException(CREOLE_ERROR_INVALID, "Invalid resultset column: " . $column);
    }

    if ($this->fields[$idx] === null) { return null; }
    require_once 'creole/util/Clob.php';
    $c = new Clob();
    $c->setContents($this->fields[$idx]);
    return $c;
  }

  function getDate($column, $format = '%x')
  {
    $idx = (is_int($column) ? $column - 1 : $column);
    if (!array_key_exists($idx, $this->fields)) {
      return new SQLException(CREOLE_ERROR_INVALID, "Invalid resultset column: " . $column);
    }

    if ($this->fields[$idx] === null) { return null; }
    $ts = strtotime($this->fields[$idx]);
    if ($ts === -1) {
      return new SQLException(CREOLE_ERROR_INVALID, "Unable to convert value at column " . $column . " to timestamp: " . $this->fields[$idx]);
    }
    if ($ts === null) {
      return $ts;
    }
    if (strpos($format, '%') !== false) {
        return strftime($format, $ts);
    } else {
        return date($format, $ts);
    }
  }

  function getFloat($column)
  {
    $idx = (is_int($column) ? $column - 1 : $column);
    if (!array_key_exists($idx, $this->fields)) {
      return new SQLException(CREOLE_ERROR_INVALID, "Invalid resultset column: " . $column);
    }

    if ($this->fields[$idx] === null) { return null; }
    return (float) $this->fields[$idx];
  }

  function getInt($column)
  {
    $idx = (is_int($column) ? $column - 1 : $column);
    if (!array_key_exists($idx, $this->fields)) {
      return new SQLException(CREOLE_ERROR_INVALID, "Invalid resultset column: " . $column);
    }

    if ($this->fields[$idx] === null) { return null; }
    return (int) $this->fields[$idx];
  }

  function getString($column)
  {
    $idx = (is_int($column) ? $column - 1 : $column);
    if (!array_key_exists($idx, $this->fields)) {
      return new SQLException(CREOLE_ERROR_INVALID, "Invalid resultset column: " . $column);
    }

    if ($this->fields[$idx] === null) { return null; }
    return rtrim((string) $this->fields[$idx]);
  }

  function getTime($column, $format = '%X')
  {
    $idx = (is_int($column) ? $column - 1 : $column);
    if (!array_key_exists($idx, $this->fields)) {
      return new SQLException(CREOLE_ERROR_INVALID, "Invalid resultset column: " . $column);
    }

    if ($this->fields[$idx] === null) { return null; }

    $ts = strtotime($this->fields[$idx]);

    if ($ts === -1) {
      return new SQLException(CREOLE_ERROR_INVALID, "Unable to convert value at column " . (is_int($column) ? $column + 1 : $column) . " to timestamp: " . $this->fields[$idx]);
    }

    if ($ts === null) {
      return $ts;
    }

    if (strpos($format, '%') !== false) {
        return strftime($format, $ts);
    } else {
        return date($format, $ts);
    }
  }

  function getTimestamp($column, $format = 'Y-m-d H:i:s')
  {
    $idx = (is_int($column) ? $column - 1 : $column);
    if (!array_key_exists($idx, $this->fields)) {
      return new SQLException(CREOLE_ERROR_INVALID, "Invalid resultset column: " . $column);
    }

    if ($this->fields[$idx] === null) { return null; }

    $ts = strtotime($this->fields[$idx]);
    if ($ts === -1) {
      return new SQLException(CREOLE_ERROR_INVALID, "Unable to convert value at column " . $column . " to timestamp: " . $this->fields[$idx]);
    }
    if ($ts === null) {
      return $ts;
    }
    if (strpos($format, '%') !== false) {
        return strftime($format, $ts);
    } else {
        return date($format, $ts);
    }
  }

}

---

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