2 // +----------------------------------------------------------------------+
3 // | PHP versions 4 and 5 |
4 // +----------------------------------------------------------------------+
5 // | Copyright (c) 1998-2006 Manuel Lemos, Tomas V.V.Cox, |
6 // | Stig. S. Bakken, Lukas Smith |
7 // | All rights reserved. |
8 // +----------------------------------------------------------------------+
9 // | MDB2 is a merge of PEAR DB and Metabases that provides a unified DB |
10 // | API as well as database abstraction for PHP applications. |
11 // | This LICENSE is in the BSD license style. |
13 // | Redistribution and use in source and binary forms, with or without |
14 // | modification, are permitted provided that the following conditions |
17 // | Redistributions of source code must retain the above copyright |
18 // | notice, this list of conditions and the following disclaimer. |
20 // | Redistributions in binary form must reproduce the above copyright |
21 // | notice, this list of conditions and the following disclaimer in the |
22 // | documentation and/or other materials provided with the distribution. |
24 // | Neither the name of Manuel Lemos, Tomas V.V.Cox, Stig. S. Bakken, |
25 // | Lukas Smith nor the names of his contributors may be used to endorse |
26 // | or promote products derived from this software without specific prior|
27 // | written permission. |
29 // | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
30 // | "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
31 // | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS |
32 // | FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE |
33 // | REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, |
34 // | INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, |
35 // | BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS|
36 // | OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED |
37 // | AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
38 // | LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY|
39 // | WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
40 // | POSSIBILITY OF SUCH DAMAGE. |
41 // +----------------------------------------------------------------------+
42 // | Author: Lukas Smith <smith@pooteeweet.org> |
43 // +----------------------------------------------------------------------+
45 // $Id: Common.php 327310 2012-08-27 15:16:18Z danielc $
51 * @author Lukas Smith <smith@pooteeweet.org>
55 * Base class for the function modules that is extended by each MDB2 driver
57 * To load this module in the MDB2 object:
58 * $mdb->loadModule('Function');
62 * @author Lukas Smith <smith@pooteeweet.org>
64 class MDB2_Driver_Function_Common extends MDB2_Module_Common
66 // {{{ executeStoredProc()
69 * Execute a stored procedure and return any results
71 * @param string $name string that identifies the function to execute
72 * @param mixed $params array that contains the paramaters to pass the stored proc
73 * @param mixed $types array that contains the types of the columns in
75 * @param mixed $result_class string which specifies which result class to use
76 * @param mixed $result_wrap_class string which specifies which class to wrap results in
78 * @return mixed a result handle or MDB2_OK on success, a MDB2 error on failure
81 function executeStoredProc($name, $params = null, $types = null, $result_class = true, $result_wrap_class = false)
83 $db = $this->getDBInstance();
84 if (MDB2::isError($db)) {
88 $error = $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
89 'method not implemented', __FUNCTION__);
94 // {{{ functionTable()
97 * return string for internal table used when calling only a function
99 * @return string for internal table used when calling only a function
102 function functionTable()
111 * Return string to call a variable with the current timestamp inside an SQL statement
112 * There are three special variables for current date and time:
113 * - CURRENT_TIMESTAMP (date and time, TIMESTAMP type)
114 * - CURRENT_DATE (date, DATE type)
115 * - CURRENT_TIME (time, TIME type)
117 * @param string $type 'timestamp' | 'time' | 'date'
119 * @return string to call a variable with the current timestamp
122 function now($type = 'timestamp')
126 return 'CURRENT_TIME';
128 return 'CURRENT_DATE';
131 return 'CURRENT_TIMESTAMP';
136 // {{{ unixtimestamp()
139 * return string to call a function to get the unix timestamp from a iso timestamp
141 * @param string $expression
143 * @return string to call a variable with the timestamp
146 function unixtimestamp($expression)
148 $db = $this->getDBInstance();
149 if (MDB2::isError($db)) {
153 $error = $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
154 'method not implemented', __FUNCTION__);
162 * return string to call a function to get a substring inside an SQL statement
164 * @return string to call a function to get a substring
167 function substring($value, $position = 1, $length = null)
169 if (null !== $length) {
170 return "SUBSTRING($value FROM $position FOR $length)";
172 return "SUBSTRING($value FROM $position)";
179 * return string to call a function to get replace inside an SQL statement.
181 * @return string to call a function to get a replace
184 function replace($str, $from_str, $to_str)
186 return "REPLACE($str, $from_str , $to_str)";
193 * Returns string to concatenate two or more string parameters
195 * @param string $value1
196 * @param string $value2
197 * @param string $values...
199 * @return string to concatenate two strings
202 function concat($value1, $value2)
204 $args = func_get_args();
205 return "(".implode(' || ', $args).")";
212 * return string to call a function to get random value inside an SQL statement
214 * @return return string to generate float between 0 and 1
226 * return string to call a function to lower the case of an expression
228 * @param string $expression
230 * @return return string to lower case of an expression
233 function lower($expression)
235 return "LOWER($expression)";
242 * return string to call a function to upper the case of an expression
244 * @param string $expression
246 * @return return string to upper case of an expression
249 function upper($expression)
251 return "UPPER($expression)";
258 * return string to call a function to get the length of a string expression
260 * @param string $expression
262 * @return return string to get the string expression length
265 function length($expression)
267 return "LENGTH($expression)";
274 * Returns global unique identifier
276 * @return string to get global unique identifier
281 $db = $this->getDBInstance();
282 if (MDB2::isError($db)) {
286 $error = $db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
287 'method not implemented', __FUNCTION__);