Logo Search packages:      
Sourcecode: cakephp version File versions

dbo_postgres.php

<?php
/* SVN FILE: $Id: dbo_postgres.php 5134 2007-05-20 06:44:09Z phpnut $ */

/**
 * PostgreSQL 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.9.1.114
 * @version             $Revision: 5134 $
 * @modifiedby          $LastChangedBy: phpnut $
 * @lastmodified  $Date: 2007-05-20 01:44:09 -0500 (Sun, 20 May 2007) $
 * @license             http://www.opensource.org/licenses/mit-license.php The MIT License
 */

/**
 * PostgreSQL layer for DBO.
 *
 * Long description for class
 *
 * @package       cake
 * @subpackage    cake.cake.libs.model.dbo
 */
class DboPostgres extends DboSource {

      var $description = "PostgreSQL DBO Driver";

      var $_baseConfig = array(
            'connect'   => 'pg_pconnect',
            'persistent' => true,
            'host' => 'localhost',
            'login' => 'root',
            'password' => '',
            'database' => 'cake',
            'schema' => 'public',
            'port' => 5432,
            'encoding' => ''
      );

      var $columns = array(
            'primary_key' => array('name' => 'serial NOT NULL'),
            'string' => array('name'  => 'varchar', 'limit' => '255'),
            'text' => array('name' => 'text'),
            'integer' => array('name' => 'integer', 'formatter' => 'intval'),
            'float' => array('name' => 'float', 'formatter' => 'floatval'),
            'datetime' => array('name' => 'timestamp', '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' => 'time', 'format' => 'H:i:s', 'formatter' => 'date'),
            'date' => array('name' => 'date', 'format' => 'Y-m-d', 'formatter' => 'date'),
            'binary' => array('name' => 'bytea'),
            'boolean' => array('name' => 'boolean'),
            'number' => array('name' => 'numeric'),
            'inet' => array('name'  => 'inet')
      );

      var $startQuote = '"';

      var $endQuote = '"';
/**
 * Contains mappings of custom auto-increment sequences, if a table uses a sequence name
 * other than what is dictated by convention.
 *
 * @var array
 */
      var $_sequenceMap = array();
/**
 * Connects to the database using options in the given configuration array.
 *
 * @return True if successfully connected.
 */
      function connect() {

            $config = $this->config;
            $connect = $config['connect'];
            $this->connection = $connect("host='{$config['host']}' port='{$config['port']}' dbname='{$config['database']}' user='{$config['login']}' password='{$config['password']}'");

            if ($this->connection) {
                  $this->connected = true;
            } else {
                  $this->connected = false;
            }
            if (!empty($config['encoding'])) {
                  $this->setEncoding($config['encoding']);
            }

            return $this->connected;
      }

/**
 * Disconnects from database.
 *
 * @return boolean True if the database could be disconnected, else false
 */
      function disconnect() {
            @pg_free_result($this->results);
            $this->connected = !@pg_close($this->connection);
            return !$this->connected;
      }

/**
 * Executes given SQL statement.
 *
 * @param string $sql SQL statement
 * @return resource Result resource identifier
 */
      function _execute($sql) {
            return pg_query($this->connection, $sql);
      }
/**
 * Returns an array of tables in the database. If there are no tables, an error is raised and the application exits.
 *
 * @return array Array of tablenames in the database
 */
      function listSources() {
            $cache = parent::listSources();

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

            $schema = $this->config['schema'];
            $sql = "SELECT table_name as name FROM INFORMATION_SCHEMA.tables WHERE table_schema = '{$schema}';";
            $result = $this->fetchAll($sql);

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

                  foreach($result as $item) {
                        $tables[] = $item[0]['name'];
                  }

                  parent::listSources($tables);
                  return $tables;
            }
      }

