Class: DB_oci8

Source Location: /DB-1.6.7/DB/oci8.php

Class Overview

PEAR
   |
   --DB_common
      |
      --DB_oci8

Database independent query interface definition for PHP's Oracle 8 call-interface extension.

Author(s):

James L. Pine <jlp at valinux.com>

Version:

$Id: oci8.php,v 1.67 2004/06/24 15:24:56 danielc Exp $

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

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 41]
Database independent query interface definition for PHP's Oracle 8 call-interface extension.

Definitely works with versions 8 and 9 of Oracle.

Author: James L. Pine <jlp@valinux.com>
Version: $Id: oci8.php,v 1.67 2004/06/24 15:24:56 danielc Exp $

mixed

[ Top ]

$phptype =

[line 46]

Type:	mixed
Overrides:	Array

[ Top ]

$prepare_types = array()

[line 48]

Type:	mixed
Overrides:	Array

[ Top ]

Method Detail

DB_oci8 (Constructor) [line 68]

DB_oci8 DB_oci8(
)

[ Top ]

affectedRows [line 566]

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 or DB_ERROR

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

[ Top ]

autoCommit [line 517]

void autoCommit(
[$onoff
$onoff = false])

Enable/disable automatic commits

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

Parameters:

$onoff $onoff — true/false whether to autocommit

[ Top ]

commit [line 531]

DB_ERROR commit(
)

Commit transactions on the current connection

Return: or DB_OK

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

[ Top ]

connect [line 110]

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

int createSequence(
string
$seq_name)

Creates a new sequence

Return: DB_OK on success. A DB_Error object is returned if problems arise.
See: DB_common::createSequence()
Access: public

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

Parameters:

string $seq_name — name of the new sequence

[ Top ]

disconnect [line 147]

bool disconnect(
)

Log out and disconnect from the database.

Return: true on success, false if not connected.

[ Top ]

dropSequence [line 724]

int dropSequence(
string
$seq_name)

Deletes a sequence

Return: DB_OK on success. DB_Error if problems.
See: DB_common::dropSequence()
Access: public

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

Parameters:

string $seq_name — name of the sequence to be deleted

[ Top ]

errorNative [line 350]

int errorNative(
)

Get the native error code of the last error (if any) that occured on the current connection. This does not work, as OCIError does not work unless given a statement. If OCIError does return something, so will this.

Return: native oci8 error code

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

[ Top ]

execute [line 450]

int &execute(
resource
$stmt, [mixed
$data = array()])

Executes a DB statement prepared with prepare().

Return: returns an oci8 result resource for successful SELECT queries, DB_OK for other successful queries. A DB error code is returned on failure.
See: DB_oci::prepare()

Overrides DB_common::execute() (Executes a DB statement prepared with prepare())

Parameters:

resource	`$stmt`	—	a DB statement resource returned from prepare()
mixed	`$data`	—	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 for non-array items or the quantity of elements in the array.

[ Top ]

freePrepared [line 277]

bool freePrepared(
$stmt
$stmt)

Free the internal resources associated with a prepared query.

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

Overrides DB_common::freePrepared() (Free the resource used in a prepared query)

Parameters:

$stmt $stmt — oci8 statement identifier

[ Top ]

freeResult [line 265]

bool freeResult(
$result
$result)

Free the internal resources associated with $result.

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

Parameters:

$result $result — oci8 result identifier

[ Top ]

getSpecialQuery [line 765]

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 ]

modifyLimitQuery [line 604]

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

Emulate the row limit support altering the query

Return: The modified query
Author: Tomas V.V.Cox <cox@idecnet.com>

Parameters:

string	`$query`	—	The query to treat
int	`$from`	—	The row to start to fetch from
int	`$count`	—	The offset
	`$params`	—

[ Top ]

modifyQuery [line 581]

void modifyQuery(

$query)

Parameters:

$query —

[ Top ]

nextId [line 666]

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

Returns the next free id in a sequence

Return: the next id number in the sequence. DB_Error if problem.
See: DB_common::nextID()
Access: public

Overrides DB_common::nextId() (Returns the next free id in a sequence)

Parameters:

string	`$seq_name`	—	name of the sequence
boolean	`$ondemand`	—	when true, the seqence is automatically created if it does not exist

[ Top ]

nextResult [line 202]

true nextResult(
a
$result)

Move the internal oracle result pointer to the next available result

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

Parameters:

a $result — valid oci8 result resource

[ Top ]

numCols [line 330]

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 — oci8 result identifier

[ Top ]

numRows [line 291]

void numRows(

$result)

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

Parameters:

$result —

[ Top ]

oci8RaiseError [line 743]

object DB oci8RaiseError(
[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_common::errorCode()

Parameters:

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

[ Top ]

prepare [line 390]

mixed prepare(
string
$query)

Prepares a query for multiple execution with execute().

With oci8, this is emulated.

prepare() requires a generic query as string like

    INSERT INTO numbers VALUES (?, ?, ?)

. The ? characters are placeholders.

Three types of placeholders can be used:

? a quoted scalar value, i.e. strings, integers
! value is inserted 'as is'
& requires a file name. The file's contents get inserted into the query (i.e. saving binary data in a db)

Use backslashes to escape placeholder characters if you don't want them to be interpreted as placeholders. Example:

    "UPDATE foo SET col=? WHERE col='over \& under'"

Return: DB statement resource on success. DB_Error on failure.

Overrides DB_common::prepare() (Prepares a query for multiple execution with execute())

Parameters:

string $query — query to be prepared

[ Top ]

rollback [line 548]

DB_ERROR rollback(
)

Roll back all uncommitted transactions on the current connection.

Return: or DB_OK

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

[ Top ]

simpleQuery [line 167]

int simpleQuery(
$query
$query)

Send a query to oracle and return the results as an oci8 resource identifier.

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

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

Returns information about a table or a result set.

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

NOTE: flags won't contain index information.

Return: an associative array with the information requested or an error object if something is wrong
See: DB_common::tableInfo()
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 ]