/
PDODriverTrait.php
154 lines (140 loc) · 3.54 KB
/
PDODriverTrait.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
<?php
/**
* PHP Version 5.4
*
* 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 CakePHP(tm) v 3.0.0
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
namespace Cake\Database\Driver;
use Cake\Database\Query;
use Cake\Database\Statement\PDOStatement;
use PDO;
trait PDODriverTrait {
/**
* Instance of PDO.
*
* @var \PDO
*/
protected $_connection;
/**
* Establishes a connection to the databse server
*
* @param array $config configuration to be used for creating connection
* @return boolean true on success
*/
protected function _connect(array $config) {
$connection = new PDO(
$config['dsn'],
$config['login'],
$config['password'],
$config['flags']
);
$this->connection($connection);
return true;
}
/**
* Returns correct connection resource or object that is internally used
* If first argument is passed, it will set internal conenction object or
* result to the value passed
*
* @return mixed connection object used internally
*/
public function connection($connection = null) {
if ($connection !== null) {
$this->_connection = $connection;
}
return $this->_connection;
}
/**
* Disconnects from database server
*
* @return void
*/
public function disconnect() {
$this->_connection = null;
}
/**
* Prepares a sql statement to be executed
*
* @param string|Cake\Database\Query $query
* @return Cake\Database\Statement
*/
public function prepare($query) {
$this->connect();
$sql = $query instanceof Query ? $query->sql() : $query;
$statement = $this->_connection->prepare($sql);
return new PDOStatement($statement, $this);
}
/**
* Starts a transaction
*
* @return boolean true on success, false otherwise
*/
public function beginTransaction() {
$this->connect();
if ($this->_connection->inTransaction()) {
return true;
}
return $this->_connection->beginTransaction();
}
/**
* Commits a transaction
*
* @return boolean true on success, false otherwise
*/
public function commitTransaction() {
$this->connect();
if (!$this->_connection->inTransaction()) {
return false;
}
return $this->_connection->commit();
}
/**
* Rollsback a transaction
*
* @return boolean true on success, false otherwise
*/
public function rollbackTransaction() {
if (!$this->_connection->inTransaction()) {
return false;
}
return $this->_connection->rollback();
}
/**
* Returns a value in a safe representation to be used in a query string
*
* @return string
*/
public function quote($value, $type) {
$this->connect();
return $this->_connection->quote($value, $type);
}
/**
* Returns last id generated for a table or sequence in database
*
* @param string $table table name or sequence to get last insert value from
* @return string|integer
*/
public function lastInsertId($table = null, $column = null) {
$this->connect();
return $this->_connection->lastInsertId($table);
}
/**
* Checks if the driver supports quoting, as PDO_ODBC does not support it.
*
* @return boolean
*/
public function supportsQuoting() {
$this->connect();
return $this->_connection->getAttribute(PDO::ATTR_DRIVER_NAME) !== 'odbc';
}
}