Packages

Source for file dibi.php

Documentation is available at dibi.php

1: <?php
2:
3: /**
4: * dibi - tiny'n'smart database abstraction layer
5: * ----------------------------------------------
6: *
7: * Copyright (c) 2005, 2010 David Grudl (http://davidgrudl.com)
8: *
9: * This source file is subject to the "dibi license" that is bundled
10: * with this package in the file license.txt, and/or GPL license.
11: *
12: * For more information please see http://dibiphp.com
13: *
14: * @copyright Copyright (c) 2005, 2010 David Grudl
15: * @license http://dibiphp.com/license dibi license
16: * @link http://dibiphp.com
17: * @package dibi
18: */
19:
20:
21: /**
22: * Check PHP configuration.
23: */
24: if (version_compare(PHP_VERSION, '5.2.0', '<')) {
25: throw new Exception('dibi needs PHP 5.2.0 or newer.');
26: }
27:
28: @set_magic_quotes_runtime(FALSE); // intentionally @
29:
30:
31:
32: /**
33: * Compatibility with Nette
34: */
35: if (interface_exists('Nette\\IDebugPanel', FALSE)) {
36: class_alias('Nette\\IDebugPanel', 'IDebugPanel');
37:
38: } elseif (!interface_exists('IDebugPanel', FALSE)) {
39: interface IDebugPanel {}
40: }
41:
42: if (!defined('NETTE')) {
43: /**#@+ @package exceptions */
44: class NotImplementedException extends LogicException {}
45: class NotSupportedException extends LogicException {}
46: class MemberAccessException extends LogicException {}
47: class InvalidStateException extends RuntimeException {}
48: class IOException extends RuntimeException {}
49: class FileNotFoundException extends IOException {}
50: /**#@-*/
51:
52: require_once dirname(__FILE__) . '/Nette/DateTime53.php';
53: }
54:
55:
56: /** @package exceptions */
57: class PcreException extends Exception {
58:
59: public function __construct($message = '%msg.')
60: {
61: static $messages = array(
62: PREG_INTERNAL_ERROR => 'Internal error',
63: PREG_BACKTRACK_LIMIT_ERROR => 'Backtrack limit was exhausted',
64: PREG_RECURSION_LIMIT_ERROR => 'Recursion limit was exhausted',
65: PREG_BAD_UTF8_ERROR => 'Malformed UTF-8 data',
66: 5 => 'Offset didn\'t correspond to the begin of a valid UTF-8 code point', // PREG_BAD_UTF8_OFFSET_ERROR
67: );
68: $code = preg_last_error();
69: parent::__construct(str_replace('%msg', isset($messages[$code]) ? $messages[$code] : 'Unknown error', $message), $code);
70: }
71: }
72:
73:
74:
75: /**
76: * @deprecated
77: */
78: class DibiVariable extends DateTime53
79: {
80: function __construct($val)
81: {
82: parent::__construct($val);
83: }
84: }
85:
86:
87:
88: // dibi libraries
89: require_once dirname(__FILE__) . '/libs/interfaces.php';
90: require_once dirname(__FILE__) . '/libs/DibiObject.php';
91: require_once dirname(__FILE__) . '/libs/DibiLazyStorage.php';
92: require_once dirname(__FILE__) . '/libs/DibiException.php';
93: require_once dirname(__FILE__) . '/libs/DibiConnection.php';
94: require_once dirname(__FILE__) . '/libs/DibiResult.php';
95: require_once dirname(__FILE__) . '/libs/DibiResultIterator.php';
96: require_once dirname(__FILE__) . '/libs/DibiRow.php';
97: require_once dirname(__FILE__) . '/libs/DibiTranslator.php';
98: require_once dirname(__FILE__) . '/libs/DibiDataSource.php';
99: require_once dirname(__FILE__) . '/libs/DibiFluent.php';
100: require_once dirname(__FILE__) . '/libs/DibiDatabaseInfo.php';
101: require_once dirname(__FILE__) . '/libs/DibiProfiler.php';
102:
103:
104:
105:
106:
107: /**
108: * Interface for database drivers.
109: *
110: * This class is static container class for creating DB objects and
111: * store connections info.
112: *
113: * @copyright Copyright (c) 2005, 2010 David Grudl
114: * @package dibi
115: */
116: class dibi
117: {
118: /**#@+
119: * dibi data type
120: */
121: const TEXT = 's'; // as 'string'
122: const BINARY = 'bin';
123: const BOOL = 'b';
124: const INTEGER = 'i';
125: const FLOAT = 'f';
126: const DATE = 'd';
127: const DATETIME = 't';
128: const TIME = 't';
129: const IDENTIFIER = 'n';
130: /**#@-*/
131:
132: /**#@+
133: * @deprecated column types
134: */
135: const FIELD_TEXT = self::TEXT;
136: const FIELD_BINARY = self::BINARY;
137: const FIELD_BOOL = self::BOOL;
138: const FIELD_INTEGER = self::INTEGER;
139: const FIELD_FLOAT = self::FLOAT;
140: const FIELD_DATE = self::DATE;
141: const FIELD_DATETIME = self::DATETIME;
142: const FIELD_TIME = self::TIME;
143: /**#@-*/
144:
145: /**#@+
146: * dibi version
147: */
148: const VERSION = '1.3-dev';
149: const REVISION = 'b1156e5 released on 2010-08-27';
150: /**#@-*/
151:
152: const ASC = 'ASC', DESC = 'DESC';
153:
154: /** @var DibiConnection[] Connection registry storage for DibiConnection objects */
155: private static $registry = array();
156:
157: /** @var DibiConnection Current connection */
158: private static $connection;
159:
160: /** @var DibiLazyStorage Substitutions for identifiers */
161: public static $substs;
162:
163: /** @var array @see addHandler */
164: private static $handlers = array();
165:
166: /** @var string Last SQL command @see dibi::query() */
167: public static $sql;
168:
169: /** @var int Elapsed time for last query */
170: public static $elapsedTime;
171:
172: /** @var int Elapsed time for all queries */
173: public static $totalTime;
174:
175: /** @var int Number or queries */
176: public static $numOfQueries = 0;
177:
178: /** @var string Default dibi driver */
179: public static $defaultDriver = 'mysql';
180:
181:
182:
183: /**
184: * Static class - cannot be instantiated.
185: */
186: final public function __construct()
187: {
188: throw new LogicException("Cannot instantiate static class " . get_class($this));
189: }
190:
191:
192:
193: /********************* connections handling ****************d*g**/
194:
195:
196:
197: /**
198: * Creates a new DibiConnection object and connects it to specified database.
199: * @param mixed connection parameters
200: * @param string connection name
201: * @return DibiConnection
202: * @throws DibiException
203: */
204: public static function connect($config = array(), $name = 0)
205: {
206: return self::$connection = self::$registry[$name] = new DibiConnection($config, $name);
207: }
208:
209:
210:
211: /**
212: * Disconnects from database (doesn't destroy DibiConnection object).
213: * @return void
214: */
215: public static function disconnect()
216: {
217: self::getConnection()->disconnect();
218: }
219:
220:
221:
222: /**
223: * Returns TRUE when connection was established.
224: * @return bool
225: */
226: public static function isConnected()
227: {
228: return (self::$connection !== NULL) && self::$connection->isConnected();
229: }
230:
231:
232:
233: /**
234: * Retrieve active connection.
235: * @param string connection registy name
236: * @return DibiConnection
237: * @throws DibiException
238: */
239: public static function getConnection($name = NULL)
240: {
241: if ($name === NULL) {
242: if (self::$connection === NULL) {
243: throw new DibiException('Dibi is not connected to database.');
244: }
245:
246: return self::$connection;
247: }
248:
249: if (!isset(self::$registry[$name])) {
250: throw new DibiException("There is no connection named '$name'.");
251: }
252:
253: return self::$registry[$name];
254: }
255:
256:
257:
258: /**
259: * Change active connection.
260: * @param string connection registy name
261: * @return void
262: * @throws DibiException
263: */
264: public static function activate($name)
265: {
266: self::$connection = self::getConnection($name);
267: }
268:
269:
270:
271: /**
272: * Retrieve active connection profiler.
273: * @return IDibiProfiler
274: * @throws DibiException
275: */
276: public static function getProfiler()
277: {
278: return self::getConnection()->getProfiler();
279: }
280:
281:
282:
283: /********************* monostate for active connection ****************d*g**/
284:
285:
286:
287: /**
288: * Generates and executes SQL query - Monostate for DibiConnection::query().
289: * @param array|mixed one or more arguments
290: * @return DibiResult|int result set object (if any)
291: * @throws DibiException
292: */
293: public static function query($args)
294: {
295: $args = func_get_args();
296: return self::getConnection()->query($args);
297: }
298:
299:
300:
301: /**
302: * Executes the SQL query - Monostate for DibiConnection::nativeQuery().
303: * @param string SQL statement.
304: * @return DibiResult|int result set object (if any)
305: */
306: public static function nativeQuery($sql)
307: {
308: return self::getConnection()->nativeQuery($sql);
309: }
310:
311:
312:
313: /**
314: * Generates and prints SQL query - Monostate for DibiConnection::test().
315: * @param array|mixed one or more arguments
316: * @return bool
317: */
318: public static function test($args)
319: {
320: $args = func_get_args();
321: return self::getConnection()->test($args);
322: }
323:
324:
325:
326: /**
327: * Generates and returns SQL query as DibiDataSource - Monostate for DibiConnection::test().
328: * @param array|mixed one or more arguments
329: * @return DibiDataSource
330: */
331: public static function dataSource($args)
332: {
333: $args = func_get_args();
334: return self::getConnection()->dataSource($args);
335: }
336:
337:
338:
339: /**
340: * Executes SQL query and fetch result - Monostate for DibiConnection::query() & fetch().
341: * @param array|mixed one or more arguments
342: * @return DibiRow
343: * @throws DibiException
344: */
345: public static function fetch($args)
346: {
347: $args = func_get_args();
348: return self::getConnection()->query($args)->fetch();
349: }
350:
351:
352:
353: /**
354: * Executes SQL query and fetch results - Monostate for DibiConnection::query() & fetchAll().
355: * @param array|mixed one or more arguments
356: * @return array of DibiRow
357: * @throws DibiException
358: */
359: public static function fetchAll($args)
360: {
361: $args = func_get_args();
362: return self::getConnection()->query($args)->fetchAll();
363: }
364:
365:
366:
367: /**
368: * Executes SQL query and fetch first column - Monostate for DibiConnection::query() & fetchSingle().
369: * @param array|mixed one or more arguments
370: * @return string
371: * @throws DibiException
372: */
373: public static function fetchSingle($args)
374: {
375: $args = func_get_args();
376: return self::getConnection()->query($args)->fetchSingle();
377: }
378:
379:
380:
381: /**
382: * Executes SQL query and fetch pairs - Monostate for DibiConnection::query() & fetchPairs().
383: * @param array|mixed one or more arguments
384: * @return string
385: * @throws DibiException
386: */
387: public static function fetchPairs($args)
388: {
389: $args = func_get_args();
390: return self::getConnection()->query($args)->fetchPairs();
391: }
392:
393:
394:
395: /**
396: * Gets the number of affected rows.
397: * Monostate for DibiConnection::getAffectedRows()
398: * @return int number of rows
399: * @throws DibiException
400: */
401: public static function getAffectedRows()
402: {
403: return self::getConnection()->getAffectedRows();
404: }
405:
406:
407:
408: /**
409: * Gets the number of affected rows. Alias for getAffectedRows().
410: * @return int number of rows
411: * @throws DibiException
412: */
413: public static function affectedRows()
414: {
415: return self::getConnection()->getAffectedRows();
416: }
417:
418:
419:
420: /**
421: * Retrieves the ID generated for an AUTO_INCREMENT column by the previous INSERT query.
422: * Monostate for DibiConnection::getInsertId()
423: * @param string optional sequence name
424: * @return int
425: * @throws DibiException
426: */
427: public static function getInsertId($sequence=NULL)
428: {
429: return self::getConnection()->getInsertId($sequence);
430: }
431:
432:
433:
434: /**
435: * Retrieves the ID generated for an AUTO_INCREMENT column. Alias for getInsertId().
436: * @param string optional sequence name
437: * @return int
438: * @throws DibiException
439: */
440: public static function insertId($sequence=NULL)
441: {
442: return self::getConnection()->getInsertId($sequence);
443: }
444:
445:
446:
447: /**
448: * Begins a transaction - Monostate for DibiConnection::begin().
449: * @param string optional savepoint name
450: * @return void
451: * @throws DibiException
452: */
453: public static function begin($savepoint = NULL)
454: {
455: self::getConnection()->begin($savepoint);
456: }
457:
458:
459:
460: /**
461: * Commits statements in a transaction - Monostate for DibiConnection::commit($savepoint = NULL).
462: * @param string optional savepoint name
463: * @return void
464: * @throws DibiException
465: */
466: public static function commit($savepoint = NULL)
467: {
468: self::getConnection()->commit($savepoint);
469: }
470:
471:
472:
473: /**
474: * Rollback changes in a transaction - Monostate for DibiConnection::rollback().
475: * @param string optional savepoint name
476: * @return void
477: * @throws DibiException
478: */
479: public static function rollback($savepoint = NULL)
480: {
481: self::getConnection()->rollback($savepoint);
482: }
483:
484:
485:
486: /**
487: * Gets a information about the current database - Monostate for DibiConnection::getDatabaseInfo().
488: * @return DibiDatabaseInfo
489: */
490: public static function getDatabaseInfo()
491: {
492: return self::getConnection()->getDatabaseInfo();
493: }
494:
495:
496:
497: /**
498: * Import SQL dump from file - extreme fast!
499: * @param string filename
500: * @return int count of sql commands
501: */
502: public static function loadFile($file)
503: {
504: return self::getConnection()->loadFile($file);
505: }
506:
507:
508:
509: /**
510: * Replacement for majority of dibi::methods() in future.
511: */
512: public static function __callStatic($name, $args)
513: {
514: //if ($name = 'select', 'update', ...') {
515: // return self::command()->$name($args);
516: //}
517: return call_user_func_array(array(self::getConnection(), $name), $args);
518: }
519:
520:
521:
522: /********************* fluent SQL builders ****************d*g**/
523:
524:
525:
526: /**
527: * @return DibiFluent
528: */
529: public static function command()
530: {
531: return self::getConnection()->command();
532: }
533:
534:
535:
536: /**
537: * @param string column name
538: * @return DibiFluent
539: */
540: public static function select($args)
541: {
542: $args = func_get_args();
543: return call_user_func_array(array(self::getConnection(), 'select'), $args);
544: }
545:
546:
547:
548: /**
549: * @param string table
550: * @param array
551: * @return DibiFluent
552: */
553: public static function update($table, $args)
554: {
555: return self::getConnection()->update($table, $args);
556: }
557:
558:
559:
560: /**
561: * @param string table
562: * @param array
563: * @return DibiFluent
564: */
565: public static function insert($table, $args)
566: {
567: return self::getConnection()->insert($table, $args);
568: }
569:
570:
571:
572: /**
573: * @param string table
574: * @return DibiFluent
575: */
576: public static function delete($table)
577: {
578: return self::getConnection()->delete($table);
579: }
580:
581:
582:
583: /********************* data types ****************d*g**/
584:
585:
586:
587: /**
588: * @deprecated
589: */
590: public static function datetime($time = NULL)
591: {
592: return new DateTime53(is_numeric($time) ? date('Y-m-d H:i:s', $time) : $time);
593: }
594:
595:
596:
597: /**
598: * @deprecated
599: */
600: public static function date($date = NULL)
601: {
602: return new DateTime53(is_numeric($date) ? date('Y-m-d', $date) : $date);
603: }
604:
605:
606:
607: /********************* substitutions ****************d*g**/
608:
609:
610:
611: /**
612: * Create a new substitution pair for indentifiers.
613: * @param string from
614: * @param string to
615: * @return void
616: */
617: public static function addSubst($expr, $subst)
618: {
619: self::$substs->$expr = $subst;
620: }
621:
622:
623:
624: /**
625: * Remove substitution pair.
626: * @param mixed from or TRUE
627: * @return void
628: */
629: public static function removeSubst($expr)
630: {
631: if ($expr === TRUE) {
632: self::$substs = new DibiLazyStorage(self::$substs->getCallback());
633: } else {
634: unset(self::$substs->$expr);
635: }
636: }
637:
638:
639:
640: /**
641: * Sets substitution fallback handler.
642: * @param callback
643: * @return void
644: */
645: public static function setSubstFallback($callback)
646: {
647: self::$substs->setCallback($callback);
648: }
649:
650:
651:
652: /**
653: * Default substitution fallback handler.
654: * @param string
655: * @return mixed
656: */
657: public static function defaultSubstFallback($expr)
658: {
659: return ":$expr:";
660: }
661:
662:
663:
664: /********************* misc tools ****************d*g**/
665:
666:
667:
668: /**
669: * Prints out a syntax highlighted version of the SQL command or DibiResult.
670: * @param string|DibiResult
671: * @param bool return output instead of printing it?
672: * @return string
673: */
674: public static function dump($sql = NULL, $return = FALSE)
675: {
676: ob_start();
677: if ($sql instanceof DibiResult) {
678: $sql->dump();
679:
680: } else {
681: if ($sql === NULL) $sql = self::$sql;
682:
683: static $keywords1 = 'SELECT|UPDATE|INSERT(?:\s+INTO)?|REPLACE(?:\s+INTO)?|DELETE|FROM|WHERE|HAVING|GROUP\s+BY|ORDER\s+BY|LIMIT|OFFSET|SET|VALUES|LEFT\s+JOIN|INNER\s+JOIN|TRUNCATE';
684: static $keywords2 = 'ALL|DISTINCT|DISTINCTROW|AS|USING|ON|AND|OR|IN|IS|NOT|NULL|LIKE|TRUE|FALSE';
685:
686: // insert new lines
687: $sql = " $sql ";
688: $sql = preg_replace("#(?<=[\\s,(])($keywords1)(?=[\\s,)])#i", "\n\$1", $sql);
689:
690: // reduce spaces
691: $sql = preg_replace('#[ \t]{2,}#', " ", $sql);
692:
693: $sql = wordwrap($sql, 100);
694: $sql = preg_replace("#([ \t]*\r?\n){2,}#", "\n", $sql);
695:
696: if (PHP_SAPI === 'cli') {
697: echo trim($sql) . "\n\n";
698: } else {
699: // syntax highlight
700: $sql = htmlSpecialChars($sql);
701: $sql = preg_replace_callback("#(/\\*.+?\\*/)|(\\*\\*.+?\\*\\*)|(?<=[\\s,(])($keywords1)(?=[\\s,)])|(?<=[\\s,(=])($keywords2)(?=[\\s,)=])#is", array('dibi', 'highlightCallback'), $sql);
702: echo '<pre class="dump">', trim($sql), "</pre>\n";
703: }
704: }
705:
706: if ($return) {
707: return ob_get_clean();
708: } else {
709: ob_end_flush();
710: }
711: }
712:
713:
714:
715: private static function highlightCallback($matches)
716: {
717: if (!empty($matches[1])) // comment
718: return '' . $matches[1] . '';
719:
720: if (!empty($matches[2])) // error
721: return '' . $matches[2] . '';
722:
723: if (!empty($matches[3])) // most important keywords
724: return '' . $matches[3] . '';
725:
726: if (!empty($matches[4])) // other keywords
727: return '' . $matches[4] . '';
728: }
729:
730: }
731:
732:
733:
734: // static constructor
735: dibi::$substs = new DibiLazyStorage(array('dibi', 'defaultSubstFallback'));

dibi API documentation

Packages

Source for file dibi.php