Packages

Source for file interfaces.php

Documentation is available at interfaces.php

1: <?php
2:
3: /**
4: * dibi - tiny'n'smart database abstraction layer
5: * ----------------------------------------------
6: *
7: * @copyright Copyright (c) 2005, 2010 David Grudl
8: * @license http://dibiphp.com/license dibi license
9: * @link http://dibiphp.com
10: * @package dibi
11: */
12:
13:
14:
15: /**
16: * Provides an interface between a dataset and data-aware components.
17: * @package dibi
18: */
19: interface IDataSource extends Countable, IteratorAggregate
20: {
21: //function IteratorAggregate::getIterator();
22: //function Countable::count();
23: }
24:
25:
26:
27:
28:
29: /**
30: * Defines method that must profiler implement.
31: * @package dibi
32: */
33: interface IDibiProfiler
34: {
35: /**#@+ event type */
36: const CONNECT = 1;
37: const SELECT = 4;
38: const INSERT = 8;
39: const DELETE = 16;
40: const UPDATE = 32;
41: const QUERY = 60; // SELECT | INSERT | DELETE | UPDATE
42: const BEGIN = 64;
43: const COMMIT = 128;
44: const ROLLBACK = 256;
45: const TRANSACTION = 448; // BEGIN | COMMIT | ROLLBACK
46: const EXCEPTION = 512;
47: const ALL = 1023;
48: /**#@-*/
49:
50: /**
51: * Before event notification.
52: * @param DibiConnection
53: * @param int event name
54: * @param string sql
55: * @return int
56: */
57: function before(DibiConnection $connection, $event, $sql = NULL);
58:
59: /**
60: * After event notification.
61: * @param int
62: * @param DibiResult
63: * @return void
64: */
65: function after($ticket, $result = NULL);
66:
67: /**
68: * After exception notification.
69: * @param DibiDriverException
70: * @return void
71: */
72: function exception(DibiDriverException $exception);
73:
74: }
75:
76:
77:
78:
79:
80: /**
81: * dibi driver interface.
82: *
83: * @copyright Copyright (c) 2005, 2010 David Grudl
84: * @package dibi
85: */
86: interface IDibiDriver
87: {
88:
89: /**
90: * Connects to a database.
91: * @param array
92: * @return void
93: * @throws DibiException
94: */
95: function connect(array &$config);
96:
97: /**
89: /**
90: * Disconnects from a database.
91: * @return void
92: * @throws DibiException
101: */
102: function disconnect();
103:
104: /**
105: * Internal: Executes the SQL query.
106: * @param string SQL statement.
107: * @return IDibiResultDriver|NULL
108: * @throws DibiDriverException
109: */
110: function query($sql);
111:
112: /**
113: * Gets the number of affected rows by the last INSERT, UPDATE or DELETE query.
114: * @return int|FALSE number of rows or FALSE on error
115: */
116: function getAffectedRows();
117:
118: /**
119: * Retrieves the ID generated for an AUTO_INCREMENT column by the previous INSERT query.
120: * @return int|FALSE int on success or FALSE on failure
121: */
122: function getInsertId($sequence);
123:
124: /**
125: * Begins a transaction (if supported).
126: * @param string optional savepoint name
127: * @return void
128: * @throws DibiDriverException
129: */
130: function begin($savepoint = NULL);
131:
132: /**
133: * Commits statements in a transaction.
134: * @param string optional savepoint name
135: * @return void
136: * @throws DibiDriverException
137: */
138: function commit($savepoint = NULL);
139:
140: /**
141: * Rollback changes in a transaction.
142: * @param string optional savepoint name
143: * @return void
144: * @throws DibiDriverException
145: */
146: function rollback($savepoint = NULL);
147:
148: /**
149: * Returns the connection resource.
150: * @return mixed
151: */
152: function getResource();
153:
154: /**
155: * Returns the connection reflector.
156: * @return IDibiReflector
157: */
158: function getReflector();
159:
160: /**
161: * Encodes data for use in a SQL statement.
162: * @param string value
163: * @param string type (dibi::TEXT, dibi::BOOL, ...)
164: * @return string encoded value
165: * @throws InvalidArgumentException
166: */
167: function escape($value, $type);
168:
169: /**
170: * Encodes string for use in a LIKE statement.
171: * @param string
172: * @param int
173: * @return string
174: */
175: function escapeLike($value, $pos);
176:
177: /**
178: * Injects LIMIT/OFFSET to the SQL query.
179: * @param string &$sql The SQL query that will be modified.
180: * @param int $limit
181: * @param int $offset
182: * @return void
183: */
184: function applyLimit(&$sql, $limit, $offset);
185:
186: }
187:
188:
189:
190:
191:
192: /**
193: * dibi result set driver interface.
194: *
195: * @copyright Copyright (c) 2005, 2010 David Grudl
196: * @package dibi
197: */
198: interface IDibiResultDriver
199: {
200:
201: /**
202: * Returns the number of rows in a result set.
203: * @return int
204: */
205: function getRowCount();
206:
207: /**
208: * Moves cursor position without fetching row.
209: * @param int the 0-based cursor pos to seek to
210: * @return boolean TRUE on success, FALSE if unable to seek to specified record
211: * @throws DibiException
212: */
213: function seek($row);
214:
215: /**
216: * Fetches the row at current position and moves the internal cursor to the next position.
217: * @param bool TRUE for associative array, FALSE for numeric
218: * @return array array on success, nonarray if no next record
219: * @ignore internal
220: */
221: function fetch($type);
222:
223: /**
224: * Frees the resources allocated for this result set.
225: * @param resource result set resource
226: * @return void
227: */
228: function free();
229:
230: /**
231: * Returns metadata for all columns in a result set.
232: * @return array of {name, nativetype [, table, fullname, (int) size, (bool) nullable, (mixed) default, (bool) autoincrement, (array) vendor ]}
233: */
234: function getResultColumns();
235:
236: /**
237: * Returns the result set resource.
238: * @return mixed
239: */
240: function getResultResource();
241:
242: /**
243: * Decodes data from result set.
244: * @param string value
245: * @param string type (dibi::BINARY)
246: * @return string decoded value
247: * @throws InvalidArgumentException
248: */
249: function unescape($value, $type);
250:
251: }
252:
253:
254:
255:
256:
257: /**
258: * dibi driver reflection.
259: *
260: * @copyright Copyright (c) 2005, 2010 David Grudl
261: * @package dibi
262: */
263: interface IDibiReflector
264: {
265:
266: /**
267: * Returns list of tables.
268: * @return array of {name [, (bool) view ]}
269: */
270: function getTables();
271:
272: /**
273: * Returns metadata for all columns in a table.
274: * @param string
275: * @return array of {name, nativetype [, table, fullname, (int) size, (bool) nullable, (mixed) default, (bool) autoincrement, (array) vendor ]}
276: */
277: function getColumns($table);
278:
279: /**
280: * Returns metadata for all indexes in a table.
281: * @param string
282: * @return array of {name, (array of names) columns [, (bool) unique, (bool) primary ]}
283: */
284: function getIndexes($table);
285:
286: /**
287: * Returns metadata for all foreign keys in a table.
288: * @param string
289: * @return array
290: */
291: function getForeignKeys($table);
292:
293: }

dibi API documentation

Packages

Source for file interfaces.php