Docs For Class DB

DB_fbsql

Description

The methods PEAR DB uses to interact with PHP's fbsql extension for interacting with FrontBase databases

These methods overload the ones declared in DB_common.

author: Daniel Convissor <danielc@php.net>
author: Frank M. Kromann <frank@frontbase.com>
version: Release: 1.7.13
copyright: 1997-2007 The PHP Group
link: http://pear.php.net/package/DB
since: Class functional since Release 1.7.0
license: PHP License 3.0

Located in /web/lib/external/pear-db/DB/fbsql.php (line 48)

PEAR
   |
   --DB_common
      |
      --DB_fbsql

Variable Summary

resource $connection

string $dbsyntax

array $dsn

array $errorcode_map

array $features

string $phptype

Method Summary

void DB_fbsql ()

int affectedRows ()

int autoCommit ([bool $onoff = false])

int commit ()

int connect (array $dsn, [bool $persistent = false])

int createSequence (string $seq_name)

bool disconnect ()

int dropSequence (string $seq_name)

int errorNative ()

object the fbsqlRaiseError ([int $errno = null])

mixed fetchInto (resource $result, &$arr, int $fetchmode, [int $rownum = null], array $arr)

bool freeResult (resource $result)

string getSpecialQuery (string $type)

string modifyLimitQuery (string $query, int $from, int $count, [mixed $params = array()])

int nextId (string $seq_name, [boolean $ondemand = true])

true nextResult (a $result)

int numCols (resource $result)

int numRows (resource $result)

string quoteBoolean (boolean $boolean)

string quoteFloat (float $float)

int rollback ()

mixed simpleQuery (string $query)

array tableInfo (object|string $result, [int $mode = null])

Variables

resource $connection (line 114)

The raw database connection created by PHP

string $dbsyntax = 'fbsql' (line 62)

The database syntax variant to be used (db2, access, etc.), if any

array $dsn = array() (line 120)

The DSN information for connecting to a database

array $errorcode_map = array(
22 => DB_ERROR_SYNTAX,
85 => DB_ERROR_ALREADY_EXISTS,
108 => DB_ERROR_SYNTAX,
116 => DB_ERROR_NOSUCHTABLE,
124 => DB_ERROR_VALUE_COUNT_ON_ROW,
215 => DB_ERROR_NOSUCHFIELD,
217 => DB_ERROR_INVALID_NUMBER,
226 => DB_ERROR_NOSUCHFIELD,
231 => DB_ERROR_INVALID,
239 => DB_ERROR_TRUNCATED,
251 => DB_ERROR_SYNTAX,
266 => DB_ERROR_NOT_FOUND,
357 => DB_ERROR_CONSTRAINT_NOT_NULL,
358 => DB_ERROR_CONSTRAINT,
360 => DB_ERROR_CONSTRAINT,
361 => DB_ERROR_CONSTRAINT,
) (line 91)

A mapping of native error codes to DB error codes

array $features = array(
'limit' => 'alter',
'new_link' => false,
'numrows' => true,
'pconnect' => true,
'prepare' => false,
'ssl' => false,
'transactions' => true,
) (line 77)

The capabilities of this DB implementation

The 'new_link' element contains the PHP version that first provided new_link support for this DBMS. Contains false if it's unsupported.

Meaning of the 'limit' element:

'emulate' = emulate with fetch row by number
'alter' = alter the query
false = skip rows

string $phptype = 'fbsql' (line 56)

The DB driver type (mysql, oci8, odbc, etc.)

Inherited Variables

Inherited from DB_common

DB_common::$fetchmode
DB_common::$fetchmode_object_class
DB_common::$last_parameters
DB_common::$last_query
DB_common::$options
DB_common::$prepared_queries
DB_common::$prepare_tokens
DB_common::$prepare_types
DB_common::$was_connected
DB_common::$_last_query_manip
DB_common::$_next_query_manip

Methods

Constructor DB_fbsql (line 131)

This constructor calls $this->DB_common()

void DB_fbsql ()

affectedRows (line 432)

Determines the number of rows affected by a data maniuplation query

is returned for queries that don't manipulate data.

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

int affectedRows ()

Redefinition of:

DB_common::affectedRows(): Determines the number of rows affected by a data maniuplation query

autoCommit (line 337)

Enables or disables automatic commits

return: DB_OK on success. A DB_Error object if the driver doesn't support auto-committing transactions.

int autoCommit ([bool $onoff = false])

bool $onoff: true turns it on, false turns it off

Redefinition of:

DB_common::autoCommit(): Enables or disables automatic commits

commit (line 354)

Commits the current transaction

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

int commit ()

Redefinition of:

DB_common::commit(): Commits the current transaction

connect (line 149)

Connect to the database server, log in and open the database

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

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

int connect (array $dsn, [bool $persistent = false])

array $dsn: the data source name
bool $persistent: should the connection be persistent?

createSequence (line 494)

Creates a new sequence

return: DB_OK on success. A DB_Error object on failure.
see: DB_common::createSequence(), DB_common::getSequenceName(), DB_fbsql::nextID(), DB_fbsql::dropSequence()

int createSequence (string $seq_name)

string $seq_name: name of the new sequence

Redefinition of:

DB_common::createSequence(): Creates a new sequence

disconnect (line 203)

Disconnects from the database server

return: TRUE on success, FALSE on failure

bool disconnect ()

dropSequence (line 519)

Deletes a sequence

return: DB_OK on success. A DB_Error object on failure.
see: DB_common::dropSequence(), DB_common::getSequenceName(), DB_fbsql::nextID(), DB_fbsql::createSequence()

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 619)

Gets the DBMS' native error code produced by the last query

return: the DBMS' error code

int errorNative ()

Redefinition of:

DB_common::errorNative(): Gets the DBMS' native error code produced by the last query

fbsqlRaiseError (line 602)

Produces a DB_Error object regarding the current problem

return: DB_Error object
see: DB_common::raiseError(), DB_fbsql::errorNative(), DB_common::errorCode()

object the fbsqlRaiseError ([int $errno = null])

int $errno: if the error is being manually raised pass a DB_ERROR* constant here. If this isn't passed the error information gathered from the DBMS.

fetchInto (line 278)

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.

return: DB_OK on success, NULL when the end of a result set is reached or on failure
see: DB_result::fetchInto()

mixed fetchInto (resource $result, &$arr, int $fetchmode, [int $rownum = null], array $arr)

resource $result: the query result resource
array $arr: the referenced array to put the data in
int $fetchmode: how the resulting array should be indexed
int $rownum: the row number to fetch (0 = first row)
&$arr

freeResult (line 321)

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.

return: TRUE on success, FALSE if $result is invalid
see: DB_result::free()

bool freeResult (resource $result)

resource $result: PHP's query result resource

getSpecialQuery (line 723)

Obtains the query string needed for listing a given type of objects

return: the SQL query string or null if the driver doesn't support the object type requested
see: DB_common::getListOf()
access: protected

string getSpecialQuery (string $type)

string $type: the kind of objects you want to retrieve

Redefinition of:

DB_common::getSpecialQuery(): Obtains the query string needed for listing a given type of objects

modifyLimitQuery (line 544)

Adds LIMIT clauses to a query string according to current DBMS standards

return: the query string with LIMIT clauses added
access: protected

string modifyLimitQuery (string $query, int $from, int $count, [mixed $params = array()])

string $query: the query to modify
int $from: the row to start to fetching (0 = the first row)
int $count: the numbers of rows to fetch
mixed $params: array, string or numeric data to be used in execution of the statement. Quantity of items passed must match quantity of placeholders in query: meaning 1 placeholder for non-array parameters or 1 placeholder per array element.

Redefinition of:

DB_common::modifyLimitQuery(): Adds LIMIT clauses to a query string according to current DBMS standards

nextId (line 458)

Returns the next free id in a sequence

return: the next id number in the sequence. A DB_Error object on failure.
see: DB_common::nextID(), DB_common::getSequenceName(), DB_fbsql::createSequence(), DB_fbsql::dropSequence()

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 250)

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 388)

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.

return: the number of columns. A DB_Error object on failure.
see: DB_result::numCols()

int numCols (resource $result)

resource $result: PHP's query result resource

numRows (line 413)

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.

return: the number of rows. A DB_Error object on failure.
see: DB_result::numRows()

int numRows (resource $result)

resource $result: PHP's query result resource

Redefinition of:

DB_common::numRows(): Determines the number of rows in a query result

quoteBoolean (line 567)

Formats a boolean value for use within a query in a locale-independent manner.

return: the quoted string.
see: DB_common::quoteSmart()
since: Method available since release 1.7.8.

string quoteBoolean (boolean $boolean)

boolean $boolean: the boolean value to be quoted.

Redefinition of:

DB_common::quoteBoolean(): Formats a boolean value for use within a query in a locale-independent manner.

quoteFloat (line 583)

Formats a float value for use within a query in a locale-independent manner.

return: the quoted string.
see: DB_common::quoteSmart()
since: Method available since release 1.7.8.

string quoteFloat (float $float)

float $float: the float value to be quoted.

Redefinition of:

DB_common::quoteFloat(): Formats a float value for use within a query in a locale-independent manner.

rollback (line 367)

Reverts the current transaction

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

int rollback ()

Redefinition of:

DB_common::rollback(): Reverts the current transaction

simpleQuery (line 222)

Sends a query to the database server

return: + a PHP result resrouce for successful SELECT queries
- the DB_OK constant for other successful queries
- a DB_Error object on failure

mixed simpleQuery (string $query)

string $query: the SQL query string

tableInfo (line 642)

Returns information about a table or a result set

return: an associative array with the information requested. A DB_Error object on failure.
see: DB_common::tableInfo()

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. While this also accepts a query result resource identifier, this behavior is deprecated.
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::nextQueryIsManip()
DB_common::numRows()
DB_common::prepare()
DB_common::provides()
DB_common::query()
DB_common::quote()
DB_common::quoteBoolean()
DB_common::quoteFloat()
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::_checkManip()
DB_common::_convertNullArrayValuesToEmpty()
DB_common::_rtrimArrayValues()
DB_common::__sleep()
DB_common::__toString()
DB_common::__wakeup()

Inherited From PEAR

PEAR::PEAR()
PEAR::delExpect()
PEAR::expectError()
PEAR::getStaticProperty()
PEAR::isError()
PEAR::loadExtension()
PEAR::popErrorHandling()
PEAR::popExpect()
PEAR::pushErrorHandling()
PEAR::raiseError()
PEAR::registerShutdownFunc()
PEAR::setErrorHandling()
PEAR::staticPopErrorHandling()
PEAR::staticPushErrorHandling()
PEAR::throwError()
PEAR::_PEAR()

Documentation generated on Wed, 09 Feb 2011 08:59:55 +0700 by phpDocumentor 1.4.2