Class: MDB2_Driver_ibase

Source Location: /MDB2-2.0.0beta4/MDB2/Driver/ibase.php

Class Overview

PEAR
   |
   --MDB2_Driver_Common
      |
      --MDB2_Driver_ibase

MDB2 FireBird/InterBase driver

Author(s):

Lorenzo Alberton <l.alberton at quipo.it>

Inherited Variables

Class: MDB2_Driver_Common

MDB2_Driver_Common::$blobs
MDB2_Driver_Common::$clobs
MDB2_Driver_Common::$connected_database_name
MDB2_Driver_Common::$connected_dsn
MDB2_Driver_Common::$connection
MDB2_Driver_Common::$database_name
MDB2_Driver_Common::$dbsyntax
MDB2_Driver_Common::$db_index
MDB2_Driver_Common::$debug_output
MDB2_Driver_Common::$destructor_registered
MDB2_Driver_Common::$dsn
MDB2_Driver_Common::$fetchmode
MDB2_Driver_Common::$in_transaction
MDB2_Driver_Common::$last_query
MDB2_Driver_Common::$lobs
MDB2_Driver_Common::$modules
MDB2_Driver_Common::$opened_persistent
MDB2_Driver_Common::$options
MDB2_Driver_Common::$phptype
MDB2_Driver_Common::$row_limit
MDB2_Driver_Common::$row_offset
MDB2_Driver_Common::$supported
MDB2_Driver_Common::$warnings

Inherited Methods

Class: MDB2_Driver_Common

MDB2_Driver_Common::__construct(): Constructor
MDB2_Driver_Common::MDB2_Driver_Common(): PHP 4 Constructor
MDB2_Driver_Common::beginTransaction(): Start a transaction.
MDB2_Driver_Common::commit(): Commit the database changes done during a transaction that is in progress. This function may only be called when auto-committing is disabled, otherwise it will fail. Therefore, a new transaction is implicitly started after committing the pending changes.
MDB2_Driver_Common::compareDefinition(): Obtain an array of changes that may need to applied
MDB2_Driver_Common::currID(): returns the current id of a sequence
MDB2_Driver_Common::debug(): set a debug message
MDB2_Driver_Common::debugOutput(): output debug info
MDB2_Driver_Common::disconnect(): Log out and disconnect from the database.
MDB2_Driver_Common::errorInfo(): This method is used to collect information about an error
MDB2_Driver_Common::errorNative(): returns an errormessage, provides by the database
MDB2_Driver_Common::escape(): Quotes a string so it can be safely used in a query. It will quote the text so it can safely be used within a query.
MDB2_Driver_Common::getAfterID(): returns the autoincrement ID if supported or $id
MDB2_Driver_Common::getBeforeID(): returns the next free id of a sequence if the RDBMS does not support auto increment
MDB2_Driver_Common::getDatabase(): get the current database
MDB2_Driver_Common::getDeclaration(): Obtain DBMS specific SQL code portion needed to declare of the given type
MDB2_Driver_Common::getDSN(): return the DSN as a string
MDB2_Driver_Common::getOption(): returns the value of an option
MDB2_Driver_Common::getSequenceName(): adds sequence name formating to a sequence name
MDB2_Driver_Common::getWarnings(): get all warnings in reverse order.
MDB2_Driver_Common::loadModule(): loads a module
MDB2_Driver_Common::nextID(): returns the next free id of a sequence
MDB2_Driver_Common::prepare(): Prepares a query for multiple execution with execute().
MDB2_Driver_Common::query(): Send a query to the database and return any results
MDB2_Driver_Common::queryAll(): Execute the specified query, fetch all the rows of the result set into a two dimensional array and then frees the result set.
MDB2_Driver_Common::queryCol(): Execute the specified query, fetch the value from the first column of each row of the result set into an array and then frees the result set.
MDB2_Driver_Common::queryOne(): Execute the specified query, fetch the value from the first column of the first row of the result set and then frees the result set.
MDB2_Driver_Common::queryRow(): Execute the specified query, fetch the values from the first row of the result set into an array and then frees the result set.
MDB2_Driver_Common::quote(): Convert a text value into a DBMS specific format that is suitable to compose query statements.
MDB2_Driver_Common::quoteIdentifier(): Quote a string so it can be safely used as a table or column name
MDB2_Driver_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.
MDB2_Driver_Common::replace(): Execute a SQL REPLACE query. A REPLACE query is identical to a INSERT query, except that if there is already a row in the table with the same key field values, the REPLACE query just updates its values instead of inserting a new row.
MDB2_Driver_Common::resetWarnings(): reset the warning array
MDB2_Driver_Common::rollback(): Cancel any database changes done during a transaction that is in progress. This function may only be called when auto-committing is disabled, otherwise it will fail. Therefore, a new transaction is implicitly started after canceling the pending changes.
MDB2_Driver_Common::setDatabase(): Select a different database
MDB2_Driver_Common::setDSN(): set the DSN
MDB2_Driver_Common::setFetchMode(): Sets which fetch mode should be used by default on queries on this connection
MDB2_Driver_Common::setLimit(): set the range of the next query
MDB2_Driver_Common::setOption(): set the option for the db class
MDB2_Driver_Common::standaloneQuery(): execute a query as database administrator
MDB2_Driver_Common::subSelect(): simple subselect emulation: leaves the query untouched for all RDBMS that support subselects
MDB2_Driver_Common::supports(): Tell whether a DB implementation or its backend extension supports a given feature.
MDB2_Driver_Common::_convertEmptyArrayValuesToNull(): Convert all empty values in an array to null strings
MDB2_Driver_Common::_doQuery(): Execute a query
MDB2_Driver_Common::_modifyQuery(): Changes a query string for various DBMS specific reasons
MDB2_Driver_Common::_rtrimArrayValues(): Right trim all strings in an array
MDB2_Driver_Common::_wrapResult(): wrap a result set into the correct class
MDB2_Driver_Common::__call(): Calls a module method using the __call magic method
MDB2_Driver_Common::__destruct(): Destructor
MDB2_Driver_Common::__toString(): String conversation

