Class: DB_ifx

Source Location: /DB-1.6.2/DB/ifx.php

Class Overview

PEAR
   |
   --DB_common
      |
      --DB_ifx

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

Author(s):

Tomas V.V.Cox <cox at idecnet.com>

Version:

$Id: ifx.php,v 1.47 2004/03/05 01:46:53 danielc Exp $

Variables

Methods

Inherited Variables

Class: 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::$phptype
DB_common::$prepared_queries
DB_common::$prepare_maxstmt
DB_common::$prepare_tokens
DB_common::$prepare_types

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(): Automaticaly generate an insert or update query and call prepare() and execute() with it
DB_common::autoPrepare(): Automaticaly generate an insert or update query and pass it to prepare()
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
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::escapeSimple(): Escape a string according to the current DBMS's standards
DB_common::execute(): Executes a DB statement prepared with prepare()
DB_common::executeMultiple(): This function does several execute() calls on the same statement handle
DB_common::freePrepared(): Free the resource used in a prepared query
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
DB_common::getOption(): Returns the value of an option
DB_common::getRow(): Fetch the first row of data returned from a query
DB_common::getSpecialQuery(): Returns the query needed to get some backend info
DB_common::getTables()
DB_common::limitQuery(): Generates a limited query
DB_common::nextId(): Returns the next free id in 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(): DEPRECATED: Quotes a string so it can be safely used in a query
DB_common::quoteIdentifier(): Quote a string so it can be safely used as a table or column name
DB_common::quoteSmart(): Format input so it can be safely used in a query
DB_common::quoteString(): DEPRECATED: Quotes a string so it can be safely used within string delimiters in a query
DB_common::raiseError(): Communicate an error and invoke error callbacks, etc
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 run-time configuration options for PEAR DB
DB_common::tableInfo(): Returns information about a table or a result set

Class Details

[line 43]
Database independent query interface definition for PHP's Informix extension.

Author: Tomas V.V.Cox <cox@idecnet.com>
Version: $Id: ifx.php,v 1.47 2004/03/05 01:46:53 danielc Exp $

[ Top ]

Class Variables

$affected = 0

[line 48]

Type:

mixed

[ Top ]

$autocommit = true

[line 51]

Type:

mixed

[ Top ]

$connection =

[line 47]

Type:

mixed

[ Top ]

$dsn = array()

[line 49]

Type:

mixed

[ Top ]

$fetchmode = DB_FETCHMODE_ORDERED

[line 52]

Type:	mixed
Overrides:	Array

[ Top ]

$transaction_opcount = 0

[line 50]

Type:

mixed

[ Top ]

Method Detail

DB_ifx (Constructor) [line 57]

DB_ifx DB_ifx(
)

[ Top ]

affectedRows [line 219]

number affectedRows(
)

Gets the number of rows affected by the last query.

if the last query was a select, returns 0.

Return: of rows affected by the last query

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

[ Top ]

autoCommit [line 336]

void autoCommit(
[
$onoff = true])

Enable/disable automatic commits

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

Parameters:

$onoff —

[ Top ]

commit [line 350]

void commit(
)

Commit the current transaction.

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

[ Top ]

connect [line 104]

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 ]

disconnect [line 134]

bool disconnect(
)

Log out and disconnect from the database.

Return: true on success, false if not connected.

[ Top ]

errorCode [line 417]

int errorCode(
string
$nativecode)

Map native error codes to DB's portable ones.

Requires that the DB implementation's constructor fills in the $errorcode_map property.

Return: a portable DB error code, or DB_ERROR if this DB implementation has no mapping for the given error code.

Overrides DB_common::errorCode() (Map native error codes to DB's portable ones)

Parameters:

string $nativecode — error code returned by the database

[ Top ]

errorNative [line 437]

int errorNative(
)

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

Return: native Informix error code

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

[ Top ]

freeResult [line 325]

bool freeResult(
$result
$result)

Free the internal resources associated with $result.

Return: true on success, false if $result is invalid

Parameters:

$result $result — Informix result identifier

[ Top ]

getSpecialQuery [line 450]

string getSpecialQuery(
string
$type)

Returns the query needed to get some backend info

Return: The SQL query string

Overrides DB_common::getSpecialQuery() (Returns the query needed to get some backend info)

Parameters:

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

[ Top ]

ifxraiseError [line 394]

object DB ifxraiseError(
[integer
$errno = null])

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

Return: error object
See: DB_common::raiseError()
See: DB_ifx::errorCode()
See: DB_ifx::errorNative()

Parameters:

integer $errno — PEAR error number (usually a DB constant) if manually raising an error

[ Top ]

nextResult [line 205]

true nextResult(
a
$result)

Move the internal ifx 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 307]

int numCols(
$result
$result)

Get the number of columns in a result set.

Return: the number of columns per row in $result

Parameters:

$result $result — Informix result identifier

[ Top ]

numRows [line 292]

void numRows(

$result)

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

Parameters:

$result —

[ Top ]

rollback [line 368]

void rollback(
)

Roll back (undo) the current transaction.

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

[ Top ]

simpleQuery [line 154]

int simpleQuery(
$query
$query)

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

Return: returns a valid Informix 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 ]

tableInfo [line 482]

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

Returns information about a table or a result set.

NOTE: only supports 'table' if $result is a table name.

If analyzing a query result and the result has duplicate field names, an error will be raised saying can't distinguish duplicate field names.

Return: an associative array with the information requested or an error object if something is wrong
See: DB_common::tableInfo()
Since: 1.6.0
Access: public

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

Parameters:

object\|string	`$result`	—	DB_result object from a query or a string containing the name of a table
int	`$mode`	—	a valid tableInfo mode

[ Top ]