Logo Search packages:      
Sourcecode: cakephp version File versions

dbo_mssql.php

<?php
/* SVN FILE: $Id: dbo_mssql.php 5117 2007-05-18 16:46:55Z phpnut $ */

/**
 * MS SQL layer for DBO
 *
 * Long description for file
 *
 * PHP versions 4 and 5
 *
 * CakePHP(tm) :  Rapid Development Framework <http://www.cakephp.org/>
 * Copyright 2005-2007, Cake Software Foundation, Inc.
 *                                              1785 E. Sahara Avenue, Suite 490-204
 *                                              Las Vegas, Nevada 89104
 *
 * Licensed under The MIT License
 * Redistributions of files must retain the above copyright notice.
 *
 * @filesource
 * @copyright           Copyright 2005-2007, Cake Software Foundation, Inc.
 * @link                      http://www.cakefoundation.org/projects/info/cakephp CakePHP(tm) Project
 * @package             cake
 * @subpackage          cake.cake.libs.model.dbo
 * @since               CakePHP(tm) v 0.10.5.1790
 * @version             $Revision: 5117 $
 * @modifiedby          $LastChangedBy: phpnut $
 * @lastmodified  $Date: 2007-05-18 11:46:55 -0500 (Fri, 18 May 2007) $
 * @license             http://www.opensource.org/licenses/mit-license.php The MIT License
 */

/**
 * Short description for class.
 *
 * Long description for class
 *
 * @package       cake
 * @subpackage    cake.cake.libs.model.dbo
 */
