Class: MDB2_Driver_fbsql

Source Location: /MDB2-2.0.0alpha1/MDB2/Driver/fbsql.php

Class Overview

PEAR
   |
   --MDB2_Driver_Common
      |
      --MDB2_Driver_fbsql

MDB2 FrontBase driver

Author(s):

Frank M. Kromann <mailto:frank at kromann.info>
Lukas Smith <mailto:smith at backendmedia.com>

Inherited Variables

Class: MDB2_Driver_Common

MDB2_Driver_Common::$auto_commit
MDB2_Driver_Common::$db_index
MDB2_Driver_Common::$debug_output
MDB2_Driver_Common::$last_query
MDB2_Driver_Common::$options
MDB2_Driver_Common::$supported

Inherited Methods

Class: MDB2_Driver_Common

MDB2_Driver_Common::MDB2_Driver_Common(): Constructor
MDB2_Driver_Common::affectedRows(): returns the affected rows of a query
MDB2_Driver_Common::autoCommit(): Define whether database changes done on the database be automatically committed. This function may also implicitly start or end 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::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::execute(): Execute a prepared query statement.
MDB2_Driver_Common::executeMultiple(): This function does several executeParams() calls on the same statement handle.
MDB2_Driver_Common::executeParams(): Executes a prepared SQL query
MDB2_Driver_Common::freePrepared(): Release resources allocated for the specified prepared query.
MDB2_Driver_Common::getAll(): Fetch all the rows returned from a query.
MDB2_Driver_Common::getCol(): Fetch a single column from a result set and return it as an indexed array.
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::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.
MDB2_Driver_Common::getOption(): returns the value of an option
MDB2_Driver_Common::getRow(): Fetch the first row of data returned from a query. Takes care of doing the query and freeing the results when finished.
MDB2_Driver_Common::getSequenceName(): adds sequence name formating to a sequence name
MDB2_Driver_Common::getValue(): Convert a text value into a DBMS specific format that is suitable to compose query statements.
MDB2_Driver_Common::getWarnings(): get all warnings in reverse order.
MDB2_Driver_Common::loadModule(): loads an 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::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::setParam(): Set the value of a parameter of a prepared query.
MDB2_Driver_Common::setParamArray(): Set the values of multiple a parameter of a prepared query in bulk.
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::toString(): String conversation

Class Details

[line 57]
MDB2 FrontBase driver

Author: Frank M. Kromann <mailto:frank@kromann.info>
Author: Lukas Smith <mailto:smith@backendmedia.com>

[ Top ]

Class Variables

$decimal_factor = 1.0

[line 61]

Type:

mixed

[ Top ]

$escape_quotes = "'"

[line 60]

Type:

mixed

[ Top ]

$max_text_length = 32768

[line 63]

Type:

mixed

[ Top ]

Method Detail

affectedRows [line 425]

mixed affectedRows(
)

returns the affected rows of a query

Return: MDB2 Error Object or number of rows
Access: public

Overrides MDB2_Driver_Common::affectedRows() (returns the affected rows of a query)

[ Top ]

autoCommit [line 151]

mixed autoCommit(
boolean
$auto_commit)

Define whether database changes done on the database be automatically committed. This function may also implicitly start or end a transaction.

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

Overrides MDB2_Driver_Common::autoCommit() (Define whether database changes done on the database be automatically committed. This function may also implicitly start or end a transaction.)

Parameters:

boolean $auto_commit — flag that indicates whether the database changes should be committed right after executing every query statement. If this argument is 0 a transaction implicitly started. Otherwise, if a transaction is in progress it is ended by committing any database changes that were pending.

[ Top ]

commit [line 193]

mixed 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.

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

true connect(
)

Connect to the database

Return: on success, MDB2 Error Object on failure

[ Top ]

currID [line 489]

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 ]

errorInfo [line 101]

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 ]

MDB2_fbsql [line 71]

void MDB2_fbsql(
)

Constructor

[ Top ]

nextID [line 448]

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 ]

query [line 358]

mixed &query(
string
$query, [mixed
$types = null], [mixed
$result_class = false])

Send a query to the database and return any results

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

Overrides MDB2_Driver_Common::query() (Send a query to the database and return any results)

Parameters:

string	`$query`	—	the SQL query
mixed	`$types`	—	string or array that contains the types of the columns in the result set
mixed	`$result_class`	—	string which specifies which result class to use

[ Top ]

rollback [line 220]

mixed 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.

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 ]