WebSVN – Applications.papyrus – Diff – /trunk/api/pear/DB/mssql.php


<?php
 
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
 
/**
 * The PEAR DB driver for PHP's mssql extension
 * for interacting with Microsoft SQL Server databases
 *
 * PHP versions 4 and 5
 *
 * LICENSE: This source file is subject to version 3.0 of the PHP license
 * that is available through the world-wide-web at the following URI:
 * http://www.php.net/license/3_0.txt.  If you did not receive a copy of
 * the PHP License and are unable to obtain it through the web, please
 * send a note to license@php.net so we can mail you a copy immediately.
 *
 * @category   Database
 * @package    DB
 * @author     Sterling Hughes <sterling@php.net>
 * @author     Daniel Convissor <danielc@php.net>
 * @copyright  1997-2005 The PHP Group
 * @license    http://www.php.net/license/3_0.txt  PHP License 3.0
 * @version    CVS: $Id: mssql.php,v 1.2 2005-09-20 17:01:22 ddelon Exp $
 * @link       http://pear.php.net/package/DB
 */
 
/**
 * Obtain the DB_common class so it can be extended from
 */
require_once 'DB/common.php';
 
/**
 * The methods PEAR DB uses to interact with PHP's mssql extension
 * for interacting with Microsoft SQL Server databases
 *
 * These methods overload the ones declared in DB_common.
 *
 * @category   Database
 * @package    DB
 * @author     Sterling Hughes <sterling@php.net>
 * @author     Daniel Convissor <danielc@php.net>
 * @copyright  1997-2005 The PHP Group
 * @license    http://www.php.net/license/3_0.txt  PHP License 3.0
 * @version    Release: @package_version@
 * @link       http://pear.php.net/package/DB
 */
class DB_mssql extends DB_common
{
    // {{{ properties
 
    /**
     * The DB driver type (mysql, oci8, odbc, etc.)
     * @var string
     */
    var $phptype = 'mssql';
 
    /**
     * The database syntax variant to be used (db2, access, etc.), if any
     * @var string
     */
    var $dbsyntax = 'mssql';
 
    /**
     * The capabilities of this DB implementation
     *
     * The 'new_link' element contains the PHP version that first provided
     * new_link support for this DBMS.  Contains false if it's unsupported.
     *
     * Meaning of the 'limit' element:
     *   + 'emulate' = emulate with fetch row by number
     *   + 'alter'   = alter the query
     *   + false     = skip rows
     *
     * @var array
     */
    var $features = array(
        'limit'         => 'emulate',
        'new_link'      => false,
        'numrows'       => true,
        'pconnect'      => true,
        'prepare'       => false,
        'ssl'           => false,
        'transactions'  => true,
    );
 
    /**
     * A mapping of native error codes to DB error codes
     * @var array
     */
    // XXX Add here error codes ie: 'S100E' => DB_ERROR_SYNTAX
    var $errorcode_map = array(
        110   => DB_ERROR_VALUE_COUNT_ON_ROW,
        155   => DB_ERROR_NOSUCHFIELD,
        170   => DB_ERROR_SYNTAX,
        207   => DB_ERROR_NOSUCHFIELD,
        208   => DB_ERROR_NOSUCHTABLE,
        245   => DB_ERROR_INVALID_NUMBER,
        515   => DB_ERROR_CONSTRAINT_NOT_NULL,
        547   => DB_ERROR_CONSTRAINT,
        1913  => DB_ERROR_ALREADY_EXISTS,
        2627  => DB_ERROR_CONSTRAINT,
        2714  => DB_ERROR_ALREADY_EXISTS,
        3701  => DB_ERROR_NOSUCHTABLE,
        8134  => DB_ERROR_DIVZERO,
    );
 
    /**
     * The raw database connection created by PHP
     * @var resource
     */
    var $connection;
 
    /**
     * The DSN information for connecting to a database
     * @var array
     */
    var $dsn = array();
 
 
    /**
     * Should data manipulation queries be committed automatically?
     * @var bool
     * @access private
     */
    var $autocommit = true;
 
    /**
     * The quantity of transactions begun
     *
     * {@internal  While this is private, it can't actually be designated
     * private in PHP 5 because it is directly accessed in the test suite.}}
     *
     * @var integer
     * @access private
     */
    var $transaction_opcount = 0;
 
    /**
     * The database specified in the DSN
     *
     * It's a fix to allow calls to different databases in the same script.
     *
     * @var string
     * @access private
     */
    var $_db = null;
 
 
    // }}}
    // {{{ constructor
 
    /**
     * This constructor calls <kbd>$this->DB_common()</kbd>
     *
     * @return void
     */
    function DB_mssql()
    {
        $this->DB_common();
    }
 
    // }}}
    // {{{ connect()
 
    /**
     * Connect to the database server, log in and open the database
     *
     * Don't call this method directly.  Use DB::connect() instead.
     *
     * @param array $dsn         the data source name
     * @param bool  $persistent  should the connection be persistent?
     *
     * @return int  DB_OK on success. A DB_Error object on failure.
     */
    function connect($dsn, $persistent = false)
    {
        if (!PEAR::loadExtension('mssql') && !PEAR::loadExtension('sybase')
            && !PEAR::loadExtension('sybase_ct'))
        {
            return $this->raiseError(DB_ERROR_EXTENSION_NOT_FOUND);
        }
 
        $this->dsn = $dsn;
        if ($dsn['dbsyntax']) {
            $this->dbsyntax = $dsn['dbsyntax'];
        }
 
        $params = array(
            $dsn['hostspec'] ? $dsn['hostspec'] : 'localhost',
            $dsn['username'] ? $dsn['username'] : null,
            $dsn['password'] ? $dsn['password'] : null,
        );
        if ($dsn['port']) {
            $params[0] .= ((substr(PHP_OS, 0, 3) == 'WIN') ? ',' : ':')
                        . $dsn['port'];
        }
 
        $connect_function = $persistent ? 'mssql_pconnect' : 'mssql_connect';
 
        $this->connection = @call_user_func_array($connect_function, $params);
 
        if (!$this->connection) {
            return $this->raiseError(DB_ERROR_CONNECT_FAILED,
                                     null, null, null,
                                     @mssql_get_last_message());
        }
        if ($dsn['database']) {
            if (!@mssql_select_db($dsn['database'], $this->connection)) {
                return $this->raiseError(DB_ERROR_NODBSELECTED,
                                         null, null, null,
                                         @mssql_get_last_message());
            }
            $this->_db = $dsn['database'];
        }
        return DB_OK;
    }
 
    // }}}
    // {{{ disconnect()
 
    /**
     * Disconnects from the database server
     *
     * @return bool  TRUE on success, FALSE on failure
     */
    function disconnect()
    {
        $ret = @mssql_close($this->connection);
        $this->connection = null;
        return $ret;
    }
 
    // }}}
    // {{{ simpleQuery()
 
    /**
     * Sends a query to the database server
     *
     * @param string  the SQL query string
     *
     * @return mixed  + a PHP result resrouce for successful SELECT queries
     *                + the DB_OK constant for other successful queries
     *                + a DB_Error object on failure
     */
    function simpleQuery($query)
    {
        $ismanip = DB::isManip($query);
        $this->last_query = $query;
        if (!@mssql_select_db($this->_db, $this->connection)) {
            return $this->mssqlRaiseError(DB_ERROR_NODBSELECTED);
        }
        $query = $this->modifyQuery($query);
        if (!$this->autocommit && $ismanip) {
            if ($this->transaction_opcount == 0) {
                $result = @mssql_query('BEGIN TRAN', $this->connection);
                if (!$result) {
                    return $this->mssqlRaiseError();
                }
            }
            $this->transaction_opcount++;
        }
        $result = @mssql_query($query, $this->connection);
        if (!$result) {
            return $this->mssqlRaiseError();
        }
        // Determine which queries that should return data, and which
        // should return an error code only.
        return $ismanip ? DB_OK : $result;
    }
 
