db2Resultset.php

Go to the documentation of this file.

<?php

/**
 * DB2 database 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: db2Resultset.php,v 1.6 2008-01-27 12:48:58-05 mt_jordan Exp $
 */

class db2Resultset
{
    /**********************************************
     * Internal variables
     *********************************************/

    /**
     * Resultset 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
     */
    public function __construct( $result )
    {
        $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 db2_num_rows( $this->objResult );
    }

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

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

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

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

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

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

    /**
     * Free resultset memory - destroy resultset object
     *
     * @access public
     */
    public function flush()
    {
        if ( $this->objResult )
        {
            db2_free_result( $this->objResult );
            $this->objRecord = array();
            $this->objResult = null;
        }
    }

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

    /**
     * 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 = db2_fetch_array( $this->objResult ) )
                return $row[0];
        }
    }

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

?>