Pdo.php
6.25 KB
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
<?php
namespace Phalcon\Db\Adapter {
/**
* Phalcon\Db\Adapter\Pdo
*
* Phalcon\Db\Adapter\Pdo is the Phalcon\Db that internally uses PDO to connect to a database
*
*<code>
* $connection = new Phalcon\Db\Adapter\Pdo\Mysql(array(
* 'host' => '192.168.0.11',
* 'username' => 'sigma',
* 'password' => 'secret',
* 'dbname' => 'blog',
* 'port' => '3306'
* ));
*</code>
*/
abstract class Pdo extends \Phalcon\Db\Adapter implements \Phalcon\Events\EventsAwareInterface {
protected $_pdo;
protected $_affectedRows;
protected $_transactionLevel;
/**
* Constructor for \Phalcon\Db\Adapter\Pdo
*
* @param array $descriptor
*/
public function __construct($descriptor){ }
/**
* This method is automatically called in \Phalcon\Db\Adapter\Pdo constructor.
* Call it when you need to restore a database connection
*
*<code>
* //Make a connection
* $connection = new \Phalcon\Db\Adapter\Pdo\Mysql(array(
* 'host' => '192.168.0.11',
* 'username' => 'sigma',
* 'password' => 'secret',
* 'dbname' => 'blog',
* ));
*
* //Reconnect
* $connection->connect();
* </code>
*
* @param array $descriptor
* @return boolean
*/
public function connect($descriptor=null){ }
/**
* Returns a PDO prepared statement to be executed with 'executePrepared'
*
*<code>
* $statement = $db->prepare('SELECT * FROM robots WHERE name = :name');
* $result = $connection->executePrepared($statement, array('name' => 'Voltron'));
*</code>
*
* @param string $sqlStatement
* @return \PDOStatement
*/
public function prepare($sqlStatement){ }
/**
* Executes a prepared statement binding. This function uses integer indexes starting from zero
*
*<code>
* $statement = $db->prepare('SELECT * FROM robots WHERE name = :name');
* $result = $connection->executePrepared($statement, array('name' => 'Voltron'));
*</code>
*
* @param \PDOStatement $statement
* @param array $placeholders
* @param array $dataTypes
* @return \PDOStatement
*/
public function executePrepared($statement, $placeholders, $dataTypes){ }
/**
* Sends SQL statements to the database server returning the success state.
* Use this method only when the SQL statement sent to the server is returning rows
*
*<code>
* //Querying data
* $resultset = $connection->query("SELECT * FROM robots WHERE type='mechanical'");
* $resultset = $connection->query("SELECT * FROM robots WHERE type=?", array("mechanical"));
*</code>
*
* @param string $sqlStatement
* @param array $bindParams
* @param array $bindTypes
* @return \Phalcon\Db\ResultInterface
*/
public function query($sqlStatement, $bindParams=null, $bindTypes=null){ }
/**
* Sends SQL statements to the database server returning the success state.
* Use this method only when the SQL statement sent to the server doesn't return any row
*
*<code>
* //Inserting data
* $success = $connection->execute("INSERT INTO robots VALUES (1, 'Astro Boy')");
* $success = $connection->execute("INSERT INTO robots VALUES (?, ?)", array(1, 'Astro Boy'));
*</code>
*
* @param string $sqlStatement
* @param array $bindParams
* @param array $bindTypes
* @return boolean
*/
public function execute($sqlStatement, $bindParams=null, $bindTypes=null){ }
/**
* Returns the number of affected rows by the lastest INSERT/UPDATE/DELETE executed in the database system
*
*<code>
* $connection->execute("DELETE FROM robots");
* echo $connection->affectedRows(), ' were deleted';
*</code>
*
* @return int
*/
public function affectedRows(){ }
/**
* Closes the active connection returning success. \Phalcon automatically closes and destroys
* active connections when the request ends
*
* @return boolean
*/
public function close(){ }
/**
* Escapes a column/table/schema name
*
*<code>
* $escapedTable = $connection->escapeIdentifier('robots');
* $escapedTable = $connection->escapeIdentifier(array('store', 'robots'));
*</code>
*
* @param string $identifier
* @return string
*/
public function escapeIdentifier($identifier){ }
/**
* Escapes a value to avoid SQL injections according to the active charset in the connection
*
*<code>
* $escapedStr = $connection->escapeString('some dangerous value');
*</code>
*
* @param string $str
* @return string
*/
public function escapeString($str){ }
/**
* Converts bound parameters such as :name: or ?1 into PDO bind params ?
*
*<code>
* print_r($connection->convertBoundParams('SELECT * FROM robots WHERE name = :name:', array('Bender')));
*</code>
*
* @param string $sql
* @param array $params
* @return array
*/
public function convertBoundParams($sql, $params){ }
/**
* Returns the insert id for the auto_increment/serial column inserted in the lastest executed SQL statement
*
*<code>
* //Inserting a new robot
* $success = $connection->insert(
* "robots",
* array("Astro Boy", 1952),
* array("name", "year")
* );
*
* //Getting the generated id
* $id = $connection->lastInsertId();
*</code>
*
* @param string $sequenceName
* @return int
*/
public function lastInsertId($sequenceName=null){ }
/**
* Starts a transaction in the connection
*
* @param boolean $nesting
* @return boolean
*/
public function begin($nesting=null){ }
/**
* Rollbacks the active transaction in the connection
*
* @param boolean $nesting
* @return boolean
*/
public function rollback($nesting=null){ }
/**
* Commits the active transaction in the connection
*
* @param boolean $nesting
* @return boolean
*/
public function commit($nesting=null){ }
/**
* Returns the current transaction nesting level
*
* @return int
*/
public function getTransactionLevel(){ }
/**
* Checks whether the connection is under a transaction
*
*<code>
* $connection->begin();
* var_dump($connection->isUnderTransaction()); //true
*</code>
*
* @return boolean
*/
public function isUnderTransaction(){ }
/**
* Return internal PDO handler
*
* @return \PDO
*/
public function getInternalHandler(){ }
}
}