    // }}}
    // {{{ nextResult()
 
    /**
     * Move the internal mssql result pointer to the next available result
     *
     * @param a valid fbsql result resource
     *
     * @access public
     *
     * @return true if a result is available otherwise return false
     */
    function nextResult($result)
    {
        return @mssql_next_result($result);
    }
 
    // }}}
    // {{{ fetchInto()
 
    /**
     * Places a row from the result set into the given array
     *
     * Formating of the array and the data therein are configurable.
     * See DB_result::fetchInto() for more information.
     *
     * This method is not meant to be called directly.  Use
     * DB_result::fetchInto() instead.  It can't be declared "protected"
     * because DB_result is a separate object.
     *
     * @param resource $result    the query result resource
     * @param array    $arr       the referenced array to put the data in
     * @param int      $fetchmode how the resulting array should be indexed
     * @param int      $rownum    the row number to fetch (0 = first row)
     *
     * @return mixed  DB_OK on success, NULL when the end of a result set is
     *                 reached or on failure
     *
     * @see DB_result::fetchInto()
     */
    function fetchInto($result, &$arr, $fetchmode, $rownum = null)
    {
        if ($rownum !== null) {
            if (!@mssql_data_seek($result, $rownum)) {
                return null;
            }
        }
        if ($fetchmode & DB_FETCHMODE_ASSOC) {
            $arr = @mssql_fetch_array($result, MSSQL_ASSOC);
            if ($this->options['portability'] & DB_PORTABILITY_LOWERCASE && $arr) {
                $arr = array_change_key_case($arr, CASE_LOWER);
            }
        } else {
            $arr = @mssql_fetch_row($result);
        }
        if (!$arr) {
            return null;
        }
        if ($this->options['portability'] & DB_PORTABILITY_RTRIM) {
            $this->_rtrimArrayValues($arr);
        }
        if ($this->options['portability'] & DB_PORTABILITY_NULL_TO_EMPTY) {
            $this->_convertNullArrayValuesToEmpty($arr);
        }
        return DB_OK;
    }
 
    // }}}
    // {{{ freeResult()
 
    /**
     * Deletes the result set and frees the memory occupied by the result set
     *
     * This method is not meant to be called directly.  Use
     * DB_result::free() instead.  It can't be declared "protected"
     * because DB_result is a separate object.
     *
     * @param resource $result  PHP's query result resource
     *
     * @return bool  TRUE on success, FALSE if $result is invalid
     *
     * @see DB_result::free()
     */
    function freeResult($result)
    {
        return @mssql_free_result($result);
    }
 
    // }}}
    // {{{ numCols()
 
    /**
     * Gets the number of columns in a result set
     *
     * This method is not meant to be called directly.  Use
     * DB_result::numCols() instead.  It can't be declared "protected"
     * because DB_result is a separate object.
     *
     * @param resource $result  PHP's query result resource
     *
     * @return int  the number of columns.  A DB_Error object on failure.
     *
     * @see DB_result::numCols()
     */
    function numCols($result)
    {
        $cols = @mssql_num_fields($result);
        if (!$cols) {
            return $this->mssqlRaiseError();
        }
        return $cols;
    }
 
    // }}}
    // {{{ numRows()
 
    /**
     * Gets the number of rows in a result set
     *
     * This method is not meant to be called directly.  Use
     * DB_result::numRows() instead.  It can't be declared "protected"
     * because DB_result is a separate object.
     *
     * @param resource $result  PHP's query result resource
     *
     * @return int  the number of rows.  A DB_Error object on failure.
     *
     * @see DB_result::numRows()
     */
    function numRows($result)
    {
        $rows = @mssql_num_rows($result);
        if ($rows === false) {
            return $this->mssqlRaiseError();
        }
        return $rows;
    }
 
    // }}}
    // {{{ autoCommit()
 
    /**
     * Enables or disables automatic commits
     *
     * @param bool $onoff  true turns it on, false turns it off
     *
     * @return int  DB_OK on success.  A DB_Error object if the driver
     *               doesn't support auto-committing transactions.
     */
    function autoCommit($onoff = false)
    {
        // XXX if $this->transaction_opcount > 0, we should probably
        // issue a warning here.
        $this->autocommit = $onoff ? true : false;
        return DB_OK;
    }
 
    // }}}
    // {{{ commit()
 
    /**
     * Commits the current transaction
     *
     * @return int  DB_OK on success.  A DB_Error object on failure.
     */
    function commit()
    {
        if ($this->transaction_opcount > 0) {
            if (!@mssql_select_db($this->_db, $this->connection)) {
                return $this->mssqlRaiseError(DB_ERROR_NODBSELECTED);
            }
            $result = @mssql_query('COMMIT TRAN', $this->connection);
            $this->transaction_opcount = 0;
            if (!$result) {
                return $this->mssqlRaiseError();
            }
        }
        return DB_OK;
    }
 
    // }}}
    // {{{ rollback()
 
    /**
     * Reverts the current transaction
     *
     * @return int  DB_OK on success.  A DB_Error object on failure.
     */
    function rollback()
    {
        if ($this->transaction_opcount > 0) {
            if (!@mssql_select_db($this->_db, $this->connection)) {
                return $this->mssqlRaiseError(DB_ERROR_NODBSELECTED);
            }
            $result = @mssql_query('ROLLBACK TRAN', $this->connection);
            $this->transaction_opcount = 0;
            if (!$result) {
                return $this->mssqlRaiseError();
            }
        }
        return DB_OK;
    }
 
    // }}}
    // {{{ affectedRows()
 
    /**
     * Determines the number of rows affected by a data maniuplation query
     *
     * 0 is returned for queries that don't manipulate data.
     *
     * @return int  the number of rows.  A DB_Error object on failure.
     */
    function affectedRows()
    {
        if (DB::isManip($this->last_query)) {
            $res = @mssql_query('select @@rowcount', $this->connection);
            if (!$res) {
                return $this->mssqlRaiseError();
            }
            $ar = @mssql_fetch_row($res);
            if (!$ar) {
                $result = 0;
            } else {
                @mssql_free_result($res);
                $result = $ar[0];
            }
        } else {
            $result = 0;
        }
        return $result;
    }
 
    // }}}
    // {{{ nextId()
 
    /**
     * Returns the next free id in a sequence
     *
     * @param string  $seq_name  name of the sequence
     * @param boolean $ondemand  when true, the seqence is automatically
     *                            created if it does not exist
     *
     * @return int  the next id number in the sequence.
     *               A DB_Error object on failure.
     *
     * @see DB_common::nextID(), DB_common::getSequenceName(),
     *      DB_mssql::createSequence(), DB_mssql::dropSequence()
     */
    function nextId($seq_name, $ondemand = true)
    {
        $seqname = $this->getSequenceName($seq_name);
        if (!@mssql_select_db($this->_db, $this->connection)) {
            return $this->mssqlRaiseError(DB_ERROR_NODBSELECTED);
        }
        $repeat = 0;
        do {
            $this->pushErrorHandling(PEAR_ERROR_RETURN);
            $result = $this->query("INSERT INTO $seqname (vapor) VALUES (0)");
            $this->popErrorHandling();
            if ($ondemand && DB::isError($result) &&
                ($result->getCode() == DB_ERROR || $result->getCode() == DB_ERROR_NOSUCHTABLE))
            {
                $repeat = 1;
                $result = $this->createSequence($seq_name);
                if (DB::isError($result)) {
                    return $this->raiseError($result);
                }
            } elseif (!DB::isError($result)) {
                $result =& $this->query("SELECT @@IDENTITY FROM $seqname");
                $repeat = 0;
            } else {
                $repeat = false;
            }
        } while ($repeat);
        if (DB::isError($result)) {
            return $this->raiseError($result);
        }
        $result = $result->fetchRow(DB_FETCHMODE_ORDERED);
        return $result[0];
    }
 
