firebirdStatement.php

Go to the documentation of this file.

<?php

require 'firebirdResultset.php';

/**
 * Firebird/Interbase query statement 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: firebirdStatement.php,v 1.5 2008-01-19 23:58:17-05 mt_jordan Exp $
 */

class firebirdStatement
{
    /**********************************************
     * Internal variables
     *********************************************/

    /**
     * Transaction resource
     *
     * @access private
     * @var    mixed
     */
    private $objAutoCommit;

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

    /**
     * Select query limit value
     *
     * @access private
     * @var    int
     */
    private $objLimit = false;

    /**
     * Select query offset value
     *
     * @access private
     * @var    int
     */
    private $objOffset = false;

    /**
     * Prepared statement binding parameters
     *
     * @access private
     * @var    array
     */
    private $objParameters = array();

    /**
     * Transaction savepoint
     *
     * @access private
     * @var    mixed
     */
    private $objSavepoint;

    /**
     * Sequence name
     *
     * @access private
     * @var    mixed
     */
    private $objSequence = false;

    /**
     * Query string
     *
     * @access private
     * @var    str
     */
    private $objQuery;

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

    /**
     * Constructor
     *
     * @access public
     * @param  str   $query
     * @param  mixed $connection
     * @param  bool  $autocommit
     * @param  str   $savepoint
     */
    public function __construct( $query, $connection, $autocommit, $savepoint )
    {
        $this->objAutoCommit = $autocommit;
        $this->objConnection = $connection;
        $this->objSavepoint  = $savepoint;
        $this->objQuery      = $query;
    }

    /**
     * Set and escape bound query parameters
     *
     * @access public
     * @param  mixed $param
     * @param  bool  $no_quotes
     */
    function bind( $param, $no_quotes=false )
    {
        //if $param is numeric str, do not add quotes
        if ( ( is_string( $param ) && !is_numeric( $param ) ) && !$no_quotes )
        {
            if ( get_magic_quotes_gpc() )
                $param = stripslashes( $param );

            $param = str_replace( "'", "''", $param );
            $param = "'" . $param . "'";
        }

        $this->objParameters[] = $param;
    }

    /**
     * Execute prepared query and return resultset object
     *
     * @access public
     * @return mixed
     */
    public function execute()
    {
        if ( is_resource( $this->objAutoCommit ) && stripos( $this->objPrepareSQL(), 'select' ) === false )
        {
            if ( $this->objSavepoint )
                $objResult = ibase_query( $this->objSavepoint, $this->objPrepareSQL() )
                or trigger_error( ibase_errmsg(), E_USER_WARNING );
            else
                $objResult = ibase_query( $this->objAutoCommit, $this->objPrepareSQL() )
                or trigger_error( ibase_errmsg(), E_USER_WARNING );
        }
        else
        {
            $objResult = ibase_query( $this->objConnection->connection(), $this->objPrepareSQL() )
            or trigger_error( ibase_errmsg(), E_USER_WARNING );
        }

        return new firebirdResultset( $objResult, $this->objConnection->connection() );
    }

    /**
     * Set limit int value
     *
     * @access public
     * @param  int $limit
     */
    public function limit( $limit )
    {
        //make sure $limit is an unsigned int > 0
        $this->objLimit = ( is_numeric( $limit ) && $limit > 0 ) ? ( int )$limit : 1;
    }

    /**
     * Execute non-prepared query and return resultset object
     *
     * @access public
     * @return mixed
     */
    public function objExecuteNonPrepared()
    {
        if ( is_resource( $this->objAutoCommit ) && stripos( $this->objQuery, 'select' ) === false )
        {
            if ( $this->objSavepoint )
                $objResult = ibase_query( $this->objSavepoint, $this->objQuery )
                or trigger_error( ibase_errmsg(), E_USER_WARNING );
            else
                $objResult = ibase_query( $this->objAutoCommit, $this->objQuery )
                or trigger_error( ibase_errmsg(), E_USER_WARNING );
        }
        else
        {
            $objResult = ibase_query( $this->objConnection->connection(), $this->objQuery )
            or trigger_error( ibase_errmsg(), E_USER_WARNING );
        }

        return new firebirdResultset( $objResult, $this->objConnection->connection() );
    }

    /**
     * Prepare query string and bind parameters
     *
     * @access private
     * @return str
     */
    private function objPrepareSQL()
    {
        $objSqlParts = explode( '?', $this->objQuery );
        $objQuery    = $objSqlParts[0];

        for ( $i = 1; $i < count( $objSqlParts ); $i++ )
            $objQuery .= $this->objParameters[$i - 1] . $objSqlParts[$i];

        $objQuery = ( $this->objLimit ) ? str_ireplace( ':limit', $this->objLimit, $objQuery ) : $objQuery;
        $objQuery = ( $this->objOffset ) ? str_ireplace( ':offset', $this->objOffset, $objQuery ) : $objQuery;
        $objQuery = ( $this->objSequence ) ? str_ireplace( ':seq', $this->objSequence, $objQuery ) : $objQuery;

        return $objQuery;
    }

    /**
     * Set offset int value
     *
     * @access public
     * @param  int $offset
     */
    public function offset( $offset )
    {
        //make sure $offset is an unsigned int > 0
        $this->objOffset = ( is_numeric( $offset ) && $offset > 0 ) ? ( int )$offset : 1;
    }

    /**
     * Get value for named sequence
     *
     * @access public
     * @param  str $sequence
     */
    public function sequence( $sequence )
    {
        $this->objSequence = ibase_gen_id( $sequence, 1, $this->objConnection->connection() );
    }
}

?>