Class XoopsMySQLDatabase

connection to a mysql database - legacy support only

PHP version 5.3

XoopsDatabase

XoopsMySQLDatabase

Direct known subclasses

XoopsMySQLDatabaseProxy, XoopsMySQLDatabaseSafe

Indirect known subclasses

ProtectorMySQLDatabase

Package: MySQLDatabase
Deprecated: since version 2.6.0 - alpha 3. Switch to doctrine connector.
Category: Xoops\Class\Database\MySQLDatabase
Copyright: 2013 XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono onokazu@xoops.org
Author: readheadedrod redheadedrod@hotmail.com
Author: Richard Griffith richard@geekwright.com
Version: Release: 2.6
Since: 2.6.0
Link: http://xoops.org
Located at lass/database/mysqldatabase.php

Methods summary
`protected`	# `deprecated( )` Issue a deprecated warning once per session Issue a deprecated warning once per session
`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` resource to get result from Returns array
`public array`	# `fetchArray( resource $result )` Fetch a result row as an associative array Fetch a result row as an associative array Parameters `$result` resource to get result from Returns array
`public array`	# `fetchBoth( resource $result )` Fetch a result row as an associative array Fetch a result row as an associative array Parameters `$result` resource to get result from Returns array
`public object\|stdClass`	# `fetchObject( resource $result )` Fetch a result row as an object Fetch a result row as an object Parameters `$result` resource to get result from Returns object\|stdClass
`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` the resource containing the number of rows Returns integer the number of rows to return
`public integer`	# `getAffectedRows( )` Get number of affected rows Get number of affected rows Returns integer
`public`	# `close( )` Close MySQL connection Close 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` query result Returns boolean TRUE on success or FALSE on failure.
`public boolean`	# `error( )` Returns the text of the error message from previous MySQL operation Returns the text of the error message from previous MySQL operation Returns boolean 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 Returns string
`public string`	# `escape( string $string )` Escapes a string for use in a query. Does not add quotes. Escapes a string for use in a query. Does not add quotes. Parameters `$string` string to escape Returns string
`public boolean\|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 boolean\|resource query result or FALSE if successful or TRUE if successful and no result
`public this`	# `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 Returns this returns nothing
`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` numerical field index Returns string
`public string`	# `getFieldType( resource $result, integer $offset )` Get field type Get field type Parameters `$result` query result `$offset` numerical field index Returns string
`public integer`	# `getFieldsNum( resource $result )` Get number of fields in result Get number of fields in result Parameters `$result` query result Returns integer

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

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

Properties inherited from XoopsDatabase
`$allowWebChanges, $prefix`

Namespaces

Classes

Interfaces

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

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns