Class icms_db_legacy_mysql_Database

connection to a mysql database

icms_db_legacy_Database implements icms_db_legacy_IDatabase

icms_db_legacy_mysql_Database

Direct known subclasses

icms_db_legacy_mysql_Proxy, icms_db_legacy_mysql_Safe

Abstract
Package: Database\Legacy
Category: ICMS
Copyright: copyright (c) 2000-2007 XOOPS.org
License: GNU General Public License (GPL)
Author: Kazumi Ono onokazu@xoops.org
Located at db/legacy/mysql/Database.php

Methods summary
`public boolean`	# `connect( boolean $selectdb = true )` connect to the database connect to the database Parameters `$selectdb` select the database now? Returns boolean successful?
`public integer`	# `genId( string $sequence )` generate an ID for a new row generate an ID for a new row This is for compatibility only. Will always return 0, because MySQL supports autoincrement for primary keys. Parameters `$sequence` name of the sequence from which to get the next ID Returns integer always 0, because mysql has support for autoincrement
`public array`	# `fetchRow( resource $result )` Get a result row as an enumerated array Get a result row as an enumerated array Parameters `$result` Returns array the fetched rows
`public array`	# `fetchArray( $result )` Fetch a result row as an associative array Fetch a result row as an associative array Returns array the fetched associative array
`public array`	# `fetchBoth( $result )` Fetch a result row as an associative array and numerical array Fetch a result row as an associative array and numerical array Returns array the associative and numerical array
`public integer`	# `getInsertId( )` Get the ID generated from the previous INSERT operation Get the ID generated from the previous INSERT operation Returns integer
`public integer`	# `getRowsNum( resource $result )` Get number of rows in result Get number of rows in result Parameters `$result` result Returns integer the number of rows in the resultset
`public integer`	# `getAffectedRows( )` Get number of affected rows Get number of affected rows Returns integer number of affected rows
`public`	# `close( )` Closes MySQL connection Closes MySQL connection
`public boolean`	# `freeRecordSet( resource $result )` will free all memory associated with the result identifier result. will free all memory associated with the result identifier result. Parameters `$result` result Returns boolean TRUE on success or FALSE on failure.
`public string`	# `error( )` Returns the text of the error message from previous MySQL operation Returns the text of the error message from previous MySQL operation Returns string Returns the error text from the last MySQL function, or '' (the empty string) if no error occurred.
`public integer`	# `errno( )` Returns the numerical value of the error message from previous MySQL operation Returns the numerical value of the error message from previous MySQL operation Returns integer Returns the error number from the last MySQL function, or 0 (zero) if no error occurred.
`public string`	# `quoteString( string $str )` Returns escaped string text with single quotes around it to be safely stored in database Returns escaped string text with single quotes around it to be safely stored in database Parameters `$str` unescaped string text Returns string escaped string text with single quotes around
`public string`	# `quote( string $string )` Quotes a string for use in a query using mysql_real_escape_string. Quotes a string for use in a query using mysql_real_escape_string. Parameters `$string` $str unescaped string text Returns string escaped string text using mysql_real_escape_string
`public`	# `escape( $string )`
`public resource`	# `queryF( string $sql, integer $limit = 0, integer $start = 0 )` perform a query on the database perform a query on the database Parameters `$sql` a valid MySQL query `$limit` number of records to return `$start` offset of first record to return Returns resource query result or FALSE if successful or TRUE if successful and no result
`public boolean`	# `queryFromFile( string $file )` perform queries from SQL dump file in a batch perform queries from SQL dump file in a batch Parameters `$file` file path to an SQL dump file Returns boolean FALSE if failed reading SQL file or TRUE if the file has been read and queries executed
`public string`	# `getFieldName( resource $result, integer $offset )` Get field name Get field name Parameters `$result` query result `$offset` field index Returns string the fieldname
`public string`	# `getFieldType( resource $result, integer $offset )` Get field type Get field type Parameters `$result` query result `$offset` numerical field index Returns string the fieldtype
`public integer`	# `getFieldsNum( resource $result )` Get number of fields in result Get number of fields in result Parameters `$result` query result Returns integer number of fields in the resultset
`public string`	# `getServerVersion( obj $connection = NULL )` Retrieve the MySQL server version information Retrieve the MySQL server version information Parameters `$connection` $connecton A MySQL database connection link Returns string

Methods inherited from icms_db_legacy_Database
`__construct(), prefix(), setLogger(), setPrefix()`

Methods inherited from icms_db_legacy_IDatabase
`query()`

Properties summary
`public resource`	`$conn` Database connection Database connection	#

Properties inherited from icms_db_legacy_Database
`$allowWebChanges, $logger, $prefix`

Packages

Classes

Class icms_db_legacy_mysql_Database

Direct known subclasses

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns