Class DB_fbsql

Description

Database independent query interface definition for PHP's FrontBase extension.

  • author: Frank M. Kromann <frank@frontbase.com>
  • version: $Id: fbsql.php,v 1.36 2004/06/24 15:24:56 danielc Exp $

Located in /maintenance/libraries/pear/DB/fbsql.php (line 44)

PEAR
   |
   --DB_common
      |
      --DB_fbsql
Variable Summary
Method Summary
 DB_fbsql DB_fbsql ()
 number affectedRows ()
 void autoCommit ([mixed $onoff = false])
 void commit ()
 int connect ($dsn $dsninfo, [$persistent $persistent = false])
 int createSequence (string $seq_name)
 bool disconnect ()
 int dropSequence (string $seq_name)
 int errorNative ()
 object DB fbsqlRaiseError ([integer $errno = null])
 mixed fetchInto (resource $result, array &$arr, int $fetchmode, [int $rownum = null])
 bool freeResult ($result $result)
 string getSpecialQuery (string $type)
 void modifyQuery (mixed $query)
 int nextId (string $seq_name, [boolean $ondemand = true])
 true nextResult (a $result)
 int numCols ($result $result)
 int numRows ($result $result)
 mixed quoteSmart (mixed $in)
 void rollback ()
 mixed simpleQuery (the $query)
 array tableInfo (object|string $result, [int $mode = null])
Variables
mixed $connection (line 48)
mixed $dbsyntax (line 49)
mixed $fetchmode = DB_FETCHMODE_ORDERED (line 53)

Redefinition of:
DB_common::$fetchmode
mixed $num_rows = array() (line 52)
mixed $phptype (line 49)

Redefinition of:
DB_common::$phptype
DB type (mysql, oci8, odbc etc.)
mixed $prepare_tokens = array() (line 50)

Redefinition of:
DB_common::$prepare_tokens
mixed $prepare_types = array() (line 51)

Redefinition of:
DB_common::$prepare_types

Inherited Variables

Inherited from DB_common

DB_common::$dbh
DB_common::$errorcode_map
DB_common::$features
DB_common::$fetchmode_object_class
DB_common::$last_query
DB_common::$options
DB_common::$prepared_queries
DB_common::$prepare_maxstmt
Methods
Constructor DB_fbsql (line 63)

DB_fbsql constructor.

  • access: public
DB_fbsql DB_fbsql ()
affectedRows (line 365)

Gets the number of rows affected by the data manipulation query. For other queries, this function returns 0.

  • return: of rows affected by the last query
number affectedRows ()

Redefinition of:
DB_common::affectedRows()
Returns the affected rows of a query
autoCommit (line 287)
void autoCommit ([mixed $onoff = false])

Redefinition of:
DB_common::autoCommit()
enable automatic Commit
commit (line 299)
void commit ()

Redefinition of:
DB_common::commit()
starts a Commit
connect (line 104)

Connect to a database and log in as the specified user.

  • return: DB_OK on success, a DB error on failure
  • access: public
int connect ($dsn $dsninfo, [$persistent $persistent = false])
  • $dsn $dsninfo: the data source name (see DB::parseDSN for syntax)
  • $persistent $persistent: (optional) whether the connection should be persistent
createSequence (line 442)

Creates a new sequence

int createSequence (string $seq_name)
  • string $seq_name: name of the new sequence

Redefinition of:
DB_common::createSequence()
Creates a new sequence
disconnect (line 155)

Log out and disconnect from the database.

  • return: true on success, false if not connected.
  • access: public
bool disconnect ()
dropSequence (line 464)

Deletes a sequence

int dropSequence (string $seq_name)
  • string $seq_name: name of the sequence to be deleted

Redefinition of:
DB_common::dropSequence()
Deletes a sequence
errorNative (line 386)

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

  • return: native fbsql error code
  • access: public
int errorNative ()

Redefinition of:
DB_common::errorNative()
Returns an errormessage, provides by the database
fbsqlRaiseError (line 530)

Gather information about an error, then use that info to create a DB error object and finally return that object.

object DB fbsqlRaiseError ([integer $errno = null])
  • integer $errno: PEAR error number (usually a DB constant) if manually raising an error
fetchInto (line 236)

Fetch a row and insert the data into an existing array.

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

  • return: DB_OK on success, null when end of result set is reached or on failure
  • access: private
  • see: DB_result::fetchInto()
mixed fetchInto (resource $result, array &$arr, int $fetchmode, [int $rownum = null])
  • resource $result: query result identifier
  • array $arr: (reference) array where data from the row should be placed
  • int $fetchmode: how the resulting array should be indexed
  • int $rownum: the row number to fetch
freeResult (line 279)