Class Details

[line 55]
MDB2 FireBird/InterBase driver

Author: Lorenzo Alberton <l.alberton@quipo.it>

[ Top ]

Class Variables

$database_extension = ''

[line 63]

Type:

mixed

[ Top ]

$database_path = ''

[line 62]

Type:

mixed

[ Top ]

$escape_quotes = "'"

[line 58]

Type:	mixed
Overrides:	Array

[ Top ]

$query_parameters = array()

[line 65]

Type:

mixed

[ Top ]

$query_parameter_values = array()

[line 66]

Type:

mixed

[ Top ]

$transaction_id = 0

[line 60]

Type:

mixed

[ Top ]

Method Detail

__construct (Constructor) [line 74]

MDB2_Driver_ibase __construct(
)

Constructor

Overrides MDB2_Driver_Common::__construct() (Constructor)

[ Top ]

beginTransaction [line 221]

mixed beginTransaction(
)

Start a transaction.

Return: MDB2_OK on success, a MDB2 error on failure
Access: public

Overrides MDB2_Driver_Common::beginTransaction() (Start a transaction.)

[ Top ]

commit [line 251]

mixed commit(
)

Commit the database changes done during a transaction that is in progress.

Return: MDB2_OK on success, a MDB2 error on failure
Access: public

Overrides MDB2_Driver_Common::commit() (Commit the database changes done during a transaction that is in progress. This function may only be called when auto-committing is disabled, otherwise it will fail. Therefore, a new transaction is implicitly started after committing the pending changes.)

[ Top ]

connect [line 362]

true connect(
)

Connect to the database

Return: on success, MDB2 Error Object on failure
Access: public

[ Top ]

currID [line 623]

mixed currID(
string
$seq_name)

returns the current id of a sequence

Return: MDB2 Error Object or id
Access: public

Overrides MDB2_Driver_Common::currID() (returns the current id of a sequence)

Parameters:

string $seq_name — name of the sequence

[ Top ]

disconnect [line 403]

mixed disconnect(
[
$force = true])

Log out and disconnect from the database.

Return: true on success, false if not connected and error object on error
Access: public

Overrides MDB2_Driver_Common::disconnect() (Log out and disconnect from the database.)

Parameters:

$force —

[ Top ]

errorInfo [line 110]

array errorInfo(
[integer
$error = null])

This method is used to collect information about an error

Access: public

Overrides MDB2_Driver_Common::errorInfo() (This method is used to collect information about an error)

Parameters:

integer $error —

[ Top ]

nextID [line 585]

mixed nextID(
string
$seq_name, [boolean
$ondemand = true])

returns the next free id of a sequence

Return: MDB2 Error Object or id
Access: public

Overrides MDB2_Driver_Common::nextID() (returns the next free id of a sequence)

Parameters:

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

[ Top ]

prepare [line 501]

mixed &prepare(
string
$query, [mixed
$types = null], [mixed
$result_types = null])

Prepares a query for multiple execution with execute().

With some database backends, this is emulated. prepare() requires a generic query as string like 'INSERT INTO numbers VALUES(?,?)' or 'INSERT INTO numbers VALUES(:foo,:bar)'. The ? and :[a-zA-Z] and are placeholders which can be set using bindParam() and the query can be send off using the execute() method.

Return: resource handle for the prepared query on success, a MDB2 error on failure
See: bindParam, execute
Access: public

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

Parameters:

string	`$query`	—	the query to prepare
mixed	`$types`	—	array that contains the types of the placeholders
mixed	`$result_types`	—	array that contains the types of the columns in the result set

[ Top ]

rollback [line 277]

mixed rollback(
)

Cancel any database changes done during a transaction that is in progress.

Return: MDB2_OK on success, a MDB2 error on failure
Access: public

Overrides MDB2_Driver_Common::rollback() (Cancel any database changes done during a transaction that is in progress. This function may only be called when auto-committing is disabled, otherwise it will fail. Therefore, a new transaction is implicitly started after canceling the pending changes.)

[ Top ]

_doConnect [line 319]

mixed _doConnect(

$database_name, [
$persistent = false])

Does the grunt work of connecting to the database

Return: connection resource on success, MDB2 Error Object on failure
Access: protected

Parameters:

	`$database_name`	—
	`$persistent`	—

[ Top ]

_doQuery [line 426]

result _doQuery(
string
$query, [boolean
$isManip = false], [resource
$connection = null], [string
$database_name = null])

Execute a query

Return: or error object
Access: protected

Overrides MDB2_Driver_Common::_doQuery() (Execute a query)

Parameters:

string	`$query`	—	query
boolean	`$isManip`	—	if the query is a manipulation query
resource	`$connection`	—
string	`$database_name`	—

[ Top ]

_getDatabaseFile [line 302]

string _getDatabaseFile(

$database_name)

Builds the string with path+dbname+extension

Return: full database path+file
Access: protected

Parameters:

$database_name —

[ Top ]

_modifyQuery [line 471]

the _modifyQuery(
string
$query, 
$isManip, 
$limit, 
$offset)

Changes a query string for various DBMS specific reasons

Return: new (modified) query
Access: protected

Overrides MDB2_Driver_Common::_modifyQuery() (Changes a query string for various DBMS specific reasons)

Parameters:

string	`$query`	—	query to modify
	`$isManip`	—
	`$limit`	—
	`$offset`	—

[ Top ]