-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
Driver.php
123 lines (108 loc) · 2.85 KB
/
Driver.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
<?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
* @package Cake.Model
* @since CakePHP(tm) v 3.0.0
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
namespace Cake\Database;
use \Cake\Database\SqlDialectTrait;
/**
* Represents a database diver containing all specificities for
* a database engine including its SQL dialect
*
**/
abstract class Driver {
/**
* Establishes a connection to the database server
*
* @param array $config configuration to be used for creating connection
* @return boolean true con success
**/
public abstract function connect(array $config);
/**
* Disconnects from database server
*
* @return void
**/
public abstract function disconnect();
/**
* Returns correct connection resource or object that is internally used
* If first argument is passed,
*
* @return void
**/
public abstract function connection($connection = null);
/**
* Returns whether php is able to use this driver for connecting to database
*
* @return boolean true if it is valid to use this driver
**/
public abstract function enabled();
/**
* Prepares a sql statement to be executed
*
* @param string $sql
* @return Cake\Database\Statement
**/
public abstract function prepare($sql);
/**
* Starts a transaction
*
* @return boolean true on success, false otherwise
**/
public abstract function beginTransaction();
/**
* Commits a transaction
*
* @return boolean true on success, false otherwise
**/
public abstract function commitTransaction();
/**
* Rollsback a transaction
*
* @return boolean true on success, false otherwise
**/
public abstract function rollbackTransaction();
/**
* Returns whether this driver supports save points for nested transactions
*
* @return boolean true if save points are supported, false otherwise
**/
public function supportsSavePoints() {
return true;
}
/**
* Returns a value in a safe representation to be used in a query string
*
* @return string
**/
public abstract function quote($value, $type);
/**
* Checks if the driver supports quoting
*
* @return boolean
**/
public function supportsQuoting() {
return true;
}
/**
* 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) {
return $this->_connection->lastInsertId($table);
}
}