/
Collection.php
186 lines (167 loc) · 5.09 KB
/
Collection.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
<?php
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @since 3.0.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Database\Schema;
use Cake\Cache\Cache;
use Cake\Database\Connection;
use Cake\Database\Exception;
use Cake\Database\Schema\Table;
/**
* Represents a database schema collection
*
* Used to access information about the tables,
* and other data in a database.
*/
class Collection {
/**
* Connection object
*
* @var \Cake\Database\Connection
*/
protected $_connection;
/**
* Schema dialect instance.
*
* @var \Cake\Database\Schema\BaseSchema
*/
protected $_dialect;
/**
* The name of the cache config key to use for caching table metadata,
* of false if disabled.
*
* @var string|bool
*/
protected $_cache = false;
/**
* Constructor.
*
* @param \Cake\Database\Connection $connection
*/
public function __construct(Connection $connection) {
$this->_connection = $connection;
$this->_dialect = $connection->driver()->schemaDialect();
$config = $this->_connection->config();
if (!empty($config['cacheMetadata'])) {
$this->cacheMetadata(true);
}
}
/**
* Get the list of tables available in the current connection.
*
* @return array The list of tables in the connected database/schema.
*/
public function listTables() {
list($sql, $params) = $this->_dialect->listTablesSql($this->_connection->config());
$result = [];
$statement = $this->_connection->execute($sql, $params);
while ($row = $statement->fetch()) {
$result[] = $row[0];
}
$statement->closeCursor();
return $result;
}
/**
* Get the column metadata for a table.
*
* Caching will be applied if `cacheMetadata` key is present in the Connection
* configuration options. Defaults to _cake_model_ when true.
*
* ### Options
*
* - `forceRefresh` - Set to true to force rebuilding the cached metadata.
* Defaults to false.
*
* @param string $name The name of the table to describe.
* @param array $options The options to use, see above.
* @return \Cake\Database\Schema\Table Object with column metadata.
* @throws \Cake\Database\Exception when table cannot be described.
*/
public function describe($name, array $options) {
$options += ['forceRefresh' => false];
$cacheConfig = $this->cacheMetadata();
$cacheKey = $this->cacheKey($name);
if (!empty($cacheConfig) && !$options['forceRefresh']) {
$cached = Cache::read($cacheKey, $cacheConfig);
if ($cached !== false) {
return $cached;
}
}
$config = $this->_connection->config();
list($sql, $params) = $this->_dialect->describeTableSql($name, $config);
$statement = $this->_executeSql($sql, $params);
if (count($statement) === 0) {
throw new Exception(sprintf('Cannot describe %s. It has 0 columns.', $name));
}
$table = new Table($name);
foreach ($statement->fetchAll('assoc') as $row) {
$this->_dialect->convertFieldDescription($table, $row);
}
list($sql, $params) = $this->_dialect->describeIndexSql($name, $config);
$statement = $this->_executeSql($sql, $params);
foreach ($statement->fetchAll('assoc') as $row) {
$this->_dialect->convertIndexDescription($table, $row);
}
list($sql, $params) = $this->_dialect->describeForeignKeySql($name, $config);
$statement = $this->_executeSql($sql, $params);
foreach ($statement->fetchAll('assoc') as $row) {
$this->_dialect->convertForeignKeyDescription($table, $row);
}
$statement->closeCursor();
if (!empty($cacheConfig)) {
Cache::write($cacheKey, $table, $cacheConfig);
}
return $table;
}
/**
* Get the cache key for a given name.
*
* @param string $name The name to get a cache key for.
* @return string The cache key.
*/
public function cacheKey($name) {
return $this->_connection->configName() . '_' . $name;
}
/**
* Sets the cache config name to use for caching table metadata, or
* disabels it if false is passed.
* If called with no arguments it returns the current configuration name.
*
* @param bool $enable whether or not to enable caching
* @return string|bool
*/
public function cacheMetadata($enable = null) {
if ($enable === null) {
return $this->_cache;
}
if ($enable === true) {
$enable = '_cake_model_';
}
return $this->_cache = $enable;
}
/**
* Helper method to run queries and convert Exceptions to the correct types.
*
* @param string $sql The sql to run.
* @param array $params Parameters for the statement.
* @return \Cake\Database\StatementInterface Prepared statement
* @throws \Cake\Database\Exception on query failure.
*/
protected function _executeSql($sql, $params) {
try {
return $this->_connection->execute($sql, $params);
} catch (\PDOException $e) {
throw new Exception($e->getMessage(), 500, $e);
}
}
}