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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
|
<?php
/**
*
* This file is part of Aura for PHP.
*
* @license http://opensource.org/licenses/bsd-license.php BSD
*
*/
namespace Aura\Sql;
/**
*
* An interface to the Aura.Sql extended PDO object.
*
* @package Aura.Sql
*
* @method Iterator\AllIterator yieldAll(string $statment, array $values = array()) Yields rows from the database keyed on the first column of each row.
* @method Iterator\AssocIterator yieldAssoc(string $statment, array $values = array()) Yields rows from the database keyed on the first column of each row.
* @method Iterator\ColIterator yieldCol(string $statment, array $values = array()) Yields the first column of each row.
* @method Iterator\ObjectsIterator yieldObjects(string $statment, array $values = array(), $class_name = 'stdClass', array $ctor_args = array()) Yields objects where the column values are mapped to object properties.
* @method Iterator\PairsIterator yieldPairs(string $statment, array $values = array()) Yields key-value pairs (first column is the key, second column is the value).
*/
interface ExtendedPdoInterface extends PdoInterface
{
/**
*
* Connects to the database and sets PDO attributes.
*
* @return null
*
* @throws \PDOException if the connection fails.
*
*/
public function connect();
/**
*
* Performs a statement and returns the number of affected rows.
*
* @param string $statement The SQL statement to prepare and execute.
*
* @param array $values Values to bind to the query.
*
* @return array
*
*/
public function fetchAffected($statement, array $values = array());
/**
*
* Fetches a sequential array of rows from the database; the rows
* are represented as associative arrays.
*
* @param string $statement The SQL statement to prepare and execute.
*
* @param array $values Values to bind to the query.
*
* @param callable $callable A callable to be applied to each of the rows
* to be returned.
*
* @return array
*
*/
public function fetchAll($statement, array $values = array(), $callable = null);
/**
*
* Fetches an associative array of rows from the database; the rows
* are represented as associative arrays. The array of rows is keyed
* on the first column of each row.
*
* N.b.: if multiple rows have the same first column value, the last
* row with that value will override earlier rows.
*
* @param string $statement The SQL statement to prepare and execute.
*
* @param array $values Values to bind to the query.
*
* @param callable $callable A callable to be applied to each of the rows
* to be returned.
*
* @return array
*
*/
public function fetchAssoc($statement, array $values = array(), $callable = null);
/**
*
* Fetches the first column of rows as a sequential array.
*
* @param string $statement The SQL statement to prepare and execute.
*
* @param array $values Values to bind to the query.
*
* @param callable $callable A callable to be applied to each of the rows
* to be returned.
*
* @return array
*
*/
public function fetchCol($statement, array $values = array(), $callable = null);
/**
*
* Fetches one row from the database as an object, mapping column values
* to object properties.
*
* Warning: PDO "injects property-values BEFORE invoking the constructor -
* in other words, if your class initializes property-values to defaults
* in the constructor, you will be overwriting the values injected by
* fetchObject() !"
* <http://www.php.net/manual/en/pdostatement.fetchobject.php#111744>
*
* @param string $statement The SQL statement to prepare and execute.
*
* @param array $values Values to bind to the query.
*
* @param string $class_name The name of the class to create.
*
* @param array $ctor_args Arguments to pass to the object constructor.
*
* @return object|false
*
*/
public function fetchObject(
$statement,
array $values = array(),
$class_name = 'StdClass',
array $ctor_args = array()
);
/**
*
* Fetches a sequential array of rows from the database; the rows
* are represented as objects, where the column values are mapped to
* object properties.
*
* Warning: PDO "injects property-values BEFORE invoking the constructor -
* in other words, if your class initializes property-values to defaults
* in the constructor, you will be overwriting the values injected by
* fetchObject() !"
* <http://www.php.net/manual/en/pdostatement.fetchobject.php#111744>
*
* @param string $statement The SQL statement to prepare and execute.
*
* @param array $values Values to bind to the query.
*
* @param string $class_name The name of the class to create from each
* row.
*
* @param array $ctor_args Arguments to pass to each object constructor.
*
* @return array
*
*/
public function fetchObjects(
$statement,
array $values = array(),
$class_name = 'StdClass',
array $ctor_args = array()
);
/**
*
* Fetches one row from the database as an associative array.
*
* @param string $statement The SQL statement to prepare and execute.
*
* @param array $values Values to bind to the query.
*
* @return array|false
*
*/
public function fetchOne($statement, array $values = array());
/**
*
* Fetches an associative array of rows as key-value pairs (first
* column is the key, second column is the value).
*
* @param string $statement The SQL statement to prepare and execute.
*
* @param array $values Values to bind to the query.
*
* @param callable $callable A callable to be applied to each of the rows
* to be returned.
*
* @return array
*
*/
public function fetchPairs($statement, array $values = array(), $callable = null);
/**
*
* Fetches the very first value (i.e., first column of the first row).
*
* @param string $statement The SQL statement to prepare and execute.
*
* @param array $values Values to bind to the query.
*
* @return mixed
*
*/
public function fetchValue($statement, array $values = array());
/**
*
* Returns the DSN for a lazy connection; if the underlying PDO instance
* was injected at construction time, this will be null.
*
* @return string|null
*
*/
public function getDsn();
/**
*
* Returns the underlying PDO connection object.
*
* @return PDO or Null if connection was manually disconnected
*
*/
public function getPdo();
/**
*
* Returns the profiler object.
*
* @return ProfilerInterface
*
*/
public function getProfiler();
/**
*
* Is the instance connected to a database?
*
* @return bool
*
*/
public function isConnected();
/**
*
* Performs a query after preparing the statement with bound values, then
* returns the result as a PDOStatement.
*
* @param string $statement The SQL statement to prepare and execute.
*
* @param array $values Values to bind to the query.
*
* @return \PDOStatement
*
*/
public function perform($statement, array $values = array());
/**
*
* Sets the profiler object.
*
* @param ProfilerInterface $profiler
*
* @return null
*
*/
public function setProfiler(ProfilerInterface $profiler);
}
|