Packages

Source for file DibiDataSource.php

Documentation is available at DibiDataSource.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: * Default implementation of IDataSource for dibi.
17: *
18: * @copyright Copyright (c) 2005, 2010 David Grudl
19: * @package dibi
20: *
21: * @property-read DibiConnection $connection
22: * @property-read DibiResult $result
23: * @property-read DibiResultIterator $iterator
24: * @property-read int $totalCount
25: */
26: class DibiDataSource extends DibiObject implements IDataSource
27: {
28: /** @var DibiConnection */
29: private $connection;
30:
31: /** @var string */
32: private $sql;
33:
34: /** @var DibiResult */
35: private $result;
36:
37: /** @var int */
38: private $count;
39:
40: /** @var int */
41: private $totalCount;
42:
43: /** @var array */
44: private $cols = array();
45:
46: /** @var array */
47: private $sorting = array();
48:
49: /** @var array */
50: private $conds = array();
51:
52: /** @var int */
53: private $offset;
54:
55: /** @var int */
56: private $limit;
57:
58:
59:
60: /**
61: * @param string SQL command or table or view name, as data source
62: * @param DibiConnection connection
63: */
64: public function __construct($sql, DibiConnection $connection)
65: {
66: if (strpbrk($sql, " \t\r\n") === FALSE) {
67: $this->sql = $connection->getDriver()->escape($sql, dibi::IDENTIFIER); // table name
68: } else {
69: $this->sql = '(' . $sql . ') t'; // SQL command
70: }
71: $this->connection = $connection;
72: }
73:
74:
75:
76: /**
77: * Selects columns to query.
78: * @param string|array column name or array of column names
79: * @param string column alias
80: * @return DibiDataSource provides a fluent interface
81: */
82: public function select($col, $as = NULL)
83: {
84: if (is_array($col)) {
85: $this->cols = $col;
86: } else {
87: $this->cols[$col] = $as;
88: }
89: $this->result = NULL;
90: return $this;
91: }
92:
93:
94:
95: /**
96: * Adds conditions to query.
97: * @param mixed conditions
98: * @return DibiDataSource provides a fluent interface
99: */
100: public function where($cond)
101: {
102: if (is_array($cond)) {
103: // TODO: not consistent with select and orderBy
104: $this->conds[] = $cond;
105: } else {
106: $this->conds[] = func_get_args();
107: }
108: $this->result = $this->count = NULL;
109: return $this;
110: }
111:
112:
113:
114: /**
115: * Selects columns to order by.
116: * @param string|array column name or array of column names
117: * @param string sorting direction
118: * @return DibiDataSource provides a fluent interface
119: */
120: public function orderBy($row, $sorting = 'ASC')
121: {
122: if (is_array($row)) {
123: $this->sorting = $row;
124: } else {
125: $this->sorting[$row] = $sorting;
126: }
127: $this->result = NULL;
128: return $this;
129: }
130:
131:
132:
133: /**
134: * Limits number of rows.
135: * @param int limit
136: * @param int offset
137: * @return DibiDataSource provides a fluent interface
138: */
139: public function applyLimit($limit, $offset = NULL)
140: {
141: $this->limit = $limit;
142: $this->offset = $offset;
143: $this->result = $this->count = NULL;
144: return $this;
145: }
146:
147:
148:
149: /**
150: * Returns the dibi connection.
151: * @return DibiConnection
152: */
153: final public function getConnection()
154: {
155: return $this->connection;
156: }
157:
158:
159:
160: /********************* executing ****************d*g**/
161:
162:
163:
164: /**
165: * Returns (and queries) DibiResult.
166: * @return DibiResult
167: */
168: public function getResult()
169: {
170: if ($this->result === NULL) {
171: $this->result = $this->connection->nativeQuery($this->__toString());
172: }
173: return $this->result;
174: }
175:
176:
177:
178: /**
179: * @return DibiResultIterator
180: */
181: public function getIterator()
182: {
183: return $this->getResult()->getIterator();
184: }
185:
186:
187:
188: /**
189: * Generates, executes SQL query and fetches the single row.
190: * @return DibiRow|FALSE array on success, FALSE if no next record
191: */
192: public function fetch()
193: {
194: return $this->getResult()->fetch();
195: }
196:
197:
198:
199: /**
200: * Like fetch(), but returns only first field.
201: * @return mixed value on success, FALSE if no next record
202: */
203: public function fetchSingle()
204: {
205: return $this->getResult()->fetchSingle();
206: }
207:
208:
209:
210: /**
211: * Fetches all records from table.
212: * @return array
213: */
214: public function fetchAll()
215: {
216: return $this->getResult()->fetchAll();
217: }
218:
219:
220:
221: /**
222: * Fetches all records from table and returns associative tree.
223: * @param string associative descriptor
224: * @return array
225: */
226: public function fetchAssoc($assoc)
227: {
228: return $this->getResult()->fetchAssoc($assoc);
229: }
230:
231:
232:
233: /**
234: * Fetches all records from table like $key => $value pairs.
235: * @param string associative key
236: * @param string value
237: * @return array
238: */
239: public function fetchPairs($key = NULL, $value = NULL)
240: {
241: return $this->getResult()->fetchPairs($key, $value);
242: }
243:
244:
245:
246: /**
247: * Discards the internal cache.
248: * @return void
249: */
250: public function release()
251: {
252: $this->result = $this->count = $this->totalCount = NULL;
253: }
254:
255:
256:
257: /********************* exporting ****************d*g**/
258:
259:
260:
261: /**
262: * Returns this data source wrapped in DibiFluent object.
263: * @return DibiFluent
264: */
265: public function toFluent()
266: {
267: return $this->connection->select('*')->from('(%SQL) AS t', $this->__toString());
268: }
269:
270:
271:
272: /**
273: * Returns this data source wrapped in DibiDataSource object.
274: * @return DibiDataSource
275: */
276: public function toDataSource()
277: {
278: return new self($this->__toString(), $this->connection);
279: }
280:
281:
282:
283: /**
284: * Returns SQL query.
285: * @return string
286: */
287: public function __toString()
288: {
289: return $this->connection->translate('
290: SELECT %n', (empty($this->cols) ? '*' : $this->cols), '
291: FROM %SQL', $this->sql, '
292: %ex', $this->conds ? array('WHERE %and', $this->conds) : NULL, '
293: %ex', $this->sorting ? array('ORDER BY %by', $this->sorting) : NULL, '
294: %ofs %lmt', $this->offset, $this->limit
295: );
296: }
297:
298:
299:
300: /********************* counting ****************d*g**/
301:
302:
303:
304: /**
305: * Returns the number of rows in a given data source.
306: * @return int
307: */
308: public function count()
309: {
310: if ($this->count === NULL) {
311: $this->count = $this->conds || $this->offset || $this->limit
312: ? (int) $this->connection->nativeQuery(
313: 'SELECT COUNT(*) FROM (' . $this->__toString() . ') AS t'
314: )->fetchSingle()
315: : $this->getTotalCount();
316: }
317: return $this->count;
318: }
319:
320:
321:
322: /**
323: * Returns the number of rows in a given data source.
324: * @return int
325: */
326: public function getTotalCount()
327: {
328: if ($this->totalCount === NULL) {
329: $this->totalCount = (int) $this->connection->nativeQuery(
330: 'SELECT COUNT(*) FROM ' . $this->sql
331: )->fetchSingle();
332: }
333: return $this->totalCount;
334: }
335:
336: }

dibi API documentation

Packages

Source for file DibiDataSource.php