mysqlStatement.php

Go to the documentation of this file.

<?php

include_once 'mysqlResultset.php';

/**
 * MySQL 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: mysqlStatement.php,v 1.5 2008-01-19 15:16:18-05 mt_jordan Exp $
 */

class mysqlStatement
{
    /**********************************************
     * Internal variables
     *********************************************/

    /**
     * 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();

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

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

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

    /**
     * Escape 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 = "'" . mysqli_real_escape_string( $this->objConnection->connection(), $param ) . "'";
        }

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

    /**
     * Execute prepared statement and return resultset object
     *
     * @access public
     * @return mixed
     */
    public function execute()
    {
        $objResult = mysqli_query( $this->objConnection->connection(), $this->objPrepareSQL() )
        or trigger_error( mysqli_error( $this->objConnection->connection() ), E_USER_WARNING );

        return new mysqlResultset( $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()
    {
        $objResult = mysqli_query( $this->objConnection->connection(), $this->objQuery )
        or trigger_error( mysqli_error( $this->objConnection->connection() ), E_USER_WARNING );

        return new mysqlResultset( $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;

        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;
    }

    /**
     * Dummy method to prevent class error for dbs that do not support sequences - used with prepared statement
     *
     * @access public
     */
    public function sequence() {}
}

?>