Library /lib/yadal/class.Yadal.php

Language PHP Lines 457
MD5 Hash 1cc60462eec310a03950b27987dd1fbd
Repository https://github.com/reshadf/Library.git View Raw File
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
<?php
/**
 * Yadal mail class and the yadal object creator function
 *
 * @package Yadal
 */

define('YADAL_DEFAULT_DB_TYPE', 'mysql');

/**
 * newYadal()
 *
 * Create a new database object of the correct type
 *
 * @param string $database: the database name to connect to
 * @param string $type: the type of database to use (default MySQL)
 * @return object
 * @access public
 * @author Teye Heimans
 */
function newYadal( $database = null, $type = null )
{
	// set the default database type if none is given
	if( is_null($type) )
	{
		$type = YADAL_DEFAULT_DB_TYPE;
	}

	switch( strtolower($type) )
	{
	  // mysql
	  case 'mysql':
		include_once dirname(__FILE__).'/class.MySQL.php';
		return new MySQL( $database );
		break;

	  // postgresql
	  case 'postgresql':
	  case 'postgres':
	  case 'pgsql':
	    include_once dirname(__FILE__).'/class.PostgreSQL.php';
	    return new PostgreSQL( $database );
	    break;

	  // Microsoft SQL server (MSSQL)
	  case 'mssql':
	    include_once dirname(__FILE__).'/class.MSSQL.php';
	    return new MSSQL( $database );
	    break;

	  // Microsoft access database (Windows only)
	  case 'access':
	    include_once dirname(__FILE__).'/class.Access.php';
	    return new Access( $database );
	    break;

	  // ODBC
	  /* NOT SUPPORTED YET
	  case 'odbc':
	    include_once 'class.ODBC.php';
	    return new ODBC( $database );
	    break;
	  */

	  // wrong type given!
	  default:
	    trigger_error(
	      'Error, database type "'.$type.'" not supported!',
	      E_USER_ERROR
	    );
	    return null;
	}
}

/**
 * class Yadal
 *
 * Yadal - Yet Another Database Abstraction Layer
 * Abstract database class
 *
 * @author Teye Heimans
 * @package Yadal
 */
class Yadal
{
	var $_conn;			// resource: contains the connection resource
    var $_db;           // string: contains the database name
    var $_table;        // string: contains the table name
    var $_keys;         // array: contains the primary keys
    var $_isConnected;  // boolean: do we have a connection ?
    var $_quoteNumbers; // boolean: do we have to quote numbers?
    var $_nameQuote;    // char/array: quote to use around table and field names (for possible spaces in the names)
    var $_lastQuery;	// string: the last query executed
    var $_cache;        // array: cache of most actions.

    /**
     * Yadal::Yadal()
     *
     * Abstract constructor: store the db name.
     * Dont use this class to make a new Yadal object!!! Use the function
     * newYadal() instead!!
     *
     * @param string $db: the database we are using
     * @author Teye Heimans
     */
    function Yadal( $db = null )
    {
        if( !is_null( $db ) )
        {
    		$this->_db = $db;
        }

        $this->_isConnected  = false;
        $this->_quoteNumbers = false;
        if( !isset($this->_nameQuote) || $this->_nameQuote == null )
        {
        	$this->_nameQuote = '"';
        }
    }

    /**
     * Yadal::setConnectionResource()
     *
     * Instead of opening a new connection, set the
     * connection resource of the already opend connection
     *
     * @param resource $conn: The connection resource
     * @return void
     * @access public
     * @author Teye Heimans
     */
    function setConnectionResource( &$conn )
    {
    	$this->_conn = &$conn;
    	$this->_isConnected = true;
    }

    /**
     * Yadal::isConnected()
     *
     * Return if we have a connection or not
     *
     * @return boolean
     * @access public
     * @author Teye Heimans
     */
    function isConnected()
    {
        return $this->_isConnected;
    }

    /**
     * Yadal::dbDate()
     *
     * Convert the given date to the correct database format.
     *
     * @param string $y: The year of the date which should be converteds
     * @param string $m: The month of the date which should be converteds
     * @param string $d: The day of the date which should be converteds
     * @return string the date in the correct format or null when the date could not be converted
     * @access public
     * @author Teye Heimans
     */
    function dbDate( $y, $m, $d )
    {
        return "'$y-$m-$d'";
    }

    /**
     * Yadal::array2case()
     *
     * Change an array to a CASE statement which can be used in an query.
     * Example:
     * array2case( 'UserType', array( 1 => 'Admin', 2 => 'Moderator', 3 => 'User' ) );
     *
     * Result:
     * CASE `UserType`
     *  WHEN 1 THEN 'Admin'
     *  WHEN 2 THEN 'Moderator'
     *  WHEN 3 THEN 'User'
     *  ELSE 'Unknown'
     * END
     *
     * @param string $field: The field which we should use in the case or if statement
     * @param array $options: Array of options. The array key will be used as statement compare-item and the value will be used as value
     * @param string $default: The default value if none of the array keys are matched. Default is "Unknown". If you dont want to have a default value, use false
     * @return string
     * @access public
     * @author Teye Heimans
     */
    function array2case( $field, $options, $default = 'Unknown' )
    {
        // if there are 2 options, use an if statement
    	if( sizeof( $options ) == 2 )
    	{
    		list( $key1, $value1 ) = $options;
    		list( $key2, $value2 ) = $options;

    		return
    		  "IF( ". $this->quote($field)." == '".$key1."', ".
    		  "'".$this->escapeString($value1)."', ".
    		  "'".$this->escapeString($value2)."' )";
    	}
    	// there are more then 2 options, use a case statement
    	else
    	{
    		$result = "CASE ". $this->quote($field) ."\n";
    		foreach( $options as $key => $value )
    		{
    			$result .= "  WHEN '".$key."' THEN '".$this->escapeString( $value )."'\n";
    		}
    		if( $default )
    		{
    			$result .= "  ELSE '".$this->escapeString($default)."'\n";
    		}
    		$result .= "END";

    		return $result ;
    	}
    }

