]>
src.bluestatic.org Git - isso.git/blob - db.php
2 /*=====================================================================*\
3 || ###################################################################
5 || # Copyright ©2002-[#]year[#] Iris Studios, Inc.
7 || # This program is free software; you can redistribute it and/or modify
8 || # it under the terms of the GNU General Public License as published by
9 || # the Free Software Foundation; version [#]gpl[#] of the License.
11 || # This program is distributed in the hope that it will be useful, but
12 || # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 || # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
16 || # You should have received a copy of the GNU General Public License along
17 || # with this program; if not, write to the Free Software Foundation, Inc.,
18 || # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
19 || ###################################################################
20 \*=====================================================================*/
23 * Abstract Database Layer
30 * Abstract Database Layer
32 * This class provides an abstract template for all RDBMS layers. All
33 * ISSO abstraction layers should inherit this class. It provides error
34 * reporting, SQL analysis, and general connection functionality.
37 * [required] ISSO_DB_LAYER - The name of the DB layer module used in the application
39 * @author Iris Studios, Inc.
40 * @copyright Copyright ©2002 - [#]year[#], Iris Studios, Inc.
48 * Framework registry object
55 * Determines whether or not errors should be shown
59 var $showerrors = true ;
62 * Current error number
69 * Description of current error
76 * Currend open MySQL connexion
90 * Current query string
97 * History of all executed queryies
101 var $history = array ();
104 * Command mapping list
108 var $commands = array (
109 'pconnect' => '%server %user %password %database' ,
110 'connect' => '%server %user %password %database' ,
111 'query' => '%link %query' ,
112 'error_num' => '%link' ,
113 'error_str' => '%link' ,
114 'escape_string' => '%link %string' ,
115 'fetch_assoc' => '%result' ,
116 'fetch_row' => '%result' ,
117 'fetch_object' => '%result' ,
118 'free_result' => '%result' ,
119 'insert_id' => '%link' ,
120 'num_rows' => '%result' ,
121 'affected_rows' => '%result'
124 // ###################################################################
128 function __construct (& $registry )
130 $this- > registry
=& $registry ;
132 // because ivars and call_user_func() are conspiring against us...
133 foreach ( $this- > commands
AS $key => $string )
135 if ( strpos ( $string , ' $this- >' ) !== false )
137 $this- > commands
[ " $key" ] = array( $this , str_replace(' $this- >', '', $string ));
142 // ###################################################################
144 * (PHP 4) Constructor
146 function DB_Abstract(& $registry )
148 $this- >__construct( $registry );
151 // ###################################################################
153 * Initializes the class and all subclasses under a common package name
157 * @return string The package name
159 function init_as_package()
161 if (!defined('ISSO_DB_LAYER'))
163 define('ISSO_DB_LAYER', get_class( $this ));
164 trigger_error('ISSO_DB_LAYER was defined automatically by DB::init_as_package(). Define the constant yourself to remove this warning', E_USER_WARNING);
170 // ###################################################################
172 * Connect to a the specified database
176 * @param string Server name
177 * @param string User name
178 * @param string Password
179 * @param string Database name
180 * @param bool Use p-connect?
182 * @return bool Result of connect
184 function connect( $server , $user , $password , $database , $pconnect )
186 $this- >registry->check_isso_fields(get_class( $this ));
188 if ( $this- >dblink == false)
190 $this- >dblink = call_user_func(( $pconnect ? $this- >commands['pconnect'] : $this- >commands['connect']), $server , $user , $password , $database );
192 if ( $this- >dblink == false)
194 $this- >error('DB-Link == false, cannot connect');
202 // ###################################################################
204 * Send a query to the open database link
208 * @param string Query string
210 * @return integer Result
212 function query( $string )
214 $this- >querystr = $string ;
215 $this- >result = call_user_func( $this- >commands['query'], $this- >dblink, $string );
216 $this- >history[] = $string ;
218 if (defined('ISSO_SHOW_QUERIES_LIVE'))
220 if (constant('ISSO_SHOW_QUERIES_LIVE'))
222 print( $this- >querystr . '<hr />');
228 $this- >error('Invalid SQL query');
231 return $this- >result;
234 // ###################################################################
236 * Escape a string (depending on character set, if supported)
240 * @param string String to be escaped
242 * @return string Escaped string
244 function escape_string( $string )
246 return call_user_func( $this- >commands['escape_string'], $this- >dblink, $string );
249 // ###################################################################
251 * Fetch the query result as an array
255 * @param integer Result
256 * @param bool Return an associative array?
258 * @return array A row of the query result
260 function fetch_array( $result , $assoc = true)
262 return call_user_func( $this- >commands[ ( $assoc ? 'fetch_assoc' : 'fetch_row') ], $result );
265 // ###################################################################
267 * Fetch the query result as an object
271 * @param integer Result
273 * @return object An object with the query result
275 function fetch_object( $result )
277 return call_user_func( $this- >commands['fetch_object'], $result );
280 // ###################################################################
282 * Send a query and return the first row of the results
286 * @param string Query string
287 * @param string Result return function (in the database layer)
289 * @return mixed Results in variable formats
291 function query_first( $string , $callback = 'fetch_array')
293 $resource = $this- >query( $string );
294 $return = $this- > $callback ( $resource );
295 $this- >free_result( $resource );
299 // ###################################################################
301 * Free the current query result
305 * @param integer Result
307 function free_result( $result )
309 call_user_func( $this- >commands['free_result'], $result );
310 $this- >result = null;
311 $this- >querystr = '';
314 // ###################################################################
316 * Fetch the unique ID of the record just inserted
320 * @return integer Insert-ID
324 return call_user_func( $this- >commands['insert_id'], $this- >dblink);
327 // ###################################################################
329 * Fetch the number of rows in the result
333 * @param integer Result
335 * @return integer Number of rows
337 function num_rows( $result )
339 return call_user_func( $this- >commands['num_rows'], $result );
342 // ###################################################################
344 * Fetch the number of rows affected by the query
348 * @param integer Result
350 * @return integer Number of affected rows
352 function affected_rows( $result )
354 return call_user_func( $this- >commands['affected_rows'], $result );
357 // ###################################################################
359 * Error wrapper for ISSO->message()
363 * @param string User defined error message
365 function error( $message )
367 if ( $this- >showerrors)
371 $this- >errnum = call_user_func( $this- >commands['error_num'], $this- >dblink);
372 $this- >errstr = call_user_func( $this- >commands['error_str'], $this- >dblink);
375 $style ['code'] = 'font-family: \' Courier New \' , Courier, mono; font-size: 11px;';
377 $message_prepped = " < blockquote
>\n< p
> ";
378 $message_prepped .= " \n\t
& raquo
; < strong
> Query
:</ strong
>\n< br
/> < pre style
=\" $style [ code
]\"> " . htmlspecialchars( $this- >querystr) ." </ pre
>\n< br
/> ";
379 $message_prepped .= " \n\t
& raquo
; < strong
> Error Number
:</ strong
> < span style
=\" $style [ code
]\"> " . $this- >errnum . " </ span
>\n< br
/> ";
380 $message_prepped .= " \n\t
& raquo
; < strong
> Error Message
:</ strong
> < span style
=\" $style [ code
]\"> " . $this- >errstr . " </ span
>\n< br
/> ";
381 $message_prepped .= " \n\t
& raquo
; < strong
> Additional Notes
:</ strong
> < span style
=\" $style [ code
]\"> " . $message . " </ span
>\n< br
/> ";
382 $message_prepped .= " \n\t
& raquo
; < strong
> File
:</ strong
> < span style
=\" $style [ code
]\"> " . $_SERVER ['PHP_SELF'] . " </ span
>\n ";
383 $message_prepped .= " \n
</ p
>\n</ blockquote
> ";
385 $this- >registry->message('Database Error in `<em>' . $this- >registry->application . '</em>`', $message_prepped , 3);
391 /*=====================================================================*\
392 || ###################################################################
395 || ###################################################################
396 \*=====================================================================*/