Class: DB_odbc

Source Location: /DB-1.4.0/DB/odbc.php

Class Overview

PEAR
   |
   --DB_common
      |
      --DB_odbc

Variables

Methods

Inherited Variables

Class: DB_common

DB_common::$dbh
DB_common::$errorcode_map
DB_common::$features
DB_common::$fetchmode
DB_common::$fetchmode_object_class
DB_common::$last_query
DB_common::$options
DB_common::$prepared_queries
DB_common::$prepare_maxstmt
DB_common::$prepare_tokens
DB_common::$prepare_types
DB_common::$type

Inherited Methods

Class: DB_common

DB_common::DB_common(): Constructor
DB_common::affectedRows(): returns the affected rows of a query
DB_common::autoCommit(): enable automatic Commit
DB_common::autoExecute(): Make automaticaly an insert or update query and call prepare() and execute() with it
DB_common::autoPrepare(): Make automaticaly an insert or update query and call prepare() with it
DB_common::buildManipSQL(): Make automaticaly an sql query for prepare()
DB_common::commit(): starts a Commit
DB_common::createSequence(): creates a new sequence
DB_common::dropSequence(): deletes a sequence
DB_common::errorCode(): Map native error codes to DB's portable ones. Requires that the DB implementation's constructor fills in the $errorcode_map property.
DB_common::errorMessage(): Map a DB error code to a textual message. This is actually just a wrapper for DB::errorMessage().
DB_common::errorNative(): returns an errormessage, provides by the database
DB_common::execute(): Executes a prepared SQL query
DB_common::executeMultiple(): This function does several execute() calls on the same statement handle. $data must be an array indexed numerically from 0, one execute call is done for every "row" in the array.
DB_common::getAll(): Fetch all the rows returned from a query.
DB_common::getAssoc(): Fetch the entire result set of a query and return it as an associative array using the first column as the key.
DB_common::getCol(): Fetch a single column from a result set and return it as an indexed array.
DB_common::getListOf(): list internal DB info valid values for $type are db dependent, often: databases, users, view, functions
DB_common::getOne(): Fetch the first column of the first row of data returned from a query. Takes care of doing the query and freeing the results when finished.
DB_common::getOption(): returns the value of an option
DB_common::getRow(): Fetch the first row of data returned from a query. Takes care of doing the query and freeing the results when finished.
DB_common::getSequenceName()
DB_common::getTables()
DB_common::limitQuery(): Generates a limited query
DB_common::nextId(): returns the next free id of a sequence
DB_common::numRows(): returns the number of rows in a result object
DB_common::prepare(): Prepares a query for multiple execution with execute().
DB_common::provides(): Tell whether a DB implementation or its backend extension supports a given feature.
DB_common::query(): Send a query to the database and return any results with a DB_result object.
DB_common::quote(): Quotes a string so it can be safely used in a query. It will return the string with single quotes around. Other backend quote styles should override this method.
DB_common::quoteString(): Quotes a string so it can be safely used within string delimiters in a query (preserved for compatibility issues, quote() is preffered).
DB_common::raiseError(): This method is used to communicate an error and invoke error callbacks etc. Basically a wrapper for PEAR::raiseError without the message string.
DB_common::rollback(): starts a rollback
DB_common::setFetchMode(): Sets which fetch mode should be used by default on queries on this connection.
DB_common::setOption(): set the option for the db class
DB_common::tableInfo(): returns meta data about the result set

Class Details

[line 36]

[ Top ]

Class Variables

$connection =

[line 40]

Type:

mixed

[ Top ]

$dbsyntax =

[line 41]

Type:

mixed

[ Top ]

$phptype =

[line 41]

Type:

mixed

[ Top ]

$row = array()

[line 42]

Type:

mixed

[ Top ]

Method Detail

DB_odbc (Constructor) [line 47]

DB_odbc DB_odbc(
)

[ Top ]

affectedRows [line 292]

mixed affectedRows(
)

Returns the number of rows affected by a manipulative query

(INSERT, DELETE, UPDATE)

Return: int affected rows, 0 when non manip queries or DB error on error

Overrides DB_common::affectedRows() (returns the affected rows of a query)

[ Top ]

autoCommit [line 418]

void autoCommit(
[mixed
$onoff = false])

Overrides DB_common::autoCommit() (enable automatic Commit)

[ Top ]

commit [line 429]

void commit(
)

Overrides DB_common::commit() (starts a Commit)

[ Top ]

connect [line 97]

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

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

Return: DB_OK on success, a DB error code on failure

Parameters:

$dsn	`$dsninfo`	—	the data source name (see DB::parseDSN for syntax)
$persistent	`$persistent`	—	(optional) whether the connection should be persistent

[ Top ]

createSequence [line 398]

void createSequence(
mixed
$seq_name)

Overrides DB_common::createSequence() (creates a new sequence)

[ Top ]

disconnect [line 142]

void disconnect(
)

[ Top ]

dropSequence [line 409]

void dropSequence(
mixed
$seq_name)

Overrides DB_common::dropSequence() (deletes a sequence)

[ Top ]

errorNative [line 335]

int errorNative(
)

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

Return: ODBC error code
Access: public

Overrides DB_common::errorNative() (returns an errormessage, provides by the database)

[ Top ]

fetchInto [line 216]

void fetchInto(
mixed
$result, mixed
&$row, mixed
$fetchmode, [mixed
$rownum = null])

[ Top ]

fetchRow [line 201]

void fetchRow(
mixed
$result, [mixed
$fetchmode = DB_FETCHMODE_DEFAULT], [mixed
$rownum = null])

[ Top ]

freeResult [line 257]

void freeResult(
mixed
$result)

[ Top ]

getSpecialQuery [line 468]

string getSpecialQuery(
string
$type)

Returns the query needed to get some backend info

Return: The SQL query string

Parameters:

string $type — What kind of info you want to retrieve

[ Top ]

nextId [line 359]

a nextId(
$seq_name
$seq_name, [$ondemand
$ondemand = true])

Get the next value in a sequence. We emulate sequences for odbc. Will create the sequence if it does not exist.

Return: sequence integer, or a DB error
Access: public

Overrides DB_common::nextId() (returns the next free id of a sequence)

Parameters:

$seq_name	`$seq_name`	—	the name of the sequence
$ondemand	`$ondemand`	—	whether to create the sequence table on demand (default is true)

[ Top ]

nextResult [line 193]

true nextResult(
a
$result)

Move the internal odbc result pointer to the next available result

Return: if a result is available otherwise return false
Access: public

Parameters:

a $result — valid fbsql result resource

[ Top ]

numCols [line 274]

void numCols(
mixed
$result)

[ Top ]

numRows [line 314]

the numRows(
$result
$result)

ODBC may or may not support counting rows in the result set of SELECTs.

Return: number of rows, or 0

Overrides DB_common::numRows() (returns the number of rows in a result object)

Parameters:

$result $result — the odbc result resource

[ Top ]

odbcRaiseError [line 451]

void odbcRaiseError(
[mixed
$errno = null])

[ Top ]

rollback [line 440]

void rollback(
)

Overrides DB_common::rollback() (starts a rollback)

[ Top ]

simpleQuery [line 162]

int simpleQuery(
$query
$query)

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

Return: returns a valid ODBC result for successful SELECT queries, DB_OK for other successful queries. A DB error code is returned on failure.

Parameters:

$query $query — the SQL query

[ Top ]