    /**
     * Creates a new sequence
     *
     * @param string $seq_name  name of the new sequence
     *
     * @return int  DB_OK on success.  A DB_Error object on failure.
     *
     * @see DB_common::createSequence(), DB_common::getSequenceName(),
     *      DB_mssql::nextID(), DB_mssql::dropSequence()
     */
    function createSequence($seq_name)
    {
        return $this->query('CREATE TABLE '
                            . $this->getSequenceName($seq_name)
                            . ' ([id] [int] IDENTITY (1, 1) NOT NULL,'
                            . ' [vapor] [int] NULL)');
    }
 
    // }}}
    // {{{ dropSequence()
 
    /**
     * Deletes a sequence
     *
     * @param string $seq_name  name of the sequence to be deleted
     *
     * @return int  DB_OK on success.  A DB_Error object on failure.
     *
     * @see DB_common::dropSequence(), DB_common::getSequenceName(),
     *      DB_mssql::nextID(), DB_mssql::createSequence()
     */
    function dropSequence($seq_name)
    {
        return $this->query('DROP TABLE ' . $this->getSequenceName($seq_name));
    }
 
    // }}}
    // {{{ quoteIdentifier()
 
    /**
     * Quotes a string so it can be safely used as a table or column name
     *
     * @param string $str  identifier name to be quoted
     *
     * @return string  quoted identifier string
     *
     * @see DB_common::quoteIdentifier()
     * @since Method available since Release 1.6.0
     */
    function quoteIdentifier($str)
    {
        return '[' . str_replace(']', ']]', $str) . ']';
    }
 
    // }}}
    // {{{ mssqlRaiseError()
 
    /**
     * Produces a DB_Error object regarding the current problem
     *
     * @param int $errno  if the error is being manually raised pass a
     *                     DB_ERROR* constant here.  If this isn't passed
     *                     the error information gathered from the DBMS.
     *
     * @return object  the DB_Error object
     *
     * @see DB_common::raiseError(),
     *      DB_mssql::errorNative(), DB_mssql::errorCode()
     */
    function mssqlRaiseError($code = null)
    {
        $message = @mssql_get_last_message();
        if (!$code) {
            $code = $this->errorNative();
        }
        return $this->raiseError($this->errorCode($code, $message),
                                 null, null, null, "$code - $message");
    }
 
    // }}}
    // {{{ errorNative()
 
    /**
     * Gets the DBMS' native error code produced by the last query
     *
     * @return int  the DBMS' error code
     */
    function errorNative()
    {
        $res = @mssql_query('select @@ERROR as ErrorCode', $this->connection);
        if (!$res) {
            return DB_ERROR;
        }
        $row = @mssql_fetch_row($res);
        return $row[0];
    }
 
    // }}}
    // {{{ errorCode()
 
    /**
     * Determines PEAR::DB error code from mssql's native codes.
     *
     * If <var>$nativecode</var> isn't known yet, it will be looked up.
     *
     * @param  mixed  $nativecode  mssql error code, if known
     * @return integer  an error number from a DB error constant
     * @see errorNative()
     */
    function errorCode($nativecode = null, $msg = '')
    {
        if (!$nativecode) {
            $nativecode = $this->errorNative();
        }
        if (isset($this->errorcode_map[$nativecode])) {
            if ($nativecode == 3701
                && preg_match('/Cannot drop the index/i', $msg))
            {
                return DB_ERROR_NOT_FOUND;
            }
            return $this->errorcode_map[$nativecode];
        } else {
            return DB_ERROR;
        }
    }
 
    // }}}
    // {{{ tableInfo()
 
    /**
     * Returns information about a table or a result set
     *
     * NOTE: only supports 'table' and 'flags' if <var>$result</var>
     * is a table name.
     *
     * @param object|string  $result  DB_result object from a query or a
     *                                 string containing the name of a table.
     *                                 While this also accepts a query result
     *                                 resource identifier, this behavior is
     *                                 deprecated.
     * @param int            $mode    a valid tableInfo mode
     *
     * @return array  an associative array with the information requested.
     *                 A DB_Error object on failure.
     *
     * @see DB_common::tableInfo()
     */
    function tableInfo($result, $mode = null)
    {
        if (is_string($result)) {
            /*
             * Probably received a table name.
             * Create a result resource identifier.
             */
            if (!@mssql_select_db($this->_db, $this->connection)) {
                return $this->mssqlRaiseError(DB_ERROR_NODBSELECTED);
            }
            $id = @mssql_query("SELECT * FROM $result WHERE 1=0",
                               $this->connection);
            $got_string = true;
        } elseif (isset($result->result)) {
            /*
             * Probably received a result object.
             * Extract the result resource identifier.
             */
            $id = $result->result;
            $got_string = false;
        } else {
            /*
             * Probably received a result resource identifier.
             * Copy it.
             * Deprecated.  Here for compatibility only.
             */
            $id = $result;
            $got_string = false;
        }
 
        if (!is_resource($id)) {
            return $this->mssqlRaiseError(DB_ERROR_NEED_MORE_DATA);
        }
 
        if ($this->options['portability'] & DB_PORTABILITY_LOWERCASE) {
            $case_func = 'strtolower';
        } else {
            $case_func = 'strval';
        }
 
        $count = @mssql_num_fields($id);
        $res   = array();
 
        if ($mode) {
            $res['num_fields'] = $count;
        }
 
        for ($i = 0; $i < $count; $i++) {
            $res[$i] = array(
                'table' => $got_string ? $case_func($result) : '',
                'name'  => $case_func(@mssql_field_name($id, $i)),
                'type'  => @mssql_field_type($id, $i),
                'len'   => @mssql_field_length($id, $i),
                // We only support flags for table
                'flags' => $got_string
                           ? $this->_mssql_field_flags($result,
                                                       @mssql_field_name($id, $i))
                           : '',
            );
            if ($mode & DB_TABLEINFO_ORDER) {
                $res['order'][$res[$i]['name']] = $i;
            }
            if ($mode & DB_TABLEINFO_ORDERTABLE) {
                $res['ordertable'][$res[$i]['table']][$res[$i]['name']] = $i;
            }
        }
 
        // free the result only if we were called on a table
        if ($got_string) {
            @mssql_free_result($id);
        }
        return $res;
    }
 
    // }}}
    // {{{ _mssql_field_flags()
 
