[ Index ]

PHP Cross Reference of Joomla 1.5.26 DE

title

Body

[close]

/libraries/joomla/database/database/ -> mysql.php (summary)

(no description)

Copyright: Copyright (C) 2005 - 2010 Open Source Matters. All rights reserved.
License: GNU/GPL, see LICENSE.php
Version: $Id: mysql.php 16385 2010-04-23 10:44:15Z ian $
File Size: 692 lines (16 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

JDatabaseMySQL:: (29 methods):
  __construct()
  __destruct()
  test()
  connected()
  select()
  hasUTF()
  setUTF()
  getEscaped()
  query()
  getAffectedRows()
  queryBatch()
  explain()
  getNumRows()
  loadResult()
  loadResultArray()
  loadAssoc()
  loadAssocList()
  loadObject()
  loadObjectList()
  loadRow()
  loadRowList()
  insertObject()
  updateObject()
  insertid()
  getVersion()
  getCollation()
  getTableList()
  getTableCreate()
  getTableFields()


Class: JDatabaseMySQL  - X-Ref

MySQL database driver

__construct( $options )   X-Ref
Database object constructor

param: array    List of options used to configure the connection

__destruct()   X-Ref
Database object destructor

return: boolean

test()   X-Ref
Test to see if the MySQL connector is available

return: boolean  True on success, false otherwise.

connected()   X-Ref
Determines if the connection to the server is active.

return: boolean

select($database)   X-Ref
Select a database for use

param: string $database
return: boolean True if the database has been successfully selected

hasUTF()   X-Ref
Determines UTF support

return: boolean True - UTF is supported

setUTF()   X-Ref
Custom settings for UTF support


getEscaped( $text, $extra = false )   X-Ref
Get a database escaped string

param: string    The string to be escaped
param: boolean    Optional parameter to provide extra escaping
return: string

query()   X-Ref
Execute the query

return: mixed A database resource if successful, FALSE if not.

getAffectedRows()   X-Ref
Description

return: int The number of affected rows in the previous operation

queryBatch( $abort_on_error=true, $p_transaction_safe = false)   X-Ref
Execute a batch query

return: mixed A database resource if successful, FALSE if not.

explain()   X-Ref
Diagnostic function

return: string

getNumRows( $cur=null )   X-Ref
Description

return: int The number of rows returned from the most recent query.

loadResult()   X-Ref
This method loads the first field of the first row returned by the query.

return: The value returned in the query or null if the query failed.

loadResultArray($numinarray = 0)   X-Ref
Load an array of single field results into an array


loadAssoc()   X-Ref
Fetch a result row as an associative array

return: array

loadAssocList( $key='' )   X-Ref
Load a assoc list of database rows

param: string The field name of a primary key
return: array If <var>key</var> is empty as sequential list of returned records.

loadObject( )   X-Ref
This global function loads the first row of a query into an object

return: object

loadObjectList( $key='' )   X-Ref
Load a list of database objects

If <var>key</var> is not empty then the returned array is indexed by the value
the database key.  Returns <var>null</var> if the query fails.

param: string The field name of a primary key
return: array If <var>key</var> is empty as sequential list of returned records.

loadRow()   X-Ref
Description

return: The first row of the query.

loadRowList( $key=null )   X-Ref
Load a list of database rows (numeric column indexing)

param: string The field name of a primary key
return: array If <var>key</var> is empty as sequential list of returned records.

insertObject( $table, &$object, $keyName = NULL )   X-Ref
Inserts a row into a table based on an objects properties

param: string    The name of the table
param: object    An object whose properties match table fields
param: string    The name of the primary key. If provided the object property is updated.

updateObject( $table, &$object, $keyName, $updateNulls=true )   X-Ref
Description

param: [type] $updateNulls

insertid()   X-Ref
Description


getVersion()   X-Ref
Description


getCollation()   X-Ref
Assumes database collation in use by sampling one text field in one table

return: string Collation in use

getTableList()   X-Ref
Description

return: array A list of all the tables in the database

getTableCreate( $tables )   X-Ref
Shows the CREATE TABLE statement that creates the given tables

param: array|string     A table name or a list of table names
return: array A list the create SQL for the tables

getTableFields( $tables, $typeonly = true )   X-Ref
Retrieves information about the given tables

param: array|string     A table name or a list of table names
param: boolean            Only return field types, default true
return: array An array of fields by table



Generated: Wed Mar 28 15:54:07 2012 Cross-referenced by PHPXref 0.7.1