Class XoopsMySQLDatabase

connection to a mysql database using MySQLi extension

XoopsMySQLDatabase

Direct known subclasses

XoopsMySQLDatabaseProxy, XoopsMySQLDatabaseSafe

Indirect known subclasses

Package: class\database
Copyright: (c) 2000-2016 XOOPS Project (www.xoops.org)
License: GPL 2 (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono onokazu@xoops.org
Located at lass/database/mysqldatabase.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\|false`	# `fetchRow( mysqli_result $result )` Get a result row as an enumerated array Get a result row as an enumerated array Parameters `$result` Returns array\|false false on end of data
`public array\|false`	# `fetchArray( mysqli_result $result )` Fetch a result row as an associative array Fetch a result row as an associative array Parameters `$result` Returns array\|false false on end of data
`public array\|false`	# `fetchBoth( mysqli_result $result )` Fetch a result row as an associative array Fetch a result row as an associative array Parameters `$result` Returns array\|false false on end of data
`public stdClass\|false`	# `fetchObject( mixed $result )` XoopsMySQLiDatabase::fetchObjected() XoopsMySQLiDatabase::fetchObjected() Parameters `$result` Returns stdClass\|false false on end of data
`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( mysqli_result $result )` Get number of rows in result Get number of rows in result Parameters `$result` Returns integer
`public integer`	# `getAffectedRows( )` Get number of affected rows Get number of affected rows Returns integer
`public`	# `close( )` Close MySQL connection Close MySQL connection
`public`	# `freeRecordSet( mysqli_result $result )` will free all memory associated with the result identifier result. will free all memory associated with the result identifier result. Parameters `$result` result
`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. Quotes a string for use in a query. Parameters `$string` string to quote/escape for use in query Returns string
`public string`	# `escape( string $string )` Escapes a string for use in a query. Does not add surrounding quotes. Escapes a string for use in a query. Does not add surrounding quotes. Parameters `$string` string to escape Returns string
`public mysqli_result\|boolean`	# `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 mysqli_result\|boolean query result or FALSE if successful or TRUE if successful and no result
`public`	# `query( string $sql, integer $limit = 0, integer $start = 0 )` perform a query perform a query This method is empty and does nothing! It should therefore only be used if nothing is exactly what you want done! ;-) Parameters `$sql` a valid MySQL query `$limit` number of records to return `$start` offset of first record to return
`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( mysqli_result $result, integer $offset )` Get field name Get field name Parameters `$result` query result `$offset` numerical field index Returns string
`public string`	# `getFieldType( mysqli_result $result, integer $offset )` Get field type Get field type Parameters `$result` query result `$offset` numerical field index Returns string
`public integer`	# `getFieldsNum( mysqli_result $result )` Get number of fields in result Get number of fields in result Parameters `$result` query result Returns integer
`public string`	# `getServerVersion( )` getServerVersion get version of the mysql server getServerVersion get version of the mysql server Returns string

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

Properties summary
`public XoopsDatabase\|mysqli`	`$conn` Database connection Database connection	#

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

Namespaces

Classes

Interfaces

Exceptions

Functions

Class XoopsMySQLDatabase

Direct known subclasses

Indirect known subclasses

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns