[ Index ]
 

Code source de PHP PEAR 1.4.5

Accédez au Source d'autres logiciels libresSoutenez Angelica Josefina !

title

Body

[fermer]

/docs/MDB/doc/ -> skeleton.php (sommaire)

(pas de description)

Poids: 771 lignes (26 kb)
Inclus ou requis:0 fois
Référencé: 0 fois
Nécessite: 1 fichier
 MDB/Common.php

Définit 1 class

MDB_xxx:: (36 méthodes):
  MDB_xxx()
  errorNative()
  xxxRaiseError()
  autoCommit()
  commit()
  rollback()
  connect()
  _close()
  query()
  subSelect()
  replace()
  getColumnNames()
  numCols()
  endOfResult()
  _retrieveLob()
  endOfResultLob()
  _readResultLob()
  _destroyResultLob()
  fetch()
  fetchClob()
  fetchBlob()
  resultIsNull()
  convertResult()
  numRows()
  freeResult()
  get()
  get()
  getClobValue()
  freeClobValue()
  getBlobValue()
  freeBlobValue()
  nextId()
  currId()
  fetchInto()
  nextResult()
  tableInfo()


Classe: MDB_xxx  - X-Ref

MDB XXX driver

MDB_xxx()   X-Ref
Constructor


errorNative()   X-Ref
Get the native error code of the last error (if any) that
occured on the current connection.

return: int native XXX error code

xxxRaiseError($errno = NULL, $message = NULL)   X-Ref
This method is used to communicate an error and invoke error
callbacks etc.  Basically a wrapper for MDB::raiseError
that checks for native error msgs.

param: integer $errno error code
param: string  $message userinfo message
return: object a PEAR error object

autoCommit($auto_commit)   X-Ref
Define whether database changes done on the database be automatically
committed. This function may also implicitly start or end a transaction.

param: boolean $auto_commit    flag that indicates whether the database
return: mixed MDB_OK on success, a MDB error on failure

commit()   X-Ref
Commit the database changes done during a transaction that is in
progress. This function may only be called when auto-committing is
disabled, otherwise it will fail. Therefore, a new transaction is
implicitly started after committing the pending changes.

return: mixed MDB_OK on success, a MDB error on failure

rollback()   X-Ref
Cancel any database changes done during a transaction that is in
progress. This function may only be called when auto-committing is
disabled, otherwise it will fail. Therefore, a new transaction is
implicitly started after canceling the pending changes.

return: mixed MDB_OK on success, a MDB error on failure

connect()   X-Ref
Connect to the database

return: TRUE on success, MDB_Error on failure

_close()   X-Ref
all the RDBMS specific things needed close a DB connection


query($query, $types = NULL)   X-Ref
Send a query to the database and return any results

param: string  $query  the SQL query
param: array   $types  array that contains the types of the columns in
return: mixed a result handle or MDB_OK on success, a MDB error on failure

subSelect($query, $quote = FALSE)   X-Ref
simple subselect emulation for Mysql

param: string $query the SQL query for the subselect that may only
param: string $quote determines if the data needs to be quoted before
return: string the query

replace($table, $fields)   X-Ref
Execute a SQL REPLACE query. A REPLACE query is identical to a INSERT
query, except that if there is already a row in the table with the same
key field values, the REPLACE query just updates its values instead of
inserting a new row.

The REPLACE type of query does not make part of the SQL standards. Since
practically only MySQL implements it natively, this type of query is
emulated through this method for other DBMS using standard types of
queries inside a transaction to assure the atomicity of the operation.

param: string $table name of the table on which the REPLACE query will
param: array $fields associative array that describes the fields and the
return: mixed MDB_OK on success, a MDB error on failure

getColumnNames($result)   X-Ref
Retrieve the names of columns returned by the DBMS in a query result.

param: resource   $result    result identifier
return: mixed                an associative array variable

numCols($result)   X-Ref
Count the number of columns returned by the DBMS in a query result.

param: resource    $result        result identifier
return: mixed integer value with the number of columns, a MDB error

endOfResult($result)   X-Ref
check if the end of the result set has been reached

param: resource    $result result identifier
return: mixed TRUE or FALSE on sucess, a MDB error on failure

_retrieveLob($lob)   X-Ref
fetch a float value from a result set

param: int $lob handle to a lob created by the createLob() function
return: mixed MDB_OK on success, a MDB error on failure