/**
 * Returns an array of the fields in given table name.
 *
 * @param string $tableName Name of database table to inspect
 * @return array Fields in table. Keys are name and type
 */
      function &describe(&$model) {
            if (isset($model->sequence)) {
                  $this->_sequenceMap[$this->fullTableName($model, false)] = $model->sequence;
            }

            $cache = parent::describe($model);
            if ($cache != null) {
                  return $cache;
            }

            $fields = false;
            $cols = $this->fetchAll("SELECT DISTINCT column_name AS name, data_type AS type, is_nullable AS null, column_default AS default, ordinal_position AS position, character_maximum_length AS char_length, character_octet_length AS oct_length FROM information_schema.columns WHERE table_name =" . $this->value($model->tablePrefix . $model->table) . " ORDER BY position");

            foreach($cols as $column) {
                  $colKey = array_keys($column);

                  if (isset($column[$colKey[0]]) && !isset($column[0])) {
                        $column[0] = $column[$colKey[0]];
                  }

                  if (isset($column[0])) {
                        $c = $column[0];
                        if (strpos($c['default'], 'nextval(') === 0) {
                              $c['default'] = null;
                        }
                        if (!empty($c['char_length'])) {
                              $length = intval($c['char_length']);
                        } elseif (!empty($c['oct_length'])) {
                              $length = intval($c['oct_length']);
                        } else {
                              $length = $this->length($c['type']);
                        }
                        $fields[] = array(
                              'name'    => $c['name'],
                              'type'    => $this->column($c['type']),
                              'null'    => ($c['null'] == 'NO' ? false : true),
                              'default' => $c['default'],
                              'length'  => $length
                        );
                  }
            }
            $this->__cacheDescription($model->tablePrefix . $model->table, $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
 * @return string Quoted and escaped
 * @todo Add logic that formats/escapes data based on column type
 */
      function value($data, $column = null) {

            $parent = parent::value($data, $column);
            if ($parent != null) {
                  return $parent;
            }

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

            switch($column) {
                  case 'inet':
                        if (!strlen($data)){
                              return 'DEFAULT';
                        } else {
                              $data = pg_escape_string($data);
                        }
                  break;
                  case 'integer':
                        if ($data === '') {
                              return 'DEFAULT';
                        } else {
                              $data = pg_escape_string($data);
                        }
                  break;
                  case 'binary':
                        $data = pg_escape_bytea($data);

                  break;
                  case 'boolean':
                        $data = $this->boolean((bool)$data, false);
                        if ($data === true) {
                              $data = '1';
                        } elseif ($data === false) {
                              $data = '0';
                        }
                  break;
                  default:
                        $data = pg_escape_string($data);
                  break;
            }
            return "'" . $data . "'";
      }

/**
 * 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')) {
                        $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;
      }

/**
 * Returns a formatted error message from previous database operation.
 *
 * @return string Error message
 */
      function lastError() {
            $last_error = pg_last_error($this->connection);
            if ($last_error) {
                  return $last_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 = pg_affected_rows($this->_result);
                  return $return;
            }
            return false;
      }
/**
 * 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 = pg_num_rows($this->_result);
                  return $return;
            }
            return false;
      }
/**
 * Returns the ID generated from the previous INSERT operation.
 *
 * @param string $source Name of the database table
 * @param string $field Name of the ID database field. Defaults to "id"
 * @return int
 */
      function lastInsertId($source, $field = 'id') {
            foreach ($this->__descriptions[$source] as $sourceinfo) {
                  if (strcasecmp($sourceinfo['name'], $field) == 0) {
                        break;
                  }
            }

            if (isset($this->_sequenceMap[$source])) {
                  $seq = $this->_sequenceMap[$source];
            } elseif (preg_match('/^nextval\(\'(\w+)\'/', $sourceinfo['default'], $matches)) {
                  $seq = $matches[1];
            } else {
                  $seq = "{$source}_{$field}_seq";
            }

            $res = $this->rawQuery("SELECT last_value AS max FROM \"{$seq}\"");
            $data = $this->fetchRow($res);
            return $data[0]['max'];
      }
/**
 * 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);

            if (!$quote) {
                  return $fields;
            }
            $count = count($fields);

            if ($count >= 1 && $fields[0] != '*' && strpos($fields[0], 'COUNT(*)') === false) {
                  for($i = 0; $i < $count; $i++) {
                        if (!preg_match('/^.+\\(.*\\)/', $fields[$i]) && !preg_match('/\s+AS\s+/', $fields[$i])) {
                              $prepend = '';
                              if (strpos($fields[$i], 'DISTINCT') !== false) {
                                    $prepend = 'DISTINCT ';
                                    $fields[$i] = trim(r('DISTINCT', '', $fields[$i]));
                              }

                              $dot = strrpos($fields[$i], '.');
                              if ($dot === false) {
                                    $fields[$i] = $prepend . $this->name($alias) . '.' . $this->name($fields[$i]) . ' AS ' . $this->name($alias . '__' . $fields[$i]);
                              } else {
                                    $build = explode('.', $fields[$i]);
                                    $fields[$i] = $prepend . $this->name($build[0]) . '.' . $this->name($build[1]) . ' AS ' . $this->name($build[0] . '__' . $build[1]);
                              }
                        }
                  }
            }
            return $fields;
      }
/**
 * 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), 'limit') || strpos(strtolower($limit), 'limit') === 0) {
                        $rt = ' LIMIT';
                  }

                  $rt .= ' ' . $limit;
                  if ($offset) {
                        $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'))) {
                  return $col;
            }
            if (strpos($col, 'timestamp') !== false) {
                  return 'datetime';
            }
            if ($col == 'inet') {
                  return('inet');
            }
            if ($col == 'boolean') {
                  return 'boolean';
            }
            if (strpos($col, 'int') !== false && $col != 'interval') {
                  return 'integer';
            }
            if (strpos($col, 'char') !== false) {
                  return 'string';
            }
            if (strpos($col, 'text') !== false) {
                  return 'text';
            }
            if (strpos($col, 'bytea') !== false) {
                  return 'binary';
            }
            if (in_array($col, array('float', 'float4', 'float8', 'double', 'double precision', 'decimal', 'real', 'numeric'))) {
                  return 'float';
            }
            return 'text';
      }
/**
 * Gets the length of a database-native column description, or null if no length
 *
 * @param string $real Real database-layer column type (i.e. "varchar(255)")
 * @return int An integer representing the length of the column
 */
      function length($real) {
            $col = r(array(')', 'unsigned'), '', $real);
            $limit = null;

            if (strpos($col, '(') !== false) {
                  list($col, $limit) = explode('(', $col);
            }

            if ($limit != null) {
                  return intval($limit);
            } elseif ($col == 'integer') {
                  return 11;
            } elseif (in_array($col, array('int2', 'int4', 'int8'))) {
                  return intval(r('int', '', $col));
            }
            return null;
      }
/**
 * Enter description here...
 *
 * @param unknown_type $results
 */
      function resultSet(&$results) {
            $this->results =& $results;
            $this->map = array();
            $num_fields = pg_num_fields($results);
            $index = 0;
            $j = 0;

            while($j < $num_fields) {
                  $columnName = pg_field_name($results, $j);

                  if (strpos($columnName, '__')) {
                        $parts = explode('__', $columnName);
                        $this->map[$index++] = array($parts[0], $parts[1]);
                  } else {
                        $this->map[$index++] = array(0, $columnName);
                  }
                  $j++;
            }
      }
/**
 * Fetches the next row from the current result set
 *
 * @return unknown
 */
      function fetchResult() {
            if ($row = pg_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;
            }
      }
/**
 * Translates between PHP boolean values and PostgreSQL boolean values
 *
 * @param mixed $data Value to be translated
 * @param boolean $quote      True to quote value, false otherwise
 * @return mixed Converted boolean value
 */
      function boolean($data, $quote = true) {
            $result = null;

            if ($data === true || $data === false) {
                  $result = $data;
            } elseif (is_string($data) && !is_numeric($data)) {
                  if (strpos($data, 't') !== false) {
                        $result = true;
                  } else {
                        $result = false;
                  }
            } else {
                  $result = (bool)$data;
            }

            if ($quote) {
                  $result = "'" . $result . "'";
            }

            return $result;
      }
/**
 * Sets the database encoding
 *
 * @param mixed $enc Database encoding
 * @return boolean True on success, false on failure
 */
      function setEncoding($enc) {
            return pg_set_client_encoding($this->connection, $enc) == 0;
      }
/**
 * Gets the database encoding
 *
 * @return string The database encoding
 */
      function getEncoding() {
            return pg_client_encoding($this->connection);
      }
/**
 * Generate a PostgreSQL-native column schema string
 *
 * @param array $column An array structured like the following: array('name', 'type'[, options]),
 *                      where options can be 'default', 'length', or 'key'.
 * @return string
 */
      function generateColumnSchema($column) {
            $name = $type = $out = null;
            $column = am(array('null' => true), $column);
            list($name, $type) = $column;

            if (empty($name) || empty($type)) {
                  trigger_error('Column name or type not defined in schema', E_USER_WARNING);
                  return null;
            }
            if (!isset($this->columns[$type])) {
                  trigger_error("Column type {$type} does not exist", E_USER_WARNING);
                  return null;
            }
            $out = "\t" . $this->name($name) . ' ';

            if (!isset($column['key']) || $column['key'] != 'primary') {
                  $real = $this->columns[$type];
                  $out .= $real['name'];

                  if (isset($real['limit']) || isset($real['length']) || isset($column['limit']) || isset($column['length'])) {
                        if (isset($column['length'])) {
                              $length = $column['length'];
                        } elseif (isset($column['limit'])) {
                              $length = $column['limit'];
                        } elseif (isset($real['length'])) {
                              $length = $real['length'];
                        } else {
                              $length = $real['limit'];
                        }
                        $out .= '(' . $length . ')';
                  }
            }

            if (isset($column['key']) && $column['key'] == 'primary') {
                  $out .= $this->columns['primary_key']['name'];
            } elseif (isset($column['default'])) {
                  $out .= ' DEFAULT ' . $this->value($column['default'], $type);
            } elseif (isset($column['null']) && $column['null'] == true) {
                  $out .= ' DEFAULT NULL';
            } elseif (isset($column['default']) && isset($column['null']) && $column['null'] == false) {
                  $out .= ' DEFAULT ' . $this->value($column['default'], $type) . ' NOT NULL';
            } elseif (isset($column['null']) && $column['null'] == false) {
                  $out .= ' NOT NULL';
            }
            return $out;
      }
}

?>

Generated by  Doxygen 1.6.0   Back to index