mirror of
https://github.com/kamilwylegala/cakephp2-php8.git
synced 2024-11-16 03:48:24 +00:00
897825d596
Standarizing on datatypes used in phpdocblocs and removing unneeded @return types git-svn-id: https://svn.cakephp.org/repo/branches/1.2.x.x@5851 3807eeeb-6ff5-0310-8944-8be069107fe0
678 lines
No EOL
18 KiB
PHP
678 lines
No EOL
18 KiB
PHP
<?php
|
|
/* SVN FILE: $Id$ */
|
|
/**
|
|
* MySQL 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.datasources.dbo
|
|
* @since CakePHP(tm) v 0.10.5.1790
|
|
* @version $Revision$
|
|
* @modifiedby $LastChangedBy$
|
|
* @lastmodified $Date$
|
|
* @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.datasources.dbo
|
|
*/
|
|
class DboMysql extends DboSource {
|
|
/**
|
|
* Enter description here...
|
|
*
|
|
* @var unknown_type
|
|
*/
|
|
var $description = "MySQL DBO Driver";
|
|
/**
|
|
* Enter description here...
|
|
*
|
|
* @var unknown_type
|
|
*/
|
|
var $startQuote = "`";
|
|
/**
|
|
* Enter description here...
|
|
*
|
|
* @var unknown_type
|
|
*/
|
|
var $endQuote = "`";
|
|
/**
|
|
* Base configuration settings for MySQL driver
|
|
*
|
|
* @var array
|
|
*/
|
|
var $_baseConfig = array(
|
|
'persistent' => true,
|
|
'host' => 'localhost',
|
|
'login' => 'root',
|
|
'password' => '',
|
|
'database' => 'cake',
|
|
'port' => '3306',
|
|
'connect' => 'mysql_pconnect'
|
|
);
|
|
/**
|
|
* MySQL column definition
|
|
*
|
|
* @var array
|
|
*/
|
|
var $columns = array(
|
|
'primary_key' => array('name' => 'int(11) DEFAULT NULL auto_increment'),
|
|
'string' => array('name' => 'varchar', 'limit' => '255'),
|
|
'text' => array('name' => 'text'),
|
|
'integer' => array('name' => 'int', 'limit' => '11', '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' => 'time', 'format' => 'H:i:s', 'formatter' => 'date'),
|
|
'date' => array('name' => 'date', 'format' => 'Y-m-d', 'formatter' => 'date'),
|
|
'binary' => array('name' => 'blob'),
|
|
'boolean' => array('name' => 'tinyint', 'limit' => '1')
|
|
);
|
|
/**
|
|
* Connects to the database using options in the given configuration array.
|
|
*
|
|
* @return bool True if the database could be connected, else false
|
|
*/
|
|
function connect() {
|
|
$config = $this->config;
|
|
$connect = $config['connect'];
|
|
$this->connected = false;
|
|
|
|
if (!$config['persistent'] || $config['connect'] === 'mysql_connect') {
|
|
$this->connection = mysql_connect($config['host'] . ':' . $config['port'], $config['login'], $config['password'], true);
|
|
} else {
|
|
$this->connection = $connect($config['host'] . ':' . $config['port'], $config['login'], $config['password']);
|
|
}
|
|
|
|
if (mysql_select_db($config['database'], $this->connection)) {
|
|
$this->connected = true;
|
|
}
|
|
|
|
if (isset($config['encoding']) && !empty($config['encoding'])) {
|
|
$this->setEncoding($config['encoding']);
|
|
}
|
|
|
|
return $this->connected;
|
|
}
|
|
/**
|
|
* Disconnects from database.
|
|
*
|
|
* @return bool True if the database could be disconnected, else false
|
|
*/
|
|
function disconnect() {
|
|
@mysql_free_result($this->results);
|
|
$this->connected = !@mysql_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 mysql_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->_execute('SHOW TABLES FROM ' . $this->name($this->config['database']) . ';');
|
|
|
|
if (!$result) {
|
|
return array();
|
|
} else {
|
|
$tables = array();
|
|
|
|
while ($line = mysql_fetch_array($result)) {
|
|
$tables[] = $line[0];
|
|
}
|
|
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) {
|
|
$cache = parent::describe($model);
|
|
if ($cache != null) {
|
|
return $cache;
|
|
}
|
|
$fields = false;
|
|
$cols = $this->query('DESCRIBE ' . $this->fullTableName($model));
|
|
|
|
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])) {
|
|
$fields[$column[0]['Field']] = array(
|
|
'type' => $this->column($column[0]['Type']),
|
|
'null' => ($column[0]['Null'] == 'YES' ? true : false),
|
|
'default' => $column[0]['Default'],
|
|
'length' => $this->length($column[0]['Type']),
|
|
);
|
|
if(!empty($column[0]['Key']) && isset($this->index[$column[0]['Key']])) {
|
|
$fields[$column[0]['Field']]['key'] = $this->index[$column[0]['Key']];
|
|
}
|
|
if(!empty($column[0]['Extra'])) {
|
|
$fields[$column[0]['Field']]['extra'] = $column[0]['Extra'];
|
|
}
|
|
}
|
|
}
|
|
$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 bool $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;
|
|
case 'integer' :
|
|
case 'float' :
|
|
case null :
|
|
if (is_numeric($data) && strpos($data, ',') === false && $data[0] != '0' && strpos($data, 'e') === false) {
|
|
break;
|
|
}
|
|
default:
|
|
$data = "'" . mysql_real_escape_string($data, $this->connection) . "'";
|
|
break;
|
|
}
|
|
|
|
return $data;
|
|
}
|
|
/**
|
|
* Begin a transaction
|
|
*
|
|
* @param unknown_type $model
|
|
* @return bool 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('START TRANSACTION')) {
|
|
$this->_transactionStarted = true;
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
/**
|
|
* Commit a transaction
|
|
*
|
|
* @param unknown_type $model
|
|
* @return bool 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 bool 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 with error number
|
|
*/
|
|
function lastError() {
|
|
if (mysql_errno($this->connection)) {
|
|
return mysql_errno($this->connection).': '.mysql_error($this->connection);
|
|
}
|
|
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 mysql_affected_rows($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 and is_resource($this->_result)) {
|
|
return @mysql_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->fetchRow('SELECT LAST_INSERT_ID() AS insertID', false);
|
|
if ($id !== false && !empty($id) && !empty($id[0]) && isset($id[0]['insertID'])) {
|
|
return $id[0]['insertID'];
|
|
}
|
|
|
|
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 = $this->length($real);
|
|
@list($col,$vals) = explode('(', $col);
|
|
|
|
if (in_array($col, array('date', 'time', 'datetime', 'timestamp'))) {
|
|
return $col;
|
|
}
|
|
if ($col == 'tinyint' && $limit == 1) {
|
|
return 'boolean';
|
|
}
|
|
if (strpos($col, 'int') !== false) {
|
|
return 'integer';
|
|
}
|
|
if (strpos($col, 'char') !== false || $col == 'tinytext') {
|
|
return 'string';
|
|
}
|
|
if (strpos($col, 'text') !== false) {
|
|
return 'text';
|
|
}
|
|
if (strpos($col, 'blob') !== false || $col == 'binary') {
|
|
return 'binary';
|
|
}
|
|
if (in_array($col, array('float', 'double', 'decimal'))) {
|
|
return 'float';
|
|
}
|
|
if (strpos($col, 'enum') !== false) {
|
|
return "enum($vals)";
|
|
}
|
|
if ($col == 'boolean') {
|
|
return $col;
|
|
}
|
|
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);
|
|
}
|
|
return null;
|
|
}
|
|
/**
|
|
* Enter description here...
|
|
*
|
|
* @param unknown_type $results
|
|
*/
|
|
function resultSet(&$results) {
|
|
$this->results =& $results;
|
|
$this->map = array();
|
|
$num_fields = mysql_num_fields($results);
|
|
$index = 0;
|
|
$j = 0;
|
|
|
|
while ($j < $num_fields) {
|
|
|
|
$column = mysql_fetch_field($results,$j);
|
|
if (!empty($column->table)) {
|
|
$this->map[$index++] = array($column->table, $column->name);
|
|
} else {
|
|
$this->map[$index++] = array(0, $column->name);
|
|
}
|
|
$j++;
|
|
}
|
|
}
|
|
/**
|
|
* Fetches the next row from the current result set
|
|
*
|
|
* @return unknown
|
|
*/
|
|
function fetchResult() {
|
|
if ($row = mysql_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;
|
|
}
|
|
}
|
|
/**
|
|
* Sets the database encoding
|
|
*
|
|
* @param string $enc Database encoding
|
|
*/
|
|
function setEncoding($enc) {
|
|
return $this->_execute('SET NAMES ' . $enc) != false;
|
|
}
|
|
/**
|
|
* Gets the database encoding
|
|
*
|
|
* @return string The database encoding
|
|
*/
|
|
function getEncoding() {
|
|
return mysql_client_encoding($this->connection);
|
|
}
|
|
/**
|
|
* Returns an array of the indexes in given table name.
|
|
*
|
|
* @param string $model Name of model to inspect
|
|
* @return array Fields in table. Keys are column and unique
|
|
*/
|
|
function index($model) {
|
|
$index = array();
|
|
$table = $this->fullTableName($model, false);
|
|
if($table) {
|
|
$indexes = $this->query('SHOW INDEX FROM ' . $table);
|
|
$keys = Set::extract($indexes, '{n}.STATISTICS');
|
|
foreach ($keys as $i => $key) {
|
|
if(!isset($index[$key['Key_name']])) {
|
|
$index[$key['Key_name']]['column'] = $key['Column_name'];
|
|
$index[$key['Key_name']]['unique'] = ife($key['Non_unique'] == 0, 1, 0);
|
|
} else {
|
|
if(!is_array($index[$key['Key_name']]['column'])) {
|
|
$col[] = $index[$key['Key_name']]['column'];
|
|
}
|
|
$col[] = $key['Column_name'];
|
|
$index[$key['Key_name']]['column'] = $col;
|
|
}
|
|
}
|
|
}
|
|
return $index;
|
|
}
|
|
/**
|
|
* Generate a MySQL schema for the given Schema object
|
|
*
|
|
* @param object $schema An instance of a subclass of CakeSchema
|
|
* @param string $table Optional. If specified only the table name given will be generated.
|
|
* Otherwise, all tables defined in the schema are generated.
|
|
* @return string
|
|
*/
|
|
function createSchema($schema, $table = null) {
|
|
if (!is_a($schema, 'CakeSchema')) {
|
|
trigger_error(__('Invalid schema object', true), E_USER_WARNING);
|
|
return null;
|
|
}
|
|
$out = '';
|
|
foreach ($schema->tables as $curTable => $columns) {
|
|
if (!$table || $table == $curTable) {
|
|
$out .= 'CREATE TABLE ' . $this->fullTableName($curTable) . " (\n";
|
|
$cols = $colList = $index = array();
|
|
$primary = null;
|
|
foreach ($columns as $name => $col) {
|
|
if (is_string($col)) {
|
|
$col = array('type' => $col);
|
|
}
|
|
if (isset($col['key']) && $col['key'] == 'primary') {
|
|
$primary = $name;
|
|
}
|
|
if($name !== 'indexes') {
|
|
$col['name'] = $name;
|
|
if(!isset($col['type'])) {
|
|
$col['type'] = 'string';
|
|
}
|
|
$cols[] = $this->buildColumn($col);
|
|
} else {
|
|
$index[] = $this->buildIndex($col);
|
|
}
|
|
|
|
}
|
|
if(empty($index) && !empty($primary)) {
|
|
$col = array('PRIMARY' => array('column'=> $primary, 'unique' => 1));
|
|
$index[] = $this->buildIndex($col);
|
|
}
|
|
$out .= "\t" . join(",\n\t", $cols) . ",\n\t". join(",\n\t", $index) . "\n);\n\n";
|
|
}
|
|
}
|
|
return $out;
|
|
}
|
|
/**
|
|
* Generate a MySQL Alter Table syntax for the given Schema comparison
|
|
*
|
|
* @param unknown_type $schema
|
|
* @return unknown
|
|
*/
|
|
function alterSchema($compare, $table = null) {
|
|
if(!is_array($compare)) {
|
|
return false;
|
|
}
|
|
$out = '';
|
|
$colList = array();
|
|
foreach($compare as $curTable => $types) {
|
|
if (!$table || $table == $curTable) {
|
|
$out .= 'ALTER TABLE ' . $this->fullTableName($curTable) . " \n";
|
|
foreach($types as $type => $column) {
|
|
switch($type) {
|
|
case 'add':
|
|
foreach($column as $field => $col) {
|
|
$col['name'] = $field;
|
|
$alter = 'ADD '.$this->buildColumn($col);
|
|
if(isset($col['after'])) {
|
|
$alter .= ' AFTER '. $this->name($col['after']);
|
|
}
|
|
$colList[] = $alter;
|
|
}
|
|
break;
|
|
case 'drop':
|
|
foreach($column as $field => $col) {
|
|
$col['name'] = $field;
|
|
$colList[] = 'DROP '.$this->name($field);
|
|
}
|
|
break;
|
|
case 'change':
|
|
foreach($column as $field => $col) {
|
|
if(!isset($col['name'])) {
|
|
$col['name'] = $field;
|
|
}
|
|
$colList[] = 'CHANGE '. $this->name($field).' '.$this->buildColumn($col);
|
|
}
|
|
break;
|
|
}
|
|
}
|
|
$out .= "\t" . join(",\n\t", $colList) . ";\n\n";
|
|
}
|
|
}
|
|
return $out;
|
|
}
|
|
/**
|
|
* Generate a MySQL Drop table for the given Schema object
|
|
*
|
|
* @param object $schema An instance of a subclass of CakeSchema
|
|
* @param string $table Optional. If specified only the table name given will be generated.
|
|
* Otherwise, all tables defined in the schema are generated.
|
|
* @return string
|
|
*/
|
|
function dropSchema($schema, $table = null) {
|
|
if (!is_a($schema, 'CakeSchema')) {
|
|
trigger_error(__('Invalid schema object', true), E_USER_WARNING);
|
|
return null;
|
|
}
|
|
$out = '';
|
|
foreach ($schema->tables as $curTable => $columns) {
|
|
if (!$table || $table == $curTable) {
|
|
$out .= 'DROP TABLE IF EXISTS ' . $this->fullTableName($curTable) . ";\n";
|
|
}
|
|
}
|
|
return $out;
|
|
}
|
|
/**
|
|
* Generate a MySQL-native column schema string
|
|
*
|
|
* @param array $column An array structured like the following: array('name'=>'value', 'type'=>'value'[, options]),
|
|
* where options can be 'default', 'length', or 'key'.
|
|
* @return string
|
|
*/
|
|
function buildColumn($column) {
|
|
$name = $type = null;
|
|
$column = am(array('null' => true), $column);
|
|
extract($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;
|
|
}
|
|
|
|
$real = $this->columns[$type];
|
|
$out = $this->name($name) . ' ' . $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' && (isset($column['extra']) && $column['extra'] == 'auto_increment')) {
|
|
$out .= ' NOT NULL AUTO_INCREMENT';
|
|
} elseif (isset($column['key']) && $column['key'] == 'primary') {
|
|
$out .= ' NOT NULL';
|
|
} elseif (isset($column['default']) && isset($column['null']) && $column['null'] == false) {
|
|
$out .= ' DEFAULT ' . $this->value($column['default'], $type) . ' NOT NULL';
|
|
} elseif (isset($column['default'])) {
|
|
$out .= ' DEFAULT ' . $this->value($column['default'], $type);
|
|
} elseif (isset($column['null']) && $column['null'] == true) {
|
|
$out .= ' DEFAULT NULL';
|
|
} elseif (isset($column['null']) && $column['null'] == false) {
|
|
$out .= ' NOT NULL';
|
|
}
|
|
|
|
return $out;
|
|
}
|
|
/**
|
|
* Format indexes for create table
|
|
*
|
|
* @param array $indexes
|
|
* @return string
|
|
*/
|
|
function buildIndex($indexes) {
|
|
$join = array();
|
|
foreach ($indexes as $name => $value) {
|
|
$out = '';
|
|
if ($name == 'PRIMARY') {
|
|
$out .= 'PRIMARY ';
|
|
$name = null;
|
|
} else {
|
|
if (!empty($value['unique'])) {
|
|
$out .= 'UNIQUE ';
|
|
}
|
|
}
|
|
if (is_array($value['column'])) {
|
|
$out .= 'KEY '. $name .' (' . join(', ', array_map(array(&$this, 'name'), $value['column'])) . ')';
|
|
} else {
|
|
$out .= 'KEY '. $name .' (' . $this->name($value['column']) . ')';
|
|
}
|
|
$join[] = $out;
|
|
}
|
|
return join(",\n\t", $join);
|
|
}
|
|
}
|
|
?>
|