endOfResultLob($lob)   X-Ref
Determine whether it was reached the end of the large object and
therefore there is no more data to be read for the its input stream.

param: int    $lob handle to a lob created by the createLob() function
return: mixed TRUE or FALSE on success, a MDB error on failure

_readResultLob($lob, &$data, $length)   X-Ref
Read data from large object input stream.

param: int $lob handle to a lob created by the createLob() function
param: blob $data reference to a variable that will hold data to be
param: int $length integer value that indicates the largest ammount of
return: mixed length on success, a MDB error on failure

_destroyResultLob($lob)   X-Ref
Free any resources allocated during the lifetime of the large object
handler object.

param: int $lob handle to a lob created by the createLob() function

fetch($result, $row, $field)   X-Ref
fetch value from a result set

param: resource    $result result identifier
param: int    $row    number of the row where the data can be found
param: int    $field    field number where the data can be found
return: mixed string on success, a MDB error on failure

fetchClob($result, $row, $field)   X-Ref
fetch a clob value from a result set

param: resource    $result result identifier
param: int    $row    number of the row where the data can be found
param: int    $field    field number where the data can be found
return: mixed content of the specified data cell, a MDB error on failure,

fetchBlob($result, $row, $field)   X-Ref
fetch a blob value from a result set

param: resource    $result result identifier
param: int    $row    number of the row where the data can be found
param: int    $field    field number where the data can be found
return: mixed content of the specified data cell, a MDB error on failure

resultIsNull($result, $row, $field)   X-Ref
Determine whether the value of a query result located in given row and
field is a NULL.

param: resource    $result result identifier
param: int    $row    number of the row where the data can be found
param: int    $field    field number where the data can be found
return: mixed TRUE or FALSE on success, a MDB error on failure

convertResult($value, $type)   X-Ref
convert a value to a RDBMS indepdenant MDB type

param: mixed  $value   value to be converted
param: int    $type    constant that specifies which type to convert to
return: mixed converted value

numRows($result)   X-Ref
returns the number of rows in a result object

param: ressource $result a valid result ressouce pointer
return: mixed MDB_Error or the number of rows

freeResult($result)   X-Ref
Free the internal resources associated with $result.

param: $result result identifier
return: bool TRUE on success, FALSE if $result is invalid

get({}/*** Convert a text value into a DBMS specific format that is suitable to* compose query statements.** @param resource $prepared_query query handle from prepare()   X-Ref
Pas de description

get({}/*** Convert a text value into a DBMS specific format that is suitable to* compose query statements.** @param resource $prepared_query query handle from prepare()   X-Ref
Pas de description

getClobValue($prepared_query, $parameter, $clob)   X-Ref
Pas de description

freeClobValue($prepared_query, $clob, &$value)   X-Ref
free a chracter large object

param: resource  $prepared_query query handle from prepare()
param: string    $clob
param: string    $value
return: MDB_OK

getBlobValue($prepared_query, $parameter, $blob)   X-Ref
Convert a text value into a DBMS specific format that is suitable to
compose query statements.

param: resource  $prepared_query query handle from prepare()
param: $parameter
param: $blob
return: string  text string that represents the given argument value in

freeBlobValue($prepared_query, $blob)   X-Ref
free a binary large object

param: resource  $prepared_query query handle from prepare()
param: string    $blob
return: MDB_OK

nextId($seq_name, $ondemand = FALSE)   X-Ref
returns the next free id of a sequence

param: string  $seq_name name of the sequence
param: boolean $ondemand when true the seqence is
return: mixed MDB_Error or id

currId($seq_name)   X-Ref
returns the current id of a sequence

param: string  $seq_name name of the sequence
return: mixed MDB_Error or id

fetchInto($result, $fetchmode = MDB_FETCHMODE_DEFAULT, $rownum = 0)   X-Ref
Fetch a row and insert the data into an existing array.

param: resource  $result     result identifier
param: int       $fetchmode  how the array data should be indexed
param: int       $rownum     the row number to fetch
return: int data array on success, a MDB error on failure

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

param: a valid result resource
return: true if a result is available otherwise return false

tableInfo($result, $mode = NULL)   X-Ref
returns meta data about the result set

param: resource    $result    result identifier
param: mixed $mode depends on implementation
return: array an nested array, or a MDB error



Généré le : Sun Feb 25 14:08:00 2007 par Balluche grâce à PHPXref 0.7