apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]

Class: DB_ifx

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

Class Overview

PEAR
   |
   --DB_common
      |
      --DB_ifx



Variables

Methods


Inherited Variables

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 35]


[ Top ]


Class Variables

$affected =  0

[line 40]


Type:   mixed


[ Top ]

$connection =

[line 39]


Type:   mixed


[ Top ]

$dsn = array()

[line 41]


Type:   mixed


[ Top ]

$fetchmode =  DB_FETCHMODE_ORDERED

[line 42]


Type:   mixed
Overrides:   Array


[ Top ]



Method Detail

DB_ifx (Constructor)   [line 47]

DB_ifx DB_ifx( )


[ Top ]

affectedRows   [line 178]

number affectedRows( )

Gets the number of rows affected by the last query.

if the last query was a select, returns an _estimate_ value.

  • Return: of rows affected by the last query

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

connect   [line 82]

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 109]

bool disconnect( )

Log out and disconnect from the database.
  • Return: TRUE on success, FALSE if not connected.

[ Top ]

errorCode   [line 312]

int errorCode( mixed $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. Requires that the DB implementation's constructor fills in the $errorcode_map property.)
[ Top ]

errorNative   [line 331]

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 ]

fetchInto   [line 218]

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

Fetch a row and return as array.
  • Return: an array on success, a DB error code on failure, NULL if there is no more data

Parameters:

$result   $result     Informix result identifier
$row   &$row     (reference) array where data from the row is stored
$fetchmode   $fetchmode     how the resulting array should be indexed
$rownum   $rownum     the row number to fetch

[ Top ]

fetchRow   [line 193]

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

Fetch and return a row of data (it uses fetchInto for that)
  • Return: a row of data, or false on error

Parameters:

$result   $result     Informix result identifier
$fetchmode   $fetchmode     format of fetched row array
$rownum   $rownum     the absolute row number to fetch

[ Top ]

freeResult   [line 272]

bool freeResult( $result $result)

Free the internal resources associated with $result.
  • Return: TRUE on success, DB_error on error

Parameters:

$result   $result     Informix result identifier

[ Top ]

getSpecialQuery   [line 344]

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 ]

ifxraiseError   [line 291]

void ifxraiseError( [mixed $errno = null])


[ Top ]

nextResult   [line 165]

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 255]

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 241]

void numRows( mixed $result)


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

simpleQuery   [line 128]

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 ]


Documentation generated on Fri, 30 Apr 2004 23:19:46 +0200 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.