class DboMssql extends DboSource {
/**
 * Driver description
 *
 * @var string
 */
      var $description = "MS SQL DBO Driver";
/**
 * Starting quote character for quoted identifiers
 *
 * @var string
 */
      var $startQuote = "[";
/**
 * Ending quote character for quoted identifiers
 *
 * @var string
 */
      var $endQuote = "]";
 /**
 * Creates a map between field aliases and numeric indexes.  Workaround for the
 * SQL Server driver's 30-character column name limitation.
 *
 * @var array
 */
      var $__fieldMappings = array();
/**
 * Base configuration settings for MS SQL driver
 *
 * @var array
 */
      var $_baseConfig = array(
            'persistent' => true,
            'host' => 'localhost',
            'login' => 'root',
            'password' => '',
            'database' => 'cake',
            'port' => '1433',
            'connect' => 'mssql_pconnect'
      );
/**
 * MS SQL column definition
 *
 * @var array
 */
      var $columns = array(
            'primary_key' => array('name' => 'int IDENTITY (1, 1) NOT NULL'),
            'string'    => array('name' => 'varchar', 'limit' => '255'),
            'text'            => array('name' => 'text'),
            'integer'   => array('name' => 'int', 'formatter' => 'intval'),
            'float'           => array('name' => 'float', 'formatter' => 'floatval'),
            'datetime'  => array('name' => 'datetime', 'format' => 'Y-m-d H:i:s', 'formatter' => 'date'),
            'timestamp' => array('name' => 'timestamp', 'format' => 'Y-m-d H:i:s', 'formatter' => 'date'),
            'time'            => array('name' => 'datetime', 'format' => 'H:i:s', 'formatter' => 'date'),
            'date'            => array('name' => 'datetime', 'format' => 'Y-m-d', 'formatter' => 'date'),
            'binary'    => array('name' => 'image'),
            'boolean'   => array('name' => 'bit')
      );
/**
 * MS SQL DBO driver constructor; sets SQL Server error reporting defaults
 *
 * @param array $config Configuration data from app/config/databases.php
 * @return boolean True if connected successfully, false on error
 */
      function __construct($config) {
            if (!function_exists('mssql_min_message_severity')) {
                  trigger_error("PHP SQL Server interface is not installed, cannot continue.  For troubleshooting information, see http://php.net/mssql/", E_USER_ERROR);
            }
            mssql_min_message_severity(15);
            mssql_min_error_severity(2);
            return parent::__construct($config);
      }
/**
 * Connects to the database using options in the given configuration array.
 *
 * @return boolean True if the database could be connected, else false
 */
      function connect() {
            $config = $this->config;

            $os = env('OS');
            if (!empty($os) && strpos($os, 'Windows') !== false) {
                  $sep = ',';
            } else {
                  $sep = ':';
            }
            $connect = 'mssql_connect';
            if ($config['persistent']) {
                  $connect = 'mssql_pconnect';
            }
            $this->connected = false;

            if (is_numeric($config['port'])) {
                  $port = $sep . $config['port'];     // Port number
            } elseif ($config['port'] === null) {
                  $port = '';                               // No port - SQL Server 2005
            } else {
                  $port = '\\' . $config['port'];     // Named pipe
            }
            $this->connection = $connect($config['host'] . $port, $config['login'], $config['password']);

            if (mssql_select_db($config['database'], $this->connection)) {
                  $this->connected = true;
            }
      }
/**
 * Disconnects from database.
 *
 * @return boolean True if the database could be disconnected, else false
 */
      function disconnect() {
            @mssql_free_result($this->results);
            $this->connected = !@mssql_close($this->connection);
            return !$this->connected;
      }
/**
 * Executes given SQL statement.
 *
 * @param string $sql SQL statement
 * @return resource Result resource identifier
 * @access protected
 */
      function _execute($sql) {
            return mssql_query($sql, $this->connection);
      }
/**
 * Returns an array of sources (tables) in the database.
 *
 * @return array Array of tablenames in the database
 */
      function listSources() {
            $cache = parent::listSources();

            if ($cache != null) {
                  return $cache;
            }

            $result = $this->fetchAll('SELECT TABLE_NAME FROM INFORMATION_SCHEMA.TABLES');

            if (!$result || empty($result)) {
                  return array();
            } else {
                  $tables = array();

                  foreach($result as $table) {
                        $tables[] = $table[0]['TABLE_NAME'];
                  }

                  parent::listSources($tables);
                  return $tables;
            }
      }
/**
 * Returns an array of the fields in given table name.
 *
 * @param Model $model Model object to describe
 * @return array Fields in table. Keys are name and type
 */
      function describe(&$model) {
            $cache = parent::describe($model);

            if ($cache != null) {
                  return $cache;
            }

            $fields = false;
            $cols = $this->fetchAll("SELECT COLUMN_NAME as Field, DATA_TYPE as Type, COL_LENGTH('" . $this->fullTableName($model, false) . "', COLUMN_NAME) as Length, IS_NULLABLE As [Null], COLUMN_DEFAULT as [Default], COLUMNPROPERTY(OBJECT_ID('" . $this->fullTableName($model, false) . "'), COLUMN_NAME, 'IsIdentity') as [Key], NUMERIC_SCALE as Size FROM INFORMATION_SCHEMA.COLUMNS WHERE TABLE_NAME = '" . $this->fullTableName($model, false) . "'", false);

            foreach($cols as $column) {
                  $fields[] = array(
                        'name' => $column[0]['Field'],
                        'type' => $this->column($column[0]['Type']),
                        'null' => (up($column[0]['Null']) == 'YES'),
                        'default' => $column[0]['Default']
                  );
            }
            $this->__cacheDescription($this->fullTableName($model, false), $fields);
            return $fields;
      }
/**
 * Returns a quoted and escaped string of $data for use in an SQL statement.
 *
 * @param string $data String to be prepared for use in an SQL statement
 * @param string $column The column into which this data will be inserted
 * @param boolean $safe Whether or not numeric data should be handled automagically if no column data is provided
 * @return string Quoted and escaped data
 */
      function value($data, $column = null, $safe = false) {
            $parent = parent::value($data, $column, $safe);

            if ($parent != null) {
                  return $parent;
            }
            if ($data === null) {
                  return 'NULL';
            }
            if ($data === '') {
                  return "''";
            }

            switch($column) {
                  case 'boolean':
                        $data = $this->boolean((bool)$data);
                  break;
                  default:
                        if (get_magic_quotes_gpc()) {
                              $data = stripslashes(r("'", "''", $data));
                        } else {
                              $data = r("'", "''", $data);
                        }
                  break;
            }
            return "'" . $data . "'";
      }
/**
 * Generates the fields list of an SQL query.
 *
 * @param Model $model
 * @param string $alias Alias tablename
 * @param mixed $fields
 * @return array
 */
      function fields(&$model, $alias = null, $fields = array(), $quote = true) {
            if (empty($alias)) {
                  $alias = $model->name;
            }
            $fields = parent::fields($model, $alias, $fields, false);
            $count = count($fields);

            if ($count >= 1 && $fields[0] != '*' && strpos($fields[0], 'COUNT(*)') === false) {
                  for($i = 0; $i < $count; $i++) {
                        $dot = strrpos($fields[$i], '.');
                        $fieldAlias = count($this->__fieldMappings);

                        if ($dot === false && !preg_match('/\s+AS\s+/i', $fields[$i])) {
                              $this->__fieldMappings[$alias . '__' . $fieldAlias] = $alias . '.' . $fields[$i];
                              $fields[$i] = $this->name($alias) . '.' . $this->name($fields[$i]) . ' AS ' . $this->name($alias . '__' . $fieldAlias);
                        } elseif (!preg_match('/\s+AS\s+/i', $fields[$i])) {
                              $build = explode('.', $fields[$i]);
                              $this->__fieldMappings[$build[0] . '__' . $fieldAlias] = $build[0] . '.' . $build[1];
                              $fields[$i] = $this->name($build[0]) . '.' . $this->name($build[1]) . ' AS ' . $this->name($build[0] . '__' . $fieldAlias);
                        }
                  }
            }
            return $fields;
      }
/**
 * Begin a transaction
 *
 * @param unknown_type $model
 * @return boolean True on success, false on fail
 * (i.e. if the database/model does not support transactions).
 */
      function begin(&$model) {
            if (parent::begin($model)) {
                  if ($this->execute('BEGIN TRANSACTION')) {
                        $this->_transactionStarted = true;
                        return true;
                  }
            }
            return false;
      }
/**
 * Commit a transaction
 *
 * @param unknown_type $model
 * @return boolean True on success, false on fail
 * (i.e. if the database/model does not support transactions,
 * or a transaction has not started).
 */
      function commit(&$model) {
            if (parent::commit($model)) {
                  $this->_transactionStarted = false;
                  return $this->execute('COMMIT');
            }
            return false;
      }
/**
 * Rollback a transaction
 *
 * @param unknown_type $model
 * @return boolean True on success, false on fail
 * (i.e. if the database/model does not support transactions,
 * or a transaction has not started).
 */
      function rollback(&$model) {
            if (parent::rollback($model)) {
                  return $this->execute('ROLLBACK');
            }
            return false;
      }
/**
 * Removes Identity (primary key) column from update data before returning to parent
 *
 * @param Model $model
 * @param array $fields
 * @param array $values
 * @return array
 */
      function update(&$model, $fields = array(), $values = array()) {
            foreach($fields as $i => $field) {
                  if ($field == $model->primaryKey) {
                        unset ($fields[$i]);
                        unset ($values[$i]);
                        break;
                  }
            }
            return parent::update($model, $fields, $values);
      }
/**
 * Returns a formatted error message from previous database operation.
 *
 * @return string Error message with error number
 */
      function lastError() {
            $error = mssql_get_last_message($this->connection);

            if ($error) {
                  if (strpos('changed database', low($error)) !== false) {
                        return $error;
                  }
            }
            return null;
      }
/**
 * Returns number of affected rows in previous database operation. If no previous operation exists,
 * this returns false.
 *
 * @return int Number of affected rows
 */
      function lastAffected() {
            if ($this->_result) {
                  return mssql_rows_affected($this->connection);
            }
            return null;
      }
/**
 * Returns number of rows in previous resultset. If no previous resultset exists,
 * this returns false.
 *
 * @return int Number of rows in resultset
 */
      function lastNumRows() {
            if ($this->_result) {
                  return @mssql_num_rows($this->_result);
            }
            return null;
      }
/**
 * Returns the ID generated from the previous INSERT operation.
 *
 * @param unknown_type $source
 * @return in
 */
      function lastInsertId($source = null) {
            $id = $this->fetchAll('SELECT SCOPE_IDENTITY() AS insertID', false);
            return $id[0][0]['insertID'];
      }
/**
 * Returns a limit statement in the correct format for the particular database.
 *
 * @param int $limit Limit of results returned
 * @param int $offset Offset from which to start results
 * @return string SQL limit/offset statement
 */
      function limit($limit, $offset = null) {
            if ($limit) {
                  $rt = '';
                  if (!strpos(strtolower($limit), 'top') || strpos(strtolower($limit), 'top') === 0) {
                        $rt = ' TOP';
                  }
                  $rt .= ' ' . $limit;
                  if (is_int($offset) && $offset > 0) {
                        $rt .= ' OFFSET ' . $offset;
                  }
                  return $rt;
            }
            return null;
      }
/**
 * Converts database-layer column types to basic types
 *
 * @param string $real Real database-layer column type (i.e. "varchar(255)")
 * @return string Abstract column type (i.e. "string")
 */
      function column($real) {
            if (is_array($real)) {
                  $col = $real['name'];

                  if (isset($real['limit'])) {
                        $col .= '(' . $real['limit'] . ')';
                  }
                  return $col;
            }
            $col                = r(')', '', $real);
            $limit              = null;
            @list($col, $limit) = explode('(', $col);

            if (in_array($col, array('date', 'time', 'datetime', 'timestamp'))) {
                  return $col;
            }

            if ($col == 'bit') {
                  return 'boolean';
            }

            if (strpos($col, 'int') !== false || $col == 'numeric') {
                  return 'integer';
            }

            if (strpos($col, 'char') !== false) {
                  return 'string';
            }

            if (strpos($col, 'text') !== false) {
                  return 'text';
            }

            if (strpos($col, 'binary') !== false || $col == 'image') {
                  return 'binary';
            }

            if (in_array($col, array('float', 'real', 'decimal'))) {
                  return 'float';
            }
            return 'text';
      }
/**
 * Enter description here...
 *
 * @param unknown_type $results
 */
      function resultSet(&$results) {
            $this->results =& $results;
            $this->map = array();
            $num_fields = mssql_num_fields($results);
            $index = 0;
            $j = 0;

            while($j < $num_fields) {
                  $column = mssql_field_name($results, $j);

                  if (strpos($column, '__')) {
                        if (isset($this->__fieldMappings[$column]) && strpos($this->__fieldMappings[$column], '.')) {
                              $map = explode('.', $this->__fieldMappings[$column]);
                        } elseif(isset($this->__fieldMappings[$column])) {
                              $map = array(0, $this->__fieldMappings[$column]);
                        } else {
                              $map = array(0, $column);     
                        }
                        $this->map[$index++] = $map;
                  } else {
                        $this->map[$index++] = array(0, $column);
                  }
                  $j++;
            }
      }
/**
 * Builds final SQL statement 
 *
 * @param array $data Query data
 * @return string
 */
      function renderStatement($data) {
            extract($data);
            if (preg_match('/offset\s+([0-9]+)/i', $limit, $offset)) {
                  $limit = preg_replace('/\s*offset.*$/i', '', $limit);
                  preg_match('/top\s+([0-9]+)/i', $limit, $limitVal);
                  $offset = intval($offset[1]) + intval($limitVal[1]);
                  $rOrder = $this->__switchSort($order);
                  list($order2, $rOrder) = array($this->__mapFields($order), $this->__mapFields($rOrder));
                  return "SELECT * FROM (SELECT {$limit} * FROM (SELECT TOP {$offset} {$fields} FROM {$table} {$alias} {$joins} {$conditions} {$order}) AS Set1 {$rOrder}) AS Set2 {$order2}";
            } else {
                  return "SELECT {$limit} {$fields} FROM {$table} {$alias} {$joins} {$conditions} {$order}";
            }
      }
/**
 * Reverses the sort direction of ORDER statements to get paging offsets to work correctly 
 *
 * @param string $order
 * @return string
 * @access private
 */
      function __switchSort($order) {
            $order = preg_replace('/\s+ASC/i', '__tmp_asc__', $order);
            $order = preg_replace('/\s+DESC/i', ' ASC', $order);
            return preg_replace('/__tmp_asc__/', ' DESC', $order);
      }
/**
 * Translates field names used for filtering and sorting to shortened names using the field map
 *
 * @param string $sql A snippet of SQL representing an ORDER or WHERE statement
 * @return string The value of $sql with field names replaced
 * @access private
 */
      function __mapFields($sql) {
            if (empty($sql) || empty($this->__fieldMappings)) {
                  return $sql;
            }
            foreach ($this->__fieldMappings as $key => $val) {
                  $sql = preg_replace('/' . preg_quote($val) . '/', $this->name($key), $sql);
                  $sql = preg_replace('/' . preg_quote($this->name($val)) . '/', $this->name($key), $sql);
            }
            return $sql;
      }
/**
 * Returns an array of all result rows for a given SQL query.
 * Returns false if no rows matched.
 *
 * @param string $sql SQL statement
 * @param boolean $cache Enables returning/storing cached query results
 * @return array Array of resultset rows, or false if no rows matched
 */
      function read(&$model, $queryData = array(), $recursive = null) {
            $results = parent::read($model, $queryData, $recursive);
            $this->__fieldMappings = array();
            $this->__fieldMapBase = null;
            return $results;
      }
/**
 * Fetches the next row from the current result set
 *
 * @return unknown
 */
      function fetchResult() {
            if ($row = mssql_fetch_row($this->results)) {
                  $resultRow = array();
                  $i = 0;

                  foreach($row as $index => $field) {
                        list($table, $column) = $this->map[$index];
                        $resultRow[$table][$column] = $row[$index];
                        $i++;
                  }
                  return $resultRow;
            } else {
                  return false;
            }
      }

      function buildSchemaQuery($schema) {
            $search = array('{AUTOINCREMENT}', '{PRIMARY}', '{UNSIGNED}', '{FULLTEXT}', '{BOOLEAN}', '{UTF_8}');

            $replace = array('int(11) not null auto_increment', 'primary key', 'unsigned', 'FULLTEXT',
            'enum (\'true\', \'false\') NOT NULL default \'true\'', '/*!40100 CHARACTER SET utf8 COLLATE utf8_unicode_ci */');

            $query = trim(r($search, $replace, $schema));
            return $query;
      }
}

?>

Generated by  Doxygen 1.6.0   Back to index