Free the internal resources associated with $result.

  • return: true on success, false if $result is invalid
  • access: public
bool freeResult ($result $result)
  • $result $result: fbsql result identifier
getSpecialQuery (line 635)

Returns the query needed to get some backend info

  • return: The SQL query string
string getSpecialQuery (string $type)
  • string $type: What kind of info you want to retrieve

Redefinition of:
DB_common::getSpecialQuery()
Returns the query needed to get some backend info
modifyQuery (line 473)
void modifyQuery (mixed $query)

Redefinition of:
DB_common::modifyQuery()
This method is used by backends to alter queries for various reasons
nextId (line 407)

Returns the next free id in a sequence

  • return: the next id number in the sequence. DB_Error if problem.
  • access: public
  • see: DB_common::nextID()
  • internal:
int nextId (string $seq_name, [boolean $ondemand = true])
  • string $seq_name: name of the sequence
  • boolean $ondemand: when true, the seqence is automatically created if it does not exist

Redefinition of:
DB_common::nextId()
Returns the next free id in a sequence
nextResult (line 210)

Move the internal fbsql result pointer to the next available result

  • return: if a result is available otherwise return false
  • access: public
true nextResult (a $result)
  • a $result: valid fbsql result resource
numCols (line 324)

Get the number of columns in a result set.

  • return: the number of columns per row in $result
  • access: public
int numCols ($result $result)
  • $result $result: fbsql result identifier
numRows (line 347)

Get the number of rows in a result set.

  • return: the number of rows in $result
  • access: public
int numRows ($result $result)
  • $result $result: fbsql result identifier

Redefinition of:
DB_common::numRows()
Returns the number of rows in a result object
quoteSmart (line 504)

Format input so it can be safely used in a query

  • return: Submitted variable's type = returned value:
    • null = the string NULL
    • boolean = string TRUE or FALSE
    • integer or double = the unquoted number
    • other (including strings and numeric strings) = the data escaped according to MySQL's settings then encapsulated between single quotes
  • internal:
mixed quoteSmart (mixed $in)
  • mixed $in: data to be quoted

Redefinition of:
DB_common::quoteSmart()
Format input so it can be safely used in a query
rollback (line 307)
void rollback ()

Redefinition of:
DB_common::rollback()
starts a rollback
simpleQuery (line 177)

Send a query to fbsql and return the results as a fbsql resource identifier.

  • return: returns a valid fbsql result for successful SELECT queries, DB_OK for other successful queries. A DB error is returned on failure.
  • access: public
mixed simpleQuery (the $query)
  • the $query: SQL query
tableInfo (line 554)

Returns information about a table or a result set.

  • return: an associative array with the information requested or an error object if something is wrong
  • see: DB_common::tableInfo()
  • internal:
  • access: public
array tableInfo (object|string $result, [int $mode = null])
  • object|string $result: DB_result object from a query or a string containing the name of a table
  • int $mode: a valid tableInfo mode

Redefinition of:
DB_common::tableInfo()
Returns information about a table or a result set

Inherited Methods

Inherited From DB_common

 DB_common::DB_common()
 DB_common::affectedRows()
 DB_common::autoCommit()
 DB_common::autoExecute()
 DB_common::autoPrepare()
 DB_common::buildManipSQL()
 DB_common::commit()
 DB_common::createSequence()
 DB_common::dropSequence()
 DB_common::errorCode()
 DB_common::errorMessage()
 DB_common::errorNative()
 DB_common::escapeSimple()
 DB_common::execute()
 DB_common::executeEmulateQuery()
 DB_common::executeMultiple()
 DB_common::freePrepared()
 DB_common::getAll()
 DB_common::getAssoc()
 DB_common::getCol()
 DB_common::getListOf()
 DB_common::getOne()
 DB_common::getOption()
 DB_common::getRow()
 DB_common::getSequenceName()
 DB_common::getSpecialQuery()
 DB_common::getTables()
 DB_common::limitQuery()
 DB_common::modifyLimitQuery()
 DB_common::modifyQuery()
 DB_common::nextId()
 DB_common::numRows()
 DB_common::prepare()
 DB_common::provides()
 DB_common::query()
 DB_common::quote()
 DB_common::quoteIdentifier()
 DB_common::quoteSmart()
 DB_common::quoteString()
 DB_common::raiseError()
 DB_common::rollback()
 DB_common::setFetchMode()
 DB_common::setOption()
 DB_common::tableInfo()
 DB_common::toString()
 DB_common::_convertNullArrayValuesToEmpty()
 DB_common::_rtrimArrayValues()

Documentation generated on Fri, 24 Dec 2004 13:02:05 +0000 by phpDocumentor 1.3.0RC3