sqlite3Resultset.php

Go to the documentation of this file.

<?php

/**
 * SQLite3 query resultset class
 *
 * @package objSQL
 * @version 2.1.0
 * @author MT Jordan <mtjo62@gmail.com>
 * @link http://objsql.sourceforge.net
 * @copyright 2004-2010 openSource Partners
 * @license LGPL
 * @revision $Id: sqlite3Resultset.php,v 1.0 2010-06-01 10:28:58-05 mt_jordan Exp $
 */

class sqlite3Resultset
{
    /**********************************************
     * Internal variables
     *********************************************/

    /**
     * Database connection object
     *
     * @access private
     * @var mixed
     */
    private $objConnection;

    /**
     * Query record
     *
     * @access private
     * @var array
     */
    private $objRecord = array();

    /**
     * Query resultset object
     *
     * @access private
     * @var mixed
     */
    private $objResult;

    /**********************************************
     * Class methods
     *********************************************/

    /**
     * Constructor
     *
     * @access public
     * @param  mixed $result
     * @param  mixed $connection
     */
    public function __construct( $result, $connection )
    {
        $this->objConnection = $connection;
        $this->objResult     = $result;
    }

    /**
     * Return num of affected rows from insert/delete/update query
     *
     * @access public
     * @return int
     */
    public function affected_rows()
    {
        if ( $this->objResult )
            return $this->objConnection->changes();
    }

    /**
     * Return resultset as assoc array
     *
     * @access public
     * @return mixed
     */
    public function fetch_array()
    {
        if ( $this->objResult )
        {
            $this->objRecord = $this->objResult->fetchArray( SQLITE3_ASSOC );

            return ( $this->objRecord !== false );
        }
    }

   /**
     * Return resultset as object
     *
     * @access public
     * @return bool
     */
    public function fetch_object()
    {
        trigger_error( '<p>SQLite3 does not support FETCH_OBJECT. You must use the SQLite or PDO extension!</p>', E_USER_WARNING );
        return false;
    }

    /**
     * Return resultset as numeric array
     *
     * @access public
     * @return mixed
     */
    public function fetch_row()
    {
        if ( $this->objResult )
        {
            $this->objRecord = $this->objResult->fetchArray( SQLITE3_NUM );

            return ( $this->objRecord !== false );
        }
    }

    /**
     * Return record from select query
     *
     * @access public
     * @param  mixed $field
     * @return mixed
     */
    public function field( $field )
    {
        if ( $this->objResult )
        {
            if ( get_magic_quotes_runtime() )
                return stripslashes( $this->objRecord[$field] );
            else
                return $this->objRecord[$field];
        }
    }

    /**
     * Free resultset memory - destroy resultset object
     *
     * @access public
     */
    public function flush()
    {
        if ( $this->objResult )
        {
            unset( $this->objConnection );
            $this->objRecord = array();
            
            return ( $this->objResult->finalize() ) ? true : false;
        }
    }

    /**
     * Return num fields from select query
     *
     * @access public
     * @return int
     */
    public function num_fields()
    {
        if ( $this->objResult )
            return $this->objResult->numColumns();
    }

    /**
     * Return num rows from select query - MUST be used with "select count(*)"
     *
     * @access public
     * @return int
     */
    public function num_rows()
    {
        if ( $this->objResult )
        {
            while ( $row = $this->objResult->fetchArray( SQLITE3_NUM ) )
                return $row[0];
        }        
    }

    /**
     * Return resultset object
     *
     * @access public
     * @return mixed
     */
    public function result()
    {
        return $this->objResult;
    }
}

?>