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

Class: DB_ibase

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

Class Overview

PEAR
   |
   --DB_common
      |
      --DB_ibase



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


[ Top ]


Class Variables

$autocommit =  1

[line 34]


Type:   mixed


[ Top ]

$connection =

[line 32]


Type:   mixed


[ Top ]

$dbsyntax =

[line 33]


Type:   mixed


[ Top ]

$manip_query = array()

[line 35]


Type:   mixed


[ Top ]

$phptype =

[line 33]


Type:   mixed


[ Top ]



Method Detail

DB_ibase (Constructor)   [line 40]

DB_ibase DB_ibase( )


[ Top ]

autoCommit   [line 293]

void autoCommit( [mixed $onoff = false])


Overrides DB_common::autoCommit() (enable automatic Commit)
[ Top ]

commit   [line 302]

void commit( )


Overrides DB_common::commit() (starts a Commit)
[ Top ]

connect   [line 82]

void connect( mixed $dsninfo, [mixed $persistent = false])


[ Top ]

createSequence   [line 373]

mixed createSequence( string $seq_name)

Create the sequence
  • Return: DB_OK on success or DB error on error
  • Access: public

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

Parameters:

string   $seq_name     the name of the sequence

[ Top ]

disconnect   [line 127]

void disconnect( )


[ Top ]

dropSequence   [line 393]

mixed dropSequence( string $seq_name)

Drop a sequence
  • Return: DB_OK on success or DB error on error
  • Access: public

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

Parameters:

string   $seq_name     the name of the sequence

[ Top ]

execute   [line 278]

void execute( mixed $stmt, [mixed $data = false])


Overrides DB_common::execute() (Executes a prepared SQL query)
[ Top ]

fetchInto   [line 203]

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


[ Top ]

freeQuery   [line 245]

void freeQuery( mixed $query)


[ Top ]

freeResult   [line 229]

void freeResult( mixed $result)


[ Top ]

getSpecialQuery   [line 585]

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 ]

ibaseRaiseError   [line 598]

void ibaseRaiseError( [mixed $errno = null], [mixed $errmsg = null])


[ Top ]

nextId   [line 336]

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

Get the next value in a sequence.

If the sequence does not exist, it will be created, unless $ondemand is false.

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

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

Parameters:

string   $seq_name     the name of the sequence
bool   $ondemand     whether to create the sequence on demand

[ Top ]

nextResult   [line 195]

true nextResult( a $result)

Move the internal ibase 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 254]

void numCols( mixed $result)


[ Top ]

prepare   [line 266]

void prepare( mixed $query)


Overrides DB_common::prepare() (Prepares a query for multiple execution with execute().)
[ Top ]

rollback   [line 310]

void rollback( mixed $trans_number)


Overrides DB_common::rollback() (starts a rollback)
[ Top ]

simpleQuery   [line 137]

void simpleQuery( mixed $query)


[ Top ]

tableInfo   [line 479]

array tableInfo( mixed $result, [int $mode = null], mixed $resource)

Returns information about a table or a result set

NOTE: doesn't support 'flags'and 'table' if called from a db_result

  • Return: An array with all the information

Overrides DB_common::tableInfo() (returns meta data about the result set)

Parameters:

mixed   $resource     Interbase result identifier or table name
int   $mode     A valid tableInfo mode (DB_TABLEINFO_ORDERTABLE or DB_TABLEINFO_ORDER)

[ Top ]

transactionInit   [line 318]

void transactionInit( [mixed $trans_args = 0])


[ Top ]


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