/
StatementInterface.php
171 lines (157 loc) · 5.06 KB
/
StatementInterface.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
<?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;
/**
* Represents a database statement. Concrete implementations
* can either use PDOStatement or a native driver
*/
interface StatementInterface {
/**
* Assign a value to an positional or named variable in prepared query. If using
* positional variables you need to start with index one, if using named params then
* just use the name in any order.
*
* It is not allowed to combine positional and named variables in the same statement
*
* ## Examples:
*
* `$statement->bindValue(1, 'a title');`
* `$statement->bindValue('active', true, 'boolean');`
* `$statement->bindValue(5, new \DateTime(), 'date');`
*
* @param string|integer $column name or param position to be bound
* @param mixed $value the value to bind to variable in query
* @param string $type name of configured Type class
* @return void
*/
public function bindValue($column, $value, $type = 'string');
/**
* Closes a cursor in the database, freeing up any resources and memory
* allocated to it. In most cases you don't need to call this method, as it is
* automatically called after fetching all results from the result set.
*
* @return void
*/
public function closeCursor();
/**
* Returns the number of columns this statement's results will contain
*
* ## Example:
*
* {{{
* $statement = $connection->prepare('SELECT id, title from articles');
* $statement->execute();
* echo $statement->columnCount(); // outputs 2
* }}}
*
* @return integer
*/
public function columnCount();
/**
* Returns the error code for the last error that occurred when executing this statement
*
* @return integer|string
*/
public function errorCode();
/**
* Returns the error information for the last error that occurred when executing
* this statement
*
* @return array
*/
public function errorInfo();
/**
* Executes the statement by sending the SQL query to the database. It can optionally
* take an array or arguments to be bound to the query variables. Please note
* that binding parameters from this method will not perform any custom type conversion
* as it would normally happen when calling `bindValue`
*
* $param array $params list of values to be bound to query
* @return boolean true on success, false otherwise
*/
public function execute($params = null);
/**
* Returns the next row for the result set after executing this statement.
* Rows can be fetched to contain columns as names or positions. If no
* rows are left in result set, this method will return false
*
* ## Example:
*
* {{{
* $statement = $connection->prepare('SELECT id, title from articles');
* $statement->execute();
* print_r($statement->fetch('assoc')); // will show array('id' => 1, 'title' => 'a title')
* }}}
*
* @param string $type 'num' for positional columns, assoc for named columns
* @return mixed|boolean result array containing columns and values or false if no results
* are left
*/
public function fetch($type = 'num');
/**
* Returns an array with all rows resulting from executing this statement
*
* ## Example:
*
* {{{
* $statement = $connection->prepare('SELECT id, title from articles');
* $statement->execute();
* print_r($statement->fetchAll('assoc')); // will show [0 => ['id' => 1, 'title' => 'a title']]
* }}}
*
* @param string $type num for fetching columns as positional keys or assoc for column names as keys
* @return array list of all results from database for this statement
*/
public function fetchAll($type = 'num');
/**
* Returns the number of rows affected by this SQL statement
*
* ## Example:
*
* {{{
* $statement = $connection->prepare('SELECT id, title from articles');
* $statement->execute();
* print_r($statement->rowCount()); // will show 1
* }}}
*
* @return integer
*/
public function rowCount();
/**
* Statements can be passed as argument for count()
* to return the number for affected rows from last execution
*
* @return integer
*/
public function count();
/**
* Binds a set of values to statement object with corresponding type
*
* @param array $params list of values to be bound
* @param array $types list of types to be used, keys should match those in $params
* @return void
*/
public function bind($params, $types);
/**
* Returns the latest primary inserted using this statement
*
* @param string $table table name or sequence to get last insert value from
* @param string column the name of the column representing the primary key
* @return string
*/
public function lastInsertId($table = null, $column = null);
}