[ PHPXref.com ] [ Generated: Sun Jul 20 20:47:21 2008 ] [ TPLN 2.6 ]
[ Index ]     [ Variables ]     [ Functions ]     [ Classes ]     [ Constants ]     [ Statistics ]

title

Body

[close]

/TPLN/pear/DB/ -> mysql.php (summary)

The PEAR DB driver for PHP's mysql extension for interacting with MySQL databases PHP versions 4 and 5

Author: Stig Bakken
Author: Daniel Convissor
Copyright: 1997-2005 The PHP Group
License: http://www.php.net/license/3_0.txt PHP License 3.0
Version: CVS: $Id: mysql.php,v 1.117 2005/03/29 15:03:26 danielc Exp $
File Size: 1034 lines (32 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

DB_mysql:: (26 methods):
  DB_mysql()
  connect()
  disconnect()
  simpleQuery()
  nextResult()
  fetchInto()
  freeResult()
  numCols()
  numRows()
  autoCommit()
  commit()
  rollback()
  affectedRows()
  nextId()
  createSequence()
  dropSequence()
  _BCsequence()
  quoteIdentifier()
  quote()
  escapeSimple()
  modifyQuery()
  modifyLimitQuery()
  mysqlRaiseError()
  errorNative()
  tableInfo()
  getSpecialQuery()


Class: DB_mysql  - X-Ref

The methods PEAR DB uses to interact with PHP's mysql extension
for interacting with MySQL databases

These methods overload the ones declared in DB_common.

DB_mysql()   X-Ref
This constructor calls <kbd>$this->DB_common()</kbd>

return: void

connect($dsn, $persistent = false)   X-Ref
Connect to the database server, log in and open the database

Don't call this method directly.  Use DB::connect() instead.

PEAR DB's mysql driver supports the following extra DSN options:
+ new_link      If set to true, causes subsequent calls to connect()
to return a new connection link instead of the
existing one.  WARNING: this is not portable to
other DBMS's. Available since PEAR DB 1.7.0.
+ client_flags  Any combination of MYSQL_CLIENT_* constants.
Only used if PHP is at version 4.3.0 or greater.
Available since PEAR DB 1.7.0.

param: array $dsn         the data source name
param: bool  $persistent  should the connection be persistent?
return: int  DB_OK on success. A DB_Error object on failure.

disconnect()   X-Ref
Disconnects from the database server

return: bool  TRUE on success, FALSE on failure

simpleQuery($query)   X-Ref
Sends a query to the database server

Generally uses mysql_query().  If you want to use
mysql_unbuffered_query() set the "result_buffering" option to 0 using
setOptions().  This option was added in Release 1.7.0.

param: string  the SQL query string
return: mixed  + a PHP result resrouce for successful SELECT queries

nextResult($result)   X-Ref
Move the internal mysql result pointer to the next available result

This method has not been implemented yet.

param: a valid sql result resource
return: false

fetchInto($result, &$arr, $fetchmode, $rownum = null)   X-Ref
Places a row from the result set into the given array

Formating of the array and the data therein are configurable.
See DB_result::fetchInto() for more information.

This method is not meant to be called directly.  Use
DB_result::fetchInto() instead.  It can't be declared "protected"
because DB_result is a separate object.

param: resource $result    the query result resource
param: array    $arr       the referenced array to put the data in
param: int      $fetchmode how the resulting array should be indexed
param: int      $rownum    the row number to fetch (0 = first row)
return: mixed  DB_OK on success, NULL when the end of a result set is

freeResult($result)   X-Ref
Deletes the result set and frees the memory occupied by the result set

This method is not meant to be called directly.  Use
DB_result::free() instead.  It can't be declared "protected"
because DB_result is a separate object.

param: resource $result  PHP's query result resource
return: bool  TRUE on success, FALSE if $result is invalid

numCols($result)   X-Ref
Gets the number of columns in a result set

This method is not meant to be called directly.  Use
DB_result::numCols() instead.  It can't be declared "protected"
because DB_result is a separate object.

param: resource $result  PHP's query result resource
return: int  the number of columns.  A DB_Error object on failure.

numRows($result)   X-Ref
Gets the number of rows in a result set

This method is not meant to be called directly.  Use
DB_result::numRows() instead.  It can't be declared "protected"
because DB_result is a separate object.

param: resource $result  PHP's query result resource
return: int  the number of rows.  A DB_Error object on failure.

autoCommit($onoff = false)   X-Ref
Enables or disables automatic commits

param: bool $onoff  true turns it on, false turns it off
return: int  DB_OK on success.  A DB_Error object if the driver

commit()   X-Ref
Commits the current transaction

return: int  DB_OK on success.  A DB_Error object on failure.

rollback()   X-Ref
Reverts the current transaction

return: int  DB_OK on success.  A DB_Error object on failure.

affectedRows()   X-Ref
Determines the number of rows affected by a data maniuplation query

0 is returned for queries that don't manipulate data.

return: int  the number of rows.  A DB_Error object on failure.

nextId($seq_name, $ondemand = true)   X-Ref
Returns the next free id in a sequence

param: string  $seq_name  name of the sequence
param: boolean $ondemand  when true, the seqence is automatically
return: int  the next id number in the sequence.

createSequence($seq_name)   X-Ref
Creates a new sequence

param: string $seq_name  name of the new sequence
return: int  DB_OK on success.  A DB_Error object on failure.

dropSequence($seq_name)   X-Ref
Deletes a sequence

param: string $seq_name  name of the sequence to be deleted
return: int  DB_OK on success.  A DB_Error object on failure.

_BCsequence($seqname)   X-Ref
Backwards compatibility with old sequence emulation implementation
(clean up the dupes)

param: string $seqname  the sequence name to clean up
return: bool  true on success.  A DB_Error object on failure.

quoteIdentifier($str)   X-Ref
Quotes a string so it can be safely used as a table or column name

MySQL can't handle the backtick character (<kbd>`</kbd>) in
table or column names.

param: string $str  identifier name to be quoted
return: string  quoted identifier string

quote($str)   X-Ref


escapeSimple($str)   X-Ref
Escapes a string according to the current DBMS's standards

param: string $str  the string to be escaped
return: string  the escaped string

modifyQuery($query)   X-Ref
Changes a query string for various DBMS specific reasons

This little hack lets you know how many rows were deleted
when running a "DELETE FROM table" query.  Only implemented
if the DB_PORTABILITY_DELETE_COUNT portability option is on.

param: string $query  the query string to modify
return: string  the modified query string

modifyLimitQuery($query, $from, $count, $params = array()   X-Ref
Adds LIMIT clauses to a query string according to current DBMS standards

param: string $query   the query to modify
param: int    $from    the row to start to fetching (0 = the first row)
param: int    $count   the numbers of rows to fetch
param: mixed  $params  array, string or numeric data to be used in
return: string  the query string with LIMIT clauses added

mysqlRaiseError($errno = null)   X-Ref
Produces a DB_Error object regarding the current problem

param: int $errno  if the error is being manually raised pass a
return: object  the DB_Error object

errorNative()   X-Ref
Gets the DBMS' native error code produced by the last query

return: int  the DBMS' error code

tableInfo($result, $mode = null)   X-Ref
Returns information about a table or a result set

param: object|string  $result  DB_result object from a query or a
param: int            $mode    a valid tableInfo mode
return: array  an associative array with the information requested.

getSpecialQuery($type)   X-Ref
Obtains the query string needed for listing a given type of objects

param: string $type  the kind of objects you want to retrieve
return: string  the SQL query string or null if the driver doesn't



[ Powered by PHPXref - Served by Debian GNU/Linux ]