    /**
     * Yadal::quoteNumbers()
     *
     * Do we have to quote numbers ?
     *
     * @return boolean
     * @access public
     * @author Teye Heimans
     */
    function quoteNumbers()
    {
    	return $this->_quoteNumbers;
    }

    /**
     * Yadal::quote()
     *
     * Return the table name or field name quoted (so that spaces can be used)
     *
     * @param string $name: The table or field name which should me quoted
     * @return string
     * @access public
     * @author Teye Heimans
     */
    function quote( $name )
    {
        // is there a dot in the name ? (like table.name)
        $pos = strpos($name, '.');
        if( $pos !== false)
        {
            return
              $this->quote( substr($name, 0, $pos ) ) .'.'.
              $this->quote( substr($name, $pos + 1) );
        }
		if( is_array($this->_nameQuote))
		{
    		return $this->_nameQuote[0] . $name . $this->_nameQuote[1];
    	}
    	else
    	{
    		return $this->_nameQuote . $name . $this->_nameQuote;
    	}
    }

    /**
     * Yadal::clearCache()
     *
     * Clears the cache of most functions, like getUniqueFields, getNotNullFields, etc.
     *
     * @return void
     * @access public
     * @author Teye Heimans
     */
    function clearCache()
    {
        $this->_cache = null;
    }

    /**
     * Yadal::getLastQuery()
     *
     * Return the last query which was executed
     *
     * @return string
     * @access public
     * @author Teye Heimans
     */
    function getLastQuery()
    {
    	return $this->_lastQuery;
    }

    /**
     * Yadal::result()
     *
     * Return a specific result of a sql resource
     *
     * @param resource $sql: The sql where you want to get a result from
     * @param int $row: The row where you want a result from
     * @param string $field: The field which result you want
     * @return string
     * @access public
     * @author Teye Heimans
     */
    function result( $sql, $row = 0, $field = null )
    {
    	$i = 0;
    	while( $data = $this->getRecord( $sql ) )
    	{
    		if( $i++ == $row )
    		{
    			break;
    		}
    	}

    	if( is_null( $field ) )
    	{
    		list( , $value ) = each($data);
    		return $value;
    	}
    	else
    	{
    		foreach( $data as $column => $value )
    		{
    			if( strtolower($column) == strtolower( $field ) )
    			{
    				return $value;
    			}
    		}
    	}

    	return false;
    }

    function getTables( )
    {
    	trigger_error(
          'Error, abstract function '.__FUNCTION__.' has not been overwritten by class '.get_class( $this ),
          E_USER_WARNING
        );
    }

    function getFieldTypes( )
    {
    	trigger_error(
          'Error, abstract function '.__FUNCTION__.' has not been overwritten by class '.get_class( $this ),
          E_USER_WARNING
        );
    }

    function connect( )
    {
    	trigger_error(
          'Error, abstract function '.__FUNCTION__.' has not been overwritten by class '.get_class( $this ),
          E_USER_WARNING
        );
    }

    function getNotNullFields()
    {
	    trigger_error(
          'Error, abstract function '.__FUNCTION__.' has not been overwritten by class '.get_class( $this ),
          E_USER_WARNING
        );
    }

    function getUniqueFields()
    {
        trigger_error(
          'Error, abstract function '.__FUNCTION__.' has not been overwritten by class '.get_class( $this ),
          E_USER_WARNING
        );
    }

    function getPrKeys()
    {
        trigger_error(
          'Error, abstract function '.__FUNCTION__.' has not been overwritten by class '.get_class( $this ),
          E_USER_WARNING
        );
    }

    function recordCount()
    {
        trigger_error(
          'Error, abstract function '.__FUNCTION__.' has not been overwritten by class '.get_class( $this ),
          E_USER_WARNING
        );
    }

    function getFieldNames()
    {
        trigger_error(
          'Error, abstract function '.__FUNCTION__.' has not been overwritten by class '.get_class( $this ),
          E_USER_WARNING
        );
    }

    function escapeString()
    {
        trigger_error(
          'Error, abstract function '.__FUNCTION__.' has not been overwritten by class '.get_class( $this ),
          E_USER_WARNING
        );
    }

    function getRecord()
    {
        trigger_error(
          'Error, abstract function '.__FUNCTION__.' has not been overwritten by class '.get_class( $this ),
          E_USER_WARNING
        );
    }

    function getInsertId()
    {
        trigger_error(
          'Error, abstract function '.__FUNCTION__.' has not been overwritten by class '.get_class( $this ),
          E_USER_WARNING
        );
    }

    function query()
    {
        trigger_error(
          'Error, abstract function '.__FUNCTION__.' has not been overwritten by class '.get_class( $this ),
          E_USER_WARNING
        );
    }

    function close()
    {
        trigger_error(
          'Error, abstract function '.__FUNCTION__.' has not been overwritten by class '.get_class( $this ),
          E_USER_WARNING
        );
    }

    function getError()
    {
        trigger_error(
          'Error, abstract function '.__FUNCTION__.' has not been overwritten by class '.get_class( $this ),
          E_USER_WARNING
        );
    }

    function GetErrorNo()
    {
        trigger_error(
          'Error, abstract function '.__FUNCTION__.' has not been overwritten by class '.get_class( $this ),
          E_USER_WARNING
        );
    }
}

?>
Back to Top