forked from propelorm/Propel2
-
Notifications
You must be signed in to change notification settings - Fork 0
/
AdapterInterface.php
300 lines (268 loc) · 9.52 KB
/
AdapterInterface.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
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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
<?php
/**
* This file is part of the Propel package.
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @license MIT License
*/
namespace Propel\Runtime\Adapter;
use Propel\Runtime\Exception\PropelException;
use Propel\Runtime\Connection\ConnectionInterface;
use Propel\Runtime\Connection\StatementInterface;
use Propel\Runtime\Map\ColumnMap;
use Propel\Runtime\Map\DatabaseMap;
use Propel\Runtime\Query\Criteria;
/**
* Interface for adapters.
*
*/
interface AdapterInterface
{
const ID_METHOD_NONE = 0;
const ID_METHOD_AUTOINCREMENT = 1;
const ID_METHOD_SEQUENCE = 2;
/**
* Build database connection
*
* @param array $conparams connection parameters
*
* @return Propel\Runtime\Connection\ConnectionInterface
*/
function getConnection($conparams);
/**
* Sets the character encoding using SQL standard SET NAMES statement.
*
* This method is invoked from the default initConnection() method and must
* be overridden for an RDMBS which does _not_ support this SQL standard.
*
* @see initConnection()
*
* @param Propel\Runtime\Connection\ConnectionInterface $con
* @param string $charset The $string charset encoding.
*/
function setCharset(ConnectionInterface $con, $charset);
/**
* This method is used to ignore case.
*
* @param string $in The string to transform to upper case.
* @return string The upper case string.
*/
function toUpperCase($in);
/**
* This method is used to ignore case.
*
* @param string $in The string whose case to ignore.
* @return string The string in a case that can be ignored.
*/
function ignoreCase($in);
/**
* This method is used to ignore case in an ORDER BY clause.
* Usually it is the same as ignoreCase, but some databases
* (Interbase for example) does not use the same SQL in ORDER BY
* and other clauses.
*
* @param string $in The string whose case to ignore.
* @return string The string in a case that can be ignored.
*/
function ignoreCaseInOrderBy($in);
/**
* Returns the character used to indicate the beginning and end of
* a piece of text used in a SQL statement (generally a single
* quote).
*
* @return string The text delimeter.
*/
function getStringDelimiter();
/**
* Returns SQL which concatenates the second string to the first.
*
* @param string $s1 String to concatenate.
* @param string $s2 String to append.
*
* @return string
*/
function concatString($s1, $s2);
/**
* Returns SQL which extracts a substring.
*
* @param string $s String to extract from.
* @param integer $pos Offset to start from.
* @param integer $len Number of characters to extract.
*
* @return string
*/
function subString($s, $pos, $len);
/**
* Returns SQL which calculates the length (in chars) of a string.
*
* @param string $s String to calculate length of.
* @return string
*/
function strLength($s);
/**
* Quotes database objec identifiers (table names, col names, sequences, etc.).
* @param string $text The identifier to quote.
* @return string The quoted identifier.
*/
function quoteIdentifier($text);
/**
* Quotes a database table which could have space seperating it from an alias,
* both should be identified separately. This doesn't take care of dots which
* separate schema names from table names. Adapters for RDBMs which support
* schemas have to implement that in the platform-specific way.
*
* @param string $table The table name to quo
* @return string The quoted table name
**/
function quoteIdentifierTable($table);
/**
* Whether this adapter uses an ID generation system that requires getting ID _before_ performing INSERT.
*
* @return boolean
*/
function isGetIdBeforeInsert();
/**
* Whether this adapter uses an ID generation system that requires getting ID _before_ performing INSERT.
*
* @return boolean
*/
function isGetIdAfterInsert();
/**
* Gets the generated ID (either last ID for autoincrement or next sequence ID).
*
* @param Propel\Runtime\Connection\ConnectionInterface $con
* @param string $name
*
* @return mixed
*/
function getId(ConnectionInterface $con, $name = null);
/**
* Formats a temporal value before binding, given a ColumnMap object
*
* @param mixed $value The temporal value
* @param Propel\Runtime\Map\ColumnMap $cMap
*
* @return string The formatted temporal value
*/
function formatTemporalValue($value, ColumnMap $cMap);
/**
* Returns timestamp formatter string for use in date() function.
*
* @return string
*/
function getTimestampFormatter();
/**
* Returns date formatter string for use in date() function.
*
* @return string
*/
function getDateFormatter();
/**
* Returns time formatter string for use in date() function.
*
* @return string
*/
function getTimeFormatter();
/**
* Should Column-Names get identifiers for inserts or updates.
* By default false is returned -> backwards compability.
*
* it`s a workaround...!!!
*
* @todo should be abstract
* @deprecated
*
* @return boolean
*/
function useQuoteIdentifier();
/**
* Allows manipulation of the query string before StatementPdo is instantiated.
*
* @param string $sql The sql statement
* @param array $params array('column' => ..., 'table' => ..., 'value' => ...)
* @param Propel\Runtime\Map\Criteria $values
* @param Propel\Runtime\Map\DatabaseMap $dbMap
*/
function cleanupSQL(&$sql, array &$params, Criteria $values, DatabaseMap $dbMap);
/**
* Modifies the passed-in SQL to add LIMIT and/or OFFSET.
*
* @param string $sql
* @param integer $offset
* @param integer $limit
*/
function applyLimit(&$sql, $offset, $limit);
/**
* Gets the SQL string that this adapter uses for getting a random number.
*
* @param mixed $seed (optional) seed value for databases that support this
*/
function random($seed = null);
/**
* Returns the "DELETE FROM <table> [AS <alias>]" part of DELETE query.
*
* @param Propel\Runtime\Map\Criteria $criteria
* @param string $tableName
*
* @return string
*/
function getDeleteFromClause(Criteria $criteria, $tableName);
/**
* Builds the SELECT part of a SQL statement based on a Criteria
* taking into account select columns and 'as' columns (i.e. columns aliases)
* Move from BasePeer to AbstractAdapter and turn from static to non static
*
* @param Propel\Runtime\Map\Criteria $criteria
* @param array $fromClause
* @param boolean $aliasAll
*
* @return string
*/
function createSelectSqlPart(Criteria $criteria, &$fromClause, $aliasAll = false);
/**
* Ensures uniqueness of select column names by turning them all into aliases
* This is necessary for queries on more than one table when the tables share a column name
* Moved from BasePeer to AbstractAdapter and turned from static to non static
*
* @see http://propel.phpdb.org/trac/ticket/795
*
* @param Propel\Runtime\Map\Criteria $criteria
* @return Propel\Runtime\Map\Criteria The input, with Select columns replaced by aliases
*/
function turnSelectColumnsToAliases(Criteria $criteria);
/**
* Binds values in a prepared statement.
*
* This method is designed to work with the BasePeer::createSelectSql() method, which creates
* both the SELECT SQL statement and populates a passed-in array of parameter
* values that should be substituted.
*
* <code>
* $db = Propel::getDB($criteria->getDbName());
* $sql = BasePeer::createSelectSql($criteria, $params);
* $stmt = $con->prepare($sql);
* $params = array();
* $db->populateStmtValues($stmt, $params, Propel::getDatabaseMap($critera->getDbName()));
* $stmt->execute();
* </code>
*
* @param Propel\Runtime\Connection\StatementInterface $stmt
* @param array $params array('column' => ..., 'table' => ..., 'value' => ...)
* @param Propel\Runtime\Map\DatabaseMap $dbMap
*/
function bindValues(StatementInterface $stmt, array $params, DatabaseMap $dbMap);
/**
* Binds a value to a positioned parameted in a statement,
* given a ColumnMap object to infer the binding type.
*
* @param Propel\Runtime\Connection\StatementInterface $stmt The statement to bind
* @param string $parameter Parameter identifier
* @param mixed $value The value to bind
* @param Propel\Runtime\Map\ColumnMap $cMap The ColumnMap of the column to bind
* @param null|integer $position The position of the parameter to bind
*
* @return boolean
*/
function bindValue(StatementInterface $stmt, $parameter, $value, ColumnMap $cMap, $position = null);
}