    /**
     * Get a column's flags
     *
     * Supports "not_null", "primary_key",
     * "auto_increment" (mssql identity), "timestamp" (mssql timestamp),
     * "unique_key" (mssql unique index, unique check or primary_key) and
     * "multiple_key" (multikey index)
     *
     * mssql timestamp is NOT similar to the mysql timestamp so this is maybe
     * not useful at all - is the behaviour of mysql_field_flags that primary
     * keys are alway unique? is the interpretation of multiple_key correct?
     *
     * @param string $table   the table name
     * @param string $column  the field name
     *
     * @return string  the flags
     *
     * @access private
     * @author Joern Barthel <j_barthel@web.de>
     */
    function _mssql_field_flags($table, $column)
    {
        static $tableName = null;
        static $flags = array();
 
        if ($table != $tableName) {
 
            $flags = array();
            $tableName = $table;
 
            // get unique and primary keys
            $res = $this->getAll("EXEC SP_HELPINDEX[$table]", DB_FETCHMODE_ASSOC);
 
            foreach ($res as $val) {
                $keys = explode(', ', $val['index_keys']);
 
                if (sizeof($keys) > 1) {
                    foreach ($keys as $key) {
                        $this->_add_flag($flags[$key], 'multiple_key');
                    }
                }
 
                if (strpos($val['index_description'], 'primary key')) {
                    foreach ($keys as $key) {
                        $this->_add_flag($flags[$key], 'primary_key');
                    }
                } elseif (strpos($val['index_description'], 'unique')) {
                    foreach ($keys as $key) {
                        $this->_add_flag($flags[$key], 'unique_key');
                    }
                }
            }
 
            // get auto_increment, not_null and timestamp
            $res = $this->getAll("EXEC SP_COLUMNS[$table]", DB_FETCHMODE_ASSOC);
 
            foreach ($res as $val) {
                $val = array_change_key_case($val, CASE_LOWER);
                if ($val['nullable'] == '0') {
                    $this->_add_flag($flags[$val['column_name']], 'not_null');
                }
                if (strpos($val['type_name'], 'identity')) {
                    $this->_add_flag($flags[$val['column_name']], 'auto_increment');
                }
                if (strpos($val['type_name'], 'timestamp')) {
                    $this->_add_flag($flags[$val['column_name']], 'timestamp');
                }
            }
        }
 
        if (array_key_exists($column, $flags)) {
            return(implode(' ', $flags[$column]));
        }
        return '';
    }
 
    // }}}
    // {{{ _add_flag()
 
    /**
     * Adds a string to the flags array if the flag is not yet in there
     * - if there is no flag present the array is created
     *
     * @param array  &$array  the reference to the flag-array
     * @param string $value   the flag value
     *
     * @return void
     *
     * @access private
     * @author Joern Barthel <j_barthel@web.de>
     */
    function _add_flag(&$array, $value)
    {
        if (!is_array($array)) {
            $array = array($value);
        } elseif (!in_array($value, $array)) {
            array_push($array, $value);
        }
    }
 
    // }}}
    // {{{ getSpecialQuery()
 
    /**
     * Obtains the query string needed for listing a given type of objects
     *
     * @param string $type  the kind of objects you want to retrieve
     *
     * @return string  the SQL query string or null if the driver doesn't
     *                  support the object type requested
     *
     * @access protected
     * @see DB_common::getListOf()
     */
    function getSpecialQuery($type)
    {
        switch ($type) {
            case 'tables':
                return "SELECT name FROM sysobjects WHERE type = 'U'"
                       . ' ORDER BY name';
            case 'views':
                return "SELECT name FROM sysobjects WHERE type = 'V'";
            default:
                return null;
        }
    }
 
    // }}}
}
 
/*
 * Local variables:
 * tab-width: 4
 * c-basic-offset: 4
 * End:
 */
 
?>

Rev 320	Rev 443
1	`<?php`	1	`<?php`
2		2
3	`/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */`	3	`/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */`
4		4
5	`/**`	5	`/**`
6	`* The PEAR DB driver for PHP's mssql extension`	6	`* The PEAR DB driver for PHP's mssql extension`
7	`* for interacting with Microsoft SQL Server databases`	7	`* for interacting with Microsoft SQL Server databases`
8	`*`	8	`*`
9	`* PHP versions 4 and 5`	9	`* PHP versions 4 and 5`
10	`*`	10	`*`
11	`* LICENSE: This source file is subject to version 3.0 of the PHP license`	11	`* LICENSE: This source file is subject to version 3.0 of the PHP license`
12	`* that is available through the world-wide-web at the following URI:`	12	`* that is available through the world-wide-web at the following URI:`
13	`* http://www.php.net/license/3_0.txt. If you did not receive a copy of`	13	`* http://www.php.net/license/3_0.txt. If you did not receive a copy of`
14	`* the PHP License and are unable to obtain it through the web, please`	14	`* the PHP License and are unable to obtain it through the web, please`
15	`* send a note to license@php.net so we can mail you a copy immediately.`	15	`* send a note to license@php.net so we can mail you a copy immediately.`
16	`*`	16	`*`
17	`* @category Database`	17	`* @category Database`
18	`* @package DB`	18	`* @package DB`
19	`* @author Sterling Hughes <sterling@php.net>`	19	`* @author Sterling Hughes <sterling@php.net>`
20	`* @author Daniel Convissor <danielc@php.net>`	20	`* @author Daniel Convissor <danielc@php.net>`
21	`* @copyright 1997-2005 The PHP Group`	21	`* @copyright 1997-2005 The PHP Group`
22	`* @license http://www.php.net/license/3_0.txt PHP License 3.0`	22	`* @license http://www.php.net/license/3_0.txt PHP License 3.0`
23	`* @version CVS: $Id: mssql.php,v 1.1 2005-03-30 08:50:33 jpm Exp $`	23	`* @version CVS: $Id: mssql.php,v 1.2 2005-09-20 17:01:22 ddelon Exp $`
24	`* @link http://pear.php.net/package/DB`	24	`* @link http://pear.php.net/package/DB`
25	`*/`	25	`*/`
26		26
27	`/**`	27	`/**`
28	`* Obtain the DB_common class so it can be extended from`	28	`* Obtain the DB_common class so it can be extended from`
29	`*/`	29	`*/`
30	`require_once 'DB/common.php';`	30	`require_once 'DB/common.php';`
31		31
32	`/**`	32	`/**`
33	`* The methods PEAR DB uses to interact with PHP's mssql extension`	33	`* The methods PEAR DB uses to interact with PHP's mssql extension`
34	`* for interacting with Microsoft SQL Server databases`	34	`* for interacting with Microsoft SQL Server databases`
35	`*`	35	`*`
36	`* These methods overload the ones declared in DB_common.`	36	`* These methods overload the ones declared in DB_common.`
37	`*`	37	`*`
38	`* @category Database`	38	`* @category Database`
39	`* @package DB`	39	`* @package DB`
40	`* @author Sterling Hughes <sterling@php.net>`	40	`* @author Sterling Hughes <sterling@php.net>`
41	`* @author Daniel Convissor <danielc@php.net>`	41	`* @author Daniel Convissor <danielc@php.net>`
42	`* @copyright 1997-2005 The PHP Group`	42	`* @copyright 1997-2005 The PHP Group`
43	`* @license http://www.php.net/license/3_0.txt PHP License 3.0`	43	`* @license http://www.php.net/license/3_0.txt PHP License 3.0`
44	`* @version Release: 1.7.5`	44	`* @version Release: @package_version@`
45	`* @link http://pear.php.net/package/DB`	45	`* @link http://pear.php.net/package/DB`
46	`*/`	46	`*/`
47	`class DB_mssql extends DB_common`	47	`class DB_mssql extends DB_common`
48	`{`	48	`{`
49	`// {{{ properties`	49	`// {{{ properties`
50		50
51	`/**`	51	`/**`
52	`* The DB driver type (mysql, oci8, odbc, etc.)`	52	`* The DB driver type (mysql, oci8, odbc, etc.)`
53	`* @var string`	53	`* @var string`
54	`*/`	54	`*/`
55	`var $phptype = 'mssql';`	55	`var $phptype = 'mssql';`
56		56
57	`/**`	57	`/**`
58	`* The database syntax variant to be used (db2, access, etc.), if any`	58	`* The database syntax variant to be used (db2, access, etc.), if any`
59	`* @var string`	59	`* @var string`
60	`*/`	60	`*/`
61	`var $dbsyntax = 'mssql';`	61	`var $dbsyntax = 'mssql';`
62		62
63	`/**`	63	`/**`
64	`* The capabilities of this DB implementation`	64	`* The capabilities of this DB implementation`
65	`*`	65	`*`
66	`* The 'new_link' element contains the PHP version that first provided`	66	`* The 'new_link' element contains the PHP version that first provided`
67	`* new_link support for this DBMS. Contains false if it's unsupported.`	67	`* new_link support for this DBMS. Contains false if it's unsupported.`
68	`*`	68	`*`
69	`* Meaning of the 'limit' element:`	69	`* Meaning of the 'limit' element:`
70	`* + 'emulate' = emulate with fetch row by number`	70	`* + 'emulate' = emulate with fetch row by number`
71	`* + 'alter' = alter the query`	71	`* + 'alter' = alter the query`
72	`* + false = skip rows`	72	`* + false = skip rows`
73	`*`	73	`*`
74	`* @var array`	74	`* @var array`
75	`*/`	75	`*/`
76	`var $features = array(`	76	`var $features = array(`
77	`'limit' => 'emulate',`	77	`'limit' => 'emulate',`
78	`'new_link' => false,`	78	`'new_link' => false,`
79	`'numrows' => true,`	79	`'numrows' => true,`
80	`'pconnect' => true,`	80	`'pconnect' => true,`
81	`'prepare' => false,`	81	`'prepare' => false,`
82	`'ssl' => false,`	82	`'ssl' => false,`
83	`'transactions' => true,`	83	`'transactions' => true,`
84	`);`	84	`);`
85		85
86	`/**`	86	`/**`
87	`* A mapping of native error codes to DB error codes`	87	`* A mapping of native error codes to DB error codes`
88	`* @var array`	88	`* @var array`
89	`*/`	89	`*/`
90	`// XXX Add here error codes ie: 'S100E' => DB_ERROR_SYNTAX`	90	`// XXX Add here error codes ie: 'S100E' => DB_ERROR_SYNTAX`
91	`var $errorcode_map = array(`	91	`var $errorcode_map = array(`
92	`110 => DB_ERROR_VALUE_COUNT_ON_ROW,`	92	`110 => DB_ERROR_VALUE_COUNT_ON_ROW,`
93	`155 => DB_ERROR_NOSUCHFIELD,`	93	`155 => DB_ERROR_NOSUCHFIELD,`
94	`170 => DB_ERROR_SYNTAX,`	94	`170 => DB_ERROR_SYNTAX,`
95	`207 => DB_ERROR_NOSUCHFIELD,`	95	`207 => DB_ERROR_NOSUCHFIELD,`
96	`208 => DB_ERROR_NOSUCHTABLE,`	96	`208 => DB_ERROR_NOSUCHTABLE,`
97	`245 => DB_ERROR_INVALID_NUMBER,`	97	`245 => DB_ERROR_INVALID_NUMBER,`
98	`515 => DB_ERROR_CONSTRAINT_NOT_NULL,`	98	`515 => DB_ERROR_CONSTRAINT_NOT_NULL,`
99	`547 => DB_ERROR_CONSTRAINT,`	99	`547 => DB_ERROR_CONSTRAINT,`
100	`1913 => DB_ERROR_ALREADY_EXISTS,`	100	`1913 => DB_ERROR_ALREADY_EXISTS,`
101	`2627 => DB_ERROR_CONSTRAINT,`	101	`2627 => DB_ERROR_CONSTRAINT,`
102	`2714 => DB_ERROR_ALREADY_EXISTS,`	102	`2714 => DB_ERROR_ALREADY_EXISTS,`
103	`3701 => DB_ERROR_NOSUCHTABLE,`	103	`3701 => DB_ERROR_NOSUCHTABLE,`
104	`8134 => DB_ERROR_DIVZERO,`	104	`8134 => DB_ERROR_DIVZERO,`
105	`);`	105	`);`
106		106
107	`/**`	107	`/**`
108	`* The raw database connection created by PHP`	108	`* The raw database connection created by PHP`
109	`* @var resource`	109	`* @var resource`
110	`*/`	110	`*/`
111	`var $connection;`	111	`var $connection;`
112		112
113	`/**`	113	`/**`
114	`* The DSN information for connecting to a database`	114	`* The DSN information for connecting to a database`
115	`* @var array`	115	`* @var array`
116	`*/`	116	`*/`
117	`var $dsn = array();`	117	`var $dsn = array();`
118		118
119		119
120	`/**`	120	`/**`
121	`* Should data manipulation queries be committed automatically?`	121	`* Should data manipulation queries be committed automatically?`
122	`* @var bool`	122	`* @var bool`
123	`* @access private`	123	`* @access private`
124	`*/`	124	`*/`
125	`var $autocommit = true;`	125	`var $autocommit = true;`
126		126
127	`/**`	127	`/**`
128	`* The quantity of transactions begun`	128	`* The quantity of transactions begun`
129	`*`	129	`*`
130	`* {@internal While this is private, it can't actually be designated`	130	`* {@internal While this is private, it can't actually be designated`
131	`* private in PHP 5 because it is directly accessed in the test suite.}}`	131	`* private in PHP 5 because it is directly accessed in the test suite.}}`
132	`*`	132	`*`
133	`* @var integer`	133	`* @var integer`
134	`* @access private`	134	`* @access private`
135	`*/`	135	`*/`
136	`var $transaction_opcount = 0;`	136	`var $transaction_opcount = 0;`
137		137
138	`/**`	138	`/**`
139	`* The database specified in the DSN`	139	`* The database specified in the DSN`
140	`*`	140	`*`
141	`* It's a fix to allow calls to different databases in the same script.`	141	`* It's a fix to allow calls to different databases in the same script.`
142	`*`	142	`*`
143	`* @var string`	143	`* @var string`
144	`* @access private`	144	`* @access private`
145	`*/`	145	`*/`
146	`var $_db = null;`	146	`var $_db = null;`
147		147
148		148
149	`// }}}`	149	`// }}}`
150	`// {{{ constructor`	150	`// {{{ constructor`
151		151
152	`/**`	152	`/**`
153	`* This constructor calls <kbd>$this->DB_common()</kbd>`	153	`* This constructor calls <kbd>$this->DB_common()</kbd>`
154	`*`	154	`*`
155	`* @return void`	155	`* @return void`
156	`*/`	156	`*/`
157	`function DB_mssql()`	157	`function DB_mssql()`
158	`{`	158	`{`
159	`$this->DB_common();`	159	`$this->DB_common();`
160	`}`	160	`}`
161		161
162	`// }}}`	162	`// }}}`
163	`// {{{ connect()`	163	`// {{{ connect()`
164		164
165	`/**`	165	`/**`
166	`* Connect to the database server, log in and open the database`	166	`* Connect to the database server, log in and open the database`
167	`*`	167	`*`
168	`* Don't call this method directly. Use DB::connect() instead.`	168	`* Don't call this method directly. Use DB::connect() instead.`
169	`*`	169	`*`
170	`* @param array $dsn the data source name`	170	`* @param array $dsn the data source name`
171	`* @param bool $persistent should the connection be persistent?`	171	`* @param bool $persistent should the connection be persistent?`
172	`*`	172	`*`
173	`* @return int DB_OK on success. A DB_Error object on failure.`	173	`* @return int DB_OK on success. A DB_Error object on failure.`
174	`*/`	174	`*/`
175	`function connect($dsn, $persistent = false)`	175	`function connect($dsn, $persistent = false)`
176	`{`	176	`{`
177	`if (!PEAR::loadExtension('mssql') && !PEAR::loadExtension('sybase')`	177	`if (!PEAR::loadExtension('mssql') && !PEAR::loadExtension('sybase')`
178	`&& !PEAR::loadExtension('sybase_ct'))`	178	`&& !PEAR::loadExtension('sybase_ct'))`
179	`{`	179	`{`
180	`return $this->raiseError(DB_ERROR_EXTENSION_NOT_FOUND);`	180	`return $this->raiseError(DB_ERROR_EXTENSION_NOT_FOUND);`
181	`}`	181	`}`
182		182
183	`$this->dsn = $dsn;`	183	`$this->dsn = $dsn;`
184	`if ($dsn['dbsyntax']) {`	184	`if ($dsn['dbsyntax']) {`
185	`$this->dbsyntax = $dsn['dbsyntax'];`	185	`$this->dbsyntax = $dsn['dbsyntax'];`
186	`}`	186	`}`
187		187
188	`$params = array(`	188	`$params = array(`
189	`$dsn['hostspec'] ? $dsn['hostspec'] : 'localhost',`	189	`$dsn['hostspec'] ? $dsn['hostspec'] : 'localhost',`
190	`$dsn['username'] ? $dsn['username'] : null,`	190	`$dsn['username'] ? $dsn['username'] : null,`
191	`$dsn['password'] ? $dsn['password'] : null,`	191	`$dsn['password'] ? $dsn['password'] : null,`
192	`);`	192	`);`
193	`if ($dsn['port']) {`	193	`if ($dsn['port']) {`
194	`$params[0] .= ((substr(PHP_OS, 0, 3) == 'WIN') ? ',' : ':')`	194	`$params[0] .= ((substr(PHP_OS, 0, 3) == 'WIN') ? ',' : ':')`
195	`. $dsn['port'];`	195	`. $dsn['port'];`
196	`}`	196	`}`
197		197
198	`$connect_function = $persistent ? 'mssql_pconnect' : 'mssql_connect';`	198	`$connect_function = $persistent ? 'mssql_pconnect' : 'mssql_connect';`
199		199
200	`$this->connection = @call_user_func_array($connect_function, $params);`	200	`$this->connection = @call_user_func_array($connect_function, $params);`
201		201
202	`if (!$this->connection) {`	202	`if (!$this->connection) {`
203	`return $this->raiseError(DB_ERROR_CONNECT_FAILED,`	203	`return $this->raiseError(DB_ERROR_CONNECT_FAILED,`
204	`null, null, null,`	204	`null, null, null,`
205	`@mssql_get_last_message());`	205	`@mssql_get_last_message());`
206	`}`	206	`}`
207	`if ($dsn['database']) {`	207	`if ($dsn['database']) {`
208	`if (!@mssql_select_db($dsn['database'], $this->connection)) {`	208	`if (!@mssql_select_db($dsn['database'], $this->connection)) {`
209	`return $this->raiseError(DB_ERROR_NODBSELECTED,`	209	`return $this->raiseError(DB_ERROR_NODBSELECTED,`
210	`null, null, null,`	210	`null, null, null,`
211	`@mssql_get_last_message());`	211	`@mssql_get_last_message());`
212	`}`	212	`}`
213	`$this->_db = $dsn['database'];`	213	`$this->_db = $dsn['database'];`
214	`}`	214	`}`
215	`return DB_OK;`	215	`return DB_OK;`
216	`}`	216	`}`
217		217
218	`// }}}`	218	`// }}}`
219	`// {{{ disconnect()`	219	`// {{{ disconnect()`
220		220
221	`/**`	221	`/**`
222	`* Disconnects from the database server`	222	`* Disconnects from the database server`
223	`*`	223	`*`
224	`* @return bool TRUE on success, FALSE on failure`	224	`* @return bool TRUE on success, FALSE on failure`
225	`*/`	225	`*/`
226	`function disconnect()`	226	`function disconnect()`
227	`{`	227	`{`
228	`$ret = @mssql_close($this->connection);`	228	`$ret = @mssql_close($this->connection);`
229	`$this->connection = null;`	229	`$this->connection = null;`
230	`return $ret;`	230	`return $ret;`
231	`}`	231	`}`
232		232
233	`// }}}`	233	`// }}}`
234	`// {{{ simpleQuery()`	234	`// {{{ simpleQuery()`
235		235
236	`/**`	236	`/**`
237	`* Sends a query to the database server`	237	`* Sends a query to the database server`
238	`*`	238	`*`
239	`* @param string the SQL query string`	239	`* @param string the SQL query string`
240	`*`	240	`*`
241	`* @return mixed + a PHP result resrouce for successful SELECT queries`	241	`* @return mixed + a PHP result resrouce for successful SELECT queries`
242	`* + the DB_OK constant for other successful queries`	242	`* + the DB_OK constant for other successful queries`
243	`* + a DB_Error object on failure`	243	`* + a DB_Error object on failure`
244	`*/`	244	`*/`
245	`function simpleQuery($query)`	245	`function simpleQuery($query)`
246	`{`	246	`{`
247	`$ismanip = DB::isManip($query);`	247	`$ismanip = DB::isManip($query);`
248	`$this->last_query = $query;`	248	`$this->last_query = $query;`
249	`if (!@mssql_select_db($this->_db, $this->connection)) {`	249	`if (!@mssql_select_db($this->_db, $this->connection)) {`
250	`return $this->mssqlRaiseError(DB_ERROR_NODBSELECTED);`	250	`return $this->mssqlRaiseError(DB_ERROR_NODBSELECTED);`
251	`}`	251	`}`
252	`$query = $this->modifyQuery($query);`	252	`$query = $this->modifyQuery($query);`
253	`if (!$this->autocommit && $ismanip) {`	253	`if (!$this->autocommit && $ismanip) {`
254	`if ($this->transaction_opcount == 0) {`	254	`if ($this->transaction_opcount == 0) {`
255	`$result = @mssql_query('BEGIN TRAN', $this->connection);`	255	`$result = @mssql_query('BEGIN TRAN', $this->connection);`
256	`if (!$result) {`	256	`if (!$result) {`
257	`return $this->mssqlRaiseError();`	257	`return $this->mssqlRaiseError();`
258	`}`	258	`}`
259	`}`	259	`}`
260	`$this->transaction_opcount++;`	260	`$this->transaction_opcount++;`
261	`}`	261	`}`
262	`$result = @mssql_query($query, $this->connection);`	262	`$result = @mssql_query($query, $this->connection);`
263	`if (!$result) {`	263	`if (!$result) {`
264	`return $this->mssqlRaiseError();`	264	`return $this->mssqlRaiseError();`
265	`}`	265	`}`
266	`// Determine which queries that should return data, and which`	266	`// Determine which queries that should return data, and which`
267	`// should return an error code only.`	267	`// should return an error code only.`
268	`return $ismanip ? DB_OK : $result;`	268	`return $ismanip ? DB_OK : $result;`
269	`}`	269	`}`
270		270
271	`// }}}`	271	`// }}}`
272	`// {{{ nextResult()`	272	`// {{{ nextResult()`
273		273
274	`/**`	274	`/**`
275	`* Move the internal mssql result pointer to the next available result`	275	`* Move the internal mssql result pointer to the next available result`
276	`*`	276	`*`
277	`* @param a valid fbsql result resource`	277	`* @param a valid fbsql result resource`
278	`*`	278	`*`
279	`* @access public`	279	`* @access public`
280	`*`	280	`*`
281	`* @return true if a result is available otherwise return false`	281	`* @return true if a result is available otherwise return false`
282	`*/`	282	`*/`
283	`function nextResult($result)`	283	`function nextResult($result)`
284	`{`	284	`{`
285	`return @mssql_next_result($result);`	285	`return @mssql_next_result($result);`
286	`}`	286	`}`
287		287
288	`// }}}`	288	`// }}}`
289	`// {{{ fetchInto()`	289	`// {{{ fetchInto()`
290		290
291	`/**`	291	`/**`
292	`* Places a row from the result set into the given array`	292	`* Places a row from the result set into the given array`
293	`*`	293	`*`
294	`* Formating of the array and the data therein are configurable.`	294	`* Formating of the array and the data therein are configurable.`
295	`* See DB_result::fetchInto() for more information.`	295	`* See DB_result::fetchInto() for more information.`
296	`*`	296	`*`
297	`* This method is not meant to be called directly. Use`	297	`* This method is not meant to be called directly. Use`
298	`* DB_result::fetchInto() instead. It can't be declared "protected"`	298	`* DB_result::fetchInto() instead. It can't be declared "protected"`
299	`* because DB_result is a separate object.`	299	`* because DB_result is a separate object.`
300	`*`	300	`*`
301	`* @param resource $result the query result resource`	301	`* @param resource $result the query result resource`
302	`* @param array $arr the referenced array to put the data in`	302	`* @param array $arr the referenced array to put the data in`
303	`* @param int $fetchmode how the resulting array should be indexed`	303	`* @param int $fetchmode how the resulting array should be indexed`
304	`* @param int $rownum the row number to fetch (0 = first row)`	304	`* @param int $rownum the row number to fetch (0 = first row)`
305	`*`	305	`*`
306	`* @return mixed DB_OK on success, NULL when the end of a result set is`	306	`* @return mixed DB_OK on success, NULL when the end of a result set is`
307	`* reached or on failure`	307	`* reached or on failure`
308	`*`	308	`*`
309	`* @see DB_result::fetchInto()`	309	`* @see DB_result::fetchInto()`
310	`*/`	310	`*/`
311	`function fetchInto($result, &$arr, $fetchmode, $rownum = null)`	311	`function fetchInto($result, &$arr, $fetchmode, $rownum = null)`
312	`{`	312	`{`
313	`if ($rownum !== null) {`	313	`if ($rownum !== null) {`
314	`if (!@mssql_data_seek($result, $rownum)) {`	314	`if (!@mssql_data_seek($result, $rownum)) {`
315	`return null;`	315	`return null;`
316	`}`	316	`}`
317	`}`	317	`}`
318	`if ($fetchmode & DB_FETCHMODE_ASSOC) {`	318	`if ($fetchmode & DB_FETCHMODE_ASSOC) {`
319	`$arr = @mssql_fetch_array($result, MSSQL_ASSOC);`	319	`$arr = @mssql_fetch_array($result, MSSQL_ASSOC);`
320	`if ($this->options['portability'] & DB_PORTABILITY_LOWERCASE && $arr) {`	320	`if ($this->options['portability'] & DB_PORTABILITY_LOWERCASE && $arr) {`
321	`$arr = array_change_key_case($arr, CASE_LOWER);`	321	`$arr = array_change_key_case($arr, CASE_LOWER);`
322	`}`	322	`}`
323	`} else {`	323	`} else {`
324	`$arr = @mssql_fetch_row($result);`	324	`$arr = @mssql_fetch_row($result);`
325	`}`	325	`}`
326	`if (!$arr) {`	326	`if (!$arr) {`
327	`return null;`	327	`return null;`
328	`}`	328	`}`
329	`if ($this->options['portability'] & DB_PORTABILITY_RTRIM) {`	329	`if ($this->options['portability'] & DB_PORTABILITY_RTRIM) {`
330	`$this->_rtrimArrayValues($arr);`	330	`$this->_rtrimArrayValues($arr);`
331	`}`	331	`}`
332	`if ($this->options['portability'] & DB_PORTABILITY_NULL_TO_EMPTY) {`	332	`if ($this->options['portability'] & DB_PORTABILITY_NULL_TO_EMPTY) {`
333	`$this->_convertNullArrayValuesToEmpty($arr);`	333	`$this->_convertNullArrayValuesToEmpty($arr);`
334	`}`	334	`}`
335	`return DB_OK;`	335	`return DB_OK;`
336	`}`	336	`}`
337		337
338	`// }}}`	338	`// }}}`
339	`// {{{ freeResult()`	339	`// {{{ freeResult()`
340		340
341	`/**`	341	`/**`
342	`* Deletes the result set and frees the memory occupied by the result set`	342	`* Deletes the result set and frees the memory occupied by the result set`
343	`*`	343	`*`
344	`* This method is not meant to be called directly. Use`	344	`* This method is not meant to be called directly. Use`
345	`* DB_result::free() instead. It can't be declared "protected"`	345	`* DB_result::free() instead. It can't be declared "protected"`
346	`* because DB_result is a separate object.`	346	`* because DB_result is a separate object.`
347	`*`	347	`*`
348	`* @param resource $result PHP's query result resource`	348	`* @param resource $result PHP's query result resource`
349	`*`	349	`*`
350	`* @return bool TRUE on success, FALSE if $result is invalid`	350	`* @return bool TRUE on success, FALSE if $result is invalid`
351	`*`	351	`*`
352	`* @see DB_result::free()`	352	`* @see DB_result::free()`
353	`*/`	353	`*/`
354	`function freeResult($result)`	354	`function freeResult($result)`
355	`{`	355	`{`
356	`return @mssql_free_result($result);`	356	`return @mssql_free_result($result);`
357	`}`	357	`}`
358		358
359	`// }}}`	359	`// }}}`
360	`// {{{ numCols()`	360	`// {{{ numCols()`
361		361
362	`/**`	362	`/**`
363	`* Gets the number of columns in a result set`	363	`* Gets the number of columns in a result set`
364	`*`	364	`*`
365	`* This method is not meant to be called directly. Use`	365	`* This method is not meant to be called directly. Use`
366	`* DB_result::numCols() instead. It can't be declared "protected"`	366	`* DB_result::numCols() instead. It can't be declared "protected"`
367	`* because DB_result is a separate object.`	367	`* because DB_result is a separate object.`
368	`*`	368	`*`
369	`* @param resource $result PHP's query result resource`	369	`* @param resource $result PHP's query result resource`
370	`*`	370	`*`
371	`* @return int the number of columns. A DB_Error object on failure.`	371	`* @return int the number of columns. A DB_Error object on failure.`
372	`*`	372	`*`
373	`* @see DB_result::numCols()`	373	`* @see DB_result::numCols()`
374	`*/`	374	`*/`
375	`function numCols($result)`	375	`function numCols($result)`
376	`{`	376	`{`
377	`$cols = @mssql_num_fields($result);`	377	`$cols = @mssql_num_fields($result);`
378	`if (!$cols) {`	378	`if (!$cols) {`
379	`return $this->mssqlRaiseError();`	379	`return $this->mssqlRaiseError();`
380	`}`	380	`}`
381	`return $cols;`	381	`return $cols;`
382	`}`	382	`}`
383		383
384	`// }}}`	384	`// }}}`
385	`// {{{ numRows()`	385	`// {{{ numRows()`
386		386
387	`/**`	387	`/**`
388	`* Gets the number of rows in a result set`	388	`* Gets the number of rows in a result set`
389	`*`	389	`*`
390	`* This method is not meant to be called directly. Use`	390	`* This method is not meant to be called directly. Use`
391	`* DB_result::numRows() instead. It can't be declared "protected"`	391	`* DB_result::numRows() instead. It can't be declared "protected"`
392	`* because DB_result is a separate object.`	392	`* because DB_result is a separate object.`
393	`*`	393	`*`
394	`* @param resource $result PHP's query result resource`	394	`* @param resource $result PHP's query result resource`
395	`*`	395	`*`
396	`* @return int the number of rows. A DB_Error object on failure.`	396	`* @return int the number of rows. A DB_Error object on failure.`
397	`*`	397	`*`
398	`* @see DB_result::numRows()`	398	`* @see DB_result::numRows()`
399	`*/`	399	`*/`
400	`function numRows($result)`	400	`function numRows($result)`
401	`{`	401	`{`
402	`$rows = @mssql_num_rows($result);`	402	`$rows = @mssql_num_rows($result);`
403	`if ($rows === false) {`	403	`if ($rows === false) {`
404	`return $this->mssqlRaiseError();`	404	`return $this->mssqlRaiseError();`
405	`}`	405	`}`
406	`return $rows;`	406	`return $rows;`
407	`}`	407	`}`
408		408
409	`// }}}`	409	`// }}}`
410	`// {{{ autoCommit()`	410	`// {{{ autoCommit()`
411		411
412	`/**`	412	`/**`
413	`* Enables or disables automatic commits`	413	`* Enables or disables automatic commits`
414	`*`	414	`*`
415	`* @param bool $onoff true turns it on, false turns it off`	415	`* @param bool $onoff true turns it on, false turns it off`
416	`*`	416	`*`
417	`* @return int DB_OK on success. A DB_Error object if the driver`	417	`* @return int DB_OK on success. A DB_Error object if the driver`
418	`* doesn't support auto-committing transactions.`	418	`* doesn't support auto-committing transactions.`
419	`*/`	419	`*/`
420	`function autoCommit($onoff = false)`	420	`function autoCommit($onoff = false)`
421	`{`	421	`{`
422	`// XXX if $this->transaction_opcount > 0, we should probably`	422	`// XXX if $this->transaction_opcount > 0, we should probably`
423	`// issue a warning here.`	423	`// issue a warning here.`
424	`$this->autocommit = $onoff ? true : false;`	424	`$this->autocommit = $onoff ? true : false;`
425	`return DB_OK;`	425	`return DB_OK;`
426	`}`	426	`}`
427		427
428	`// }}}`	428	`// }}}`
429	`// {{{ commit()`	429	`// {{{ commit()`
430		430
431	`/**`	431	`/**`
432	`* Commits the current transaction`	432	`* Commits the current transaction`
433	`*`	433	`*`
434	`* @return int DB_OK on success. A DB_Error object on failure.`	434	`* @return int DB_OK on success. A DB_Error object on failure.`
435	`*/`	435	`*/`
436	`function commit()`	436	`function commit()`
437	`{`	437	`{`
438	`if ($this->transaction_opcount > 0) {`	438	`if ($this->transaction_opcount > 0) {`
439	`if (!@mssql_select_db($this->_db, $this->connection)) {`	439	`if (!@mssql_select_db($this->_db, $this->connection)) {`
440	`return $this->mssqlRaiseError(DB_ERROR_NODBSELECTED);`	440	`return $this->mssqlRaiseError(DB_ERROR_NODBSELECTED);`
441	`}`	441	`}`
442	`$result = @mssql_query('COMMIT TRAN', $this->connection);`	442	`$result = @mssql_query('COMMIT TRAN', $this->connection);`
443	`$this->transaction_opcount = 0;`	443	`$this->transaction_opcount = 0;`
444	`if (!$result) {`	444	`if (!$result) {`
445	`return $this->mssqlRaiseError();`	445	`return $this->mssqlRaiseError();`
446	`}`	446	`}`
447	`}`	447	`}`
448	`return DB_OK;`	448	`return DB_OK;`
449	`}`	449	`}`
450		450
451	`// }}}`	451	`// }}}`
452	`// {{{ rollback()`	452	`// {{{ rollback()`
453		453
454	`/**`	454	`/**`
455	`* Reverts the current transaction`	455	`* Reverts the current transaction`
456	`*`	456	`*`
457	`* @return int DB_OK on success. A DB_Error object on failure.`	457	`* @return int DB_OK on success. A DB_Error object on failure.`
458	`*/`	458	`*/`
459	`function rollback()`	459	`function rollback()`
460	`{`	460	`{`
461	`if ($this->transaction_opcount > 0) {`	461	`if ($this->transaction_opcount > 0) {`
462	`if (!@mssql_select_db($this->_db, $this->connection)) {`	462	`if (!@mssql_select_db($this->_db, $this->connection)) {`
463	`return $this->mssqlRaiseError(DB_ERROR_NODBSELECTED);`	463	`return $this->mssqlRaiseError(DB_ERROR_NODBSELECTED);`
464	`}`	464	`}`
465	`$result = @mssql_query('ROLLBACK TRAN', $this->connection);`	465	`$result = @mssql_query('ROLLBACK TRAN', $this->connection);`
466	`$this->transaction_opcount = 0;`	466	`$this->transaction_opcount = 0;`
467	`if (!$result) {`	467	`if (!$result) {`
468	`return $this->mssqlRaiseError();`	468	`return $this->mssqlRaiseError();`
469	`}`	469	`}`
470	`}`	470	`}`
471	`return DB_OK;`	471	`return DB_OK;`
472	`}`	472	`}`
473		473
474	`// }}}`	474	`// }}}`
475	`// {{{ affectedRows()`	475	`// {{{ affectedRows()`
476		476
477	`/**`	477	`/**`
478	`* Determines the number of rows affected by a data maniuplation query`	478	`* Determines the number of rows affected by a data maniuplation query`
479	`*`	479	`*`
480	`* 0 is returned for queries that don't manipulate data.`	480	`* 0 is returned for queries that don't manipulate data.`
481	`*`	481	`*`
482	`* @return int the number of rows. A DB_Error object on failure.`	482	`* @return int the number of rows. A DB_Error object on failure.`
483	`*/`	483	`*/`
484	`function affectedRows()`	484	`function affectedRows()`
485	`{`	485	`{`
486	`if (DB::isManip($this->last_query)) {`	486	`if (DB::isManip($this->last_query)) {`
487	`$res = @mssql_query('select @@rowcount', $this->connection);`	487	`$res = @mssql_query('select @@rowcount', $this->connection);`
488	`if (!$res) {`	488	`if (!$res) {`
489	`return $this->mssqlRaiseError();`	489	`return $this->mssqlRaiseError();`
490	`}`	490	`}`
491	`$ar = @mssql_fetch_row($res);`	491	`$ar = @mssql_fetch_row($res);`
492	`if (!$ar) {`	492	`if (!$ar) {`
493	`$result = 0;`	493	`$result = 0;`
494	`} else {`	494	`} else {`
495	`@mssql_free_result($res);`	495	`@mssql_free_result($res);`
496	`$result = $ar[0];`	496	`$result = $ar[0];`
497	`}`	497	`}`
498	`} else {`	498	`} else {`
499	`$result = 0;`	499	`$result = 0;`
500	`}`	500	`}`

Subversion Repositories Applications.papyrus

(root)/trunk/api/pear/DB/mssql.php – Rev 320 → 443