Removing the PHP4 constructors
[isso.git] / db_mysql.php
1 <?php
2 /*=====================================================================*\
3 || ###################################################################
4 || # Blue Static ISSO Framework [#]issoversion[#]
5 || # Copyright ©2002-[#]year[#] Blue Static
6 || #
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.
10 || #
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
14 || # more details.
15 || #
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 \*=====================================================================*/
21
22 /**
23 * MySQL Database Abstraction Layer
24 * db_mysql.php
25 *
26 * @package ISSO
27 */
28
29 $this->load('db', null);
30
31 /**
32 * MySQL Database Abstraction Layer
33 *
34 * This framework is a function wrapper for MySQL functions so we can have
35 * better error reporting and query reporting.
36 *
37 * @author Blue Static
38 * @copyright Copyright ©2002 - [#]year[#], Blue Static
39 * @version $Revision$
40 * @package ISSO
41 *
42 */
43 class DB_MySQL extends DB_Abstract
44 {
45 /**
46 * Command mapping list
47 * @var array
48 */
49 private $commands = array(
50 'pconnect' => '$this->command_mysql_pconnect',
51 'connect' => '$this->command_mysql_connect',
52 'query' => '$this->command_mysql_query',
53 'error_num' => 'mysql_errno',
54 'error_str' => 'mysql_error',
55 'escape_string' => '$this->command_mysql_escape_string',
56 'escape_binary' => '$this->escape_binary',
57 'fetch_assoc' => 'mysql_fetch_assoc',
58 'fetch_row' => 'mysql_fetch_row',
59 'fetch_object' => 'mysql_fetch_object',
60 'free_result' => 'mysql_free_result',
61 'insert_id' => 'mysql_insert_id',
62 'num_rows' => 'mysql_num_rows',
63 'affected_rows' => 'mysql_affected_rows'
64 );
65
66 // ###################################################################
67 /**
68 * Constructor
69 */
70 function __construct(&$registry)
71 {
72 parent::__construct($registry);
73 }
74
75 // ###################################################################
76 /**
77 * Wrapper: mysql_pconnect
78 *
79 * @access protected
80 *
81 * @param string Server name
82 * @param string User name
83 * @param string Password
84 * @param string Database
85 *
86 * @return integer DB-Link
87 */
88 function command_mysql_pconnect($server, $user, $password, $database)
89 {
90 $link = mysql_pconnect($server, $user, $password);
91 $this->select_db($database, $link);
92
93 return $link;
94 }
95
96 // ###################################################################
97 /**
98 * Wrapper: mysql_connect
99 *
100 * @access protected
101 *
102 * @param string Server name
103 * @param string User name
104 * @param string Password
105 * @param string Database
106 *
107 * @return integer DB-Link
108 */
109 function command_mysql_connect($server, $user, $password, $database)
110 {
111 $link = mysql_connect($server, $user, $password);
112 $this->select_db($database, $link);
113
114 return $link;
115 }
116
117 // ###################################################################
118 /**
119 * Wrapper: mysql_select_db
120 *
121 * @access protected
122 *
123 * @param string Database name
124 * @param integer DB-Link
125 */
126 function select_db($database, $link)
127 {
128 if (!mysql_select_db($database, $link))
129 {
130 $this->error('Cannot use the database \'' . $this->database . '\'');
131 }
132 }
133
134 // ###################################################################
135 /**
136 * Wrapper: mysql_query
137 *
138 * @access protected
139 *
140 * @param integer DB-Link
141 * @param string Query string
142 *
143 * @return integer Result
144 */
145 function command_mysql_query($link, $string)
146 {
147 return mysql_query($string, $link);
148 }
149
150 // ###################################################################
151 /**
152 * Escapes a binary string for insertion into the database
153 *
154 * @access public
155 *
156 * @param string Unescaped data
157 *
158 * @return string Escaped binary data
159 */
160 function escape_binary($binary)
161 {
162 return mysql_escape_string($binary);
163 }
164
165 // ###################################################################
166 /**
167 * Wrapper: mysql(_real)_escape_string
168 *
169 * @access protected
170 *
171 * @param integer DB-Link
172 * @param string Unescaped text
173 *
174 * @return string Escaped text
175 */
176 function command_mysql_escape_string($link, $string)
177 {
178 if (function_exists('mysql_real_escape_string'))
179 {
180 return @mysql_real_escape_string($string, $link);
181 }
182 else
183 {
184 return @mysql_escape_string($string);
185 }
186 }
187
188 // ###################################################################
189 /**
190 * Not supported: unescape binary string
191 *
192 * @access protected
193 *
194 * @param string Escaped data
195 *
196 * @return string Same data
197 */
198 function command_unescape_binary($string)
199 {
200 return $string;
201 }
202
203 // ###################################################################
204 /**
205 * Starts a database transaction
206 *
207 * @access public
208 */
209 function transaction_start()
210 {
211 $this->query("BEGIN WORK");
212 }
213
214 // ###################################################################
215 /**
216 * Saves current transaction steps as a savepoint
217 *
218 * @access public
219 *
220 * @param string Named savepoint
221 */
222 function transaction_savepoint($name)
223 {
224 $this->query("SAVEPOINT $name");
225 }
226
227 // ###################################################################
228 /**
229 * Reverts a transaction back to a given savepoint
230 *
231 * @access public
232 *
233 * @param string Named savepoint
234 */
235 function transaction_rollback($name = null)
236 {
237 $this->query("ROLLBACK" . ($name != null ? " TO SAVEPOINT $name" : ""));
238 }
239
240 // ###################################################################
241 /**
242 * Commits a database transaction
243 *
244 * @access public
245 */
246 function transaction_commit()
247 {
248 $this->query("COMMIT");
249 }
250 }
251
252 /*=====================================================================*\
253 || ###################################################################
254 || # $HeadURL$
255 || # $Id$
256 || ###################################################################
257 \*=====================================================================*/
258 ?>