Class: MDB2_Driver_Common
Source Location: /MDB2-2.0.1/MDB2.php
PEAR
|
--MDB2_Driver_Common
MDB2_Driver_Common: Base class that is extended by each MDB2 driver
Author(s):
|
|
|
Child classes:
|
Inherited Variables
|
Inherited Methods
|
Class Details
Class Variables
$connected_database_name = ''
[line 968]
the name of the database currrently selected
$connected_dsn = array()
[line 940]
DSN that was used to create the current connection
$connected_server_info = ''
[line 975]
server version information
$connection = 0
[line 947]
connection resource
$database_name = ''
[line 961]
the name of the database for the next query
$dbsyntax =
[line 1109]
Database used with regards to SQL syntax etc.
$db_index = 0
[line 926]
index of the MDB2 object within the $GLOBALS['_MDB2_databases'] array
$debug_output = ''
[line 1074]
string with the debugging information
$destructor_registered = true
[line 1137]
determines of the PHP4 destructor emulation has been enabled yet
$dsn = array()
[line 933]
DSN used for the next query
$escape_quotes = ''
[line 1060]
escape character
$fetchmode = MDB2_FETCHMODE_ORDERED
[line 1123]
the default fetchmode used
$in_transaction = false
[line 1081]
determine if there is an open transaction
$last_query =
[line 1116]
the last query sent to the driver
$limit = 0
[line 1095]
result limit used in the next query
$modules = array()
[line 1130]
array of module instances
$offset = 0
[line 1088]
result offset used in the next query
$opened_persistent =
[line 954]
if the current opened connection is a persistent connection
$options = array(
'ssl' => false,
'field_case' => CASE_LOWER,
'disable_query' => false,
'result_class' => 'MDB2_Result_%s',
'buffered_result_class' => 'MDB2_BufferedResult_%s',
'result_wrap_class' => false,
'result_buffering' => true,
'fetch_class' => 'stdClass',
'persistent' => false,
'debug' => 0,
'debug_handler' => 'MDB2_defaultDebugOutput',
'lob_buffer_length' => 8192,
'log_line_break' => "\n",
'idxname_format' => '%s_idx',
'seqname_format' => '%s_seq',
'seqcol_name' => 'sequence',
'quote_identifier' => false,
'use_transactions' => false,
'decimal_places' => 2,
'portability' => MDB2_PORTABILITY_ALL,
'modules' => array(
'ex' => 'Extended',
'dt' => 'Datatype',
'mg' => 'Manager',
'rv' => 'Reverse',
'na' => 'Native',
'fc' => 'Function',
),)
[line 1024]
$options['ssl'] -> determines if ssl should be used for connections $options['field_case'] -> determines what case to force on field/table names $options['disable_query'] -> determines if querys should be executed $options['result_class'] -> class used for result sets $options['buffered_result_class'] -> class used for buffered result sets $options['result_wrap_class'] -> class used to wrap result sets into $options['result_buffering'] -> boolean should results be buffered or not? $options['fetch_class'] -> class to use when fetch mode object is used $options['persistent'] -> boolean persistent connection? $options['debug'] -> integer numeric debug level $options['debug_handler'] -> string function/meothd that captures debug messages $options['lob_buffer_length'] -> integer LOB buffer length $options['log_line_break'] -> string line-break format $options['idxname_format'] -> string pattern for index name $options['seqname_format'] -> string pattern for sequence name $options['seqcol_name'] -> string sequence column name $options['quote_identifier'] -> if identifier quoting should be done when check_option is used $options['use_transactions'] -> boolean $options['decimal_places'] -> integer $options['portability'] -> portability constant $options['modules'] -> short to long module name mapping for __call()
$phptype =
[line 1102]
Database backend used in PHP (mysql, odbc etc.)
$supported = array(
'sequences' => false,
'indexes' => false,
'affected_rows' => false,
'summary_functions' => false,
'order_by_text' => false,
'transactions' => false,
'current_id' => false,
'limit_queries' => false,
'LOBs' => false,
'replace' => false,
'sub_selects' => false,
'auto_increment' => false,
'primary_key' => false,
'result_introspection' => false,
)
[line 982]
list of all supported features of the given driver
$warnings = array()
[line 1067]
warnings
Method Detail
MDB2_Driver_Common (Constructor) [line 1159]
MDB2_Driver_Common MDB2_Driver_Common(
)
|
|
PHP 4 Constructor
beginTransaction [line 1705]
mixed beginTransaction(
)
|
|
Start a transaction.
Overridden in child classes as:
- MDB2_xxx::beginTransaction()
- Define whether database changes done on the database be automatically committed. This function may also implicitly start or end a transaction.
commit [line 1724]
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.
Overridden in child classes as:
- MDB2_xxx::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.
compareDefinition [line 2509]
array compareDefinition(
array
$current, array
$previous)
|
|
Obtain an array of changes that may need to applied
Parameters:
currID [line 2617]
mixed currID(
string
$seq_name)
|
|
returns the current id of a sequence
Overridden in child classes as:
- MDB2_xxx::currID()
- returns the current id of a sequence
Parameters:
debug [line 1400]
void debug(
string
$message, [mixed
$scope = ''], [mixed
$is_manip = null])
|
|
set a debug message
Parameters:
disconnect [line 1776]
mixed disconnect(
[boolean
$force = true])
|
|
Log out and disconnect from the database.
Overridden in child classes as:
- MDB2_xxx::disconnect()
- Log out and disconnect from the database.
Parameters:
errorInfo [line 1221]
array errorInfo(
[integer
$error = null])
|
|
This method is used to collect information about an error
Overridden in child classes as:
- MDB2_xxx::errorInfo()
- This method is used to collect information about an error
Parameters:
escape [line 1432]
string escape(
string
$text)
|
|
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.
Parameters:
exec [line 1979]
mixed exec(
string
$query)
|
|
Execute a manipulation query to the database and return any the affected rows
Parameters:
free [line 1185]
Free the internal references so that the instance can be destroyed
getConnection [line 1498]
Returns a native connection
getDatabase [line 1813]
getDebugOutput [line 1416]
getDeclaration [line 2489]
string getDeclaration(
string
$type, string
$name, string
$field)
|
|
Obtain DBMS specific SQL code portion needed to declare of the given type
Parameters:
getDSN [line 1851]
mixed getDSN(
[string
$type = 'string'], [string
$hidepw = false])
|
|
return the DSN as a string
Parameters:
getIndexName [line 2565]
string getIndexName(
string
$idx)
|
|
adds index name formatting to a index name
Parameters:
getOption [line 1382]
mixed getOption(
string
$option)
|
|
returns the value of an option
Parameters:
getSequenceName [line 2549]
string getSequenceName(
string
$sqn)
|
|
adds sequence name formatting to a sequence name
Parameters:
getServerVersion [line 2119]
mixed getServerVersion(
[string
$native = false])
|
|
return version information about the server
Parameters:
getWarnings [line 1308]
get all warnings in reverse order. This means that the last warning is the first element in the array
inTransaction [line 1759]
If a transaction is currently open.
lastInsertID [line 2601]
mixed lastInsertID(
[string
$table = null], [mixed
$field = null], mixed
$id)
|
|
returns the autoincrement ID if supported or $id
Parameters:
loadModule [line 1601]
object on &loadModule(
string
$module, [string
$property = null], [boolean
$phptype_specific = null])
|
|
loads a module
Parameters:
nextID [line 2584]
mixed nextID(
string
$seq_name, [boolean
$ondemand = true])
|
|
returns the next free id of a sequence
Overridden in child classes as:
- MDB2_xxx::nextID()
- returns the next free id of a sequence
Parameters:
prepare [line 2359]
mixed &prepare(
string
$query, [mixed
$types = null], [mixed
$result_types = null], [mixed
$lobs = array()])
|
|
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.
Parameters:
query [line 2013]
object a &query(
string
$query, [mixed
$types = null], [mixed
$result_class = true], [mixed
$result_wrap_class = false])
|
|
Send a query to the database and return any results
Overridden in child classes as:
- MDB2_xxx::query()
- Send a query to the database and return any results
Parameters:
queryAll [line 2733]
mixed queryAll(
string
$query, [array
$types = null], [int
$fetchmode = MDB2_FETCHMODE_DEFAULT], [boolean
$rekey = false], [boolean
$force_array = false], [boolean
$group = false])
|
|
Execute the specified query, fetch all the rows of the result set into a two dimensional array and then frees the result set.
Parameters:
queryCol [line 2696]
mixed queryCol(
string
$query, [string
$type = null], [int
$colnum = 0])
|
|
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.
Parameters:
queryOne [line 2639]
mixed queryOne(
string
$query, [string
$type = null])
|
|
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.
Parameters:
queryRow [line 2668]
mixed queryRow(
string
$query, [array
$types = null], [int
$fetchmode = MDB2_FETCHMODE_DEFAULT])
|
|
Execute the specified query, fetch the values from the first row of the result set into an array and then frees the result set.
Parameters:
quote [line 2466]
string quote(
string
$value, [string
$type = null], [mixed
$quote = true])
|
|
Convert a text value into a DBMS specific format that is suitable to compose query statements.
Parameters:
quoteIdentifier [line 1480]
string quoteIdentifier(
string
$str, [bool
$check_option = false])
|
|
Quote a string so it can be safely used as a table or column name Delimiting style depends on which database driver is being used. NOTE: just because you CAN use delimited identifiers doesn't mean you SHOULD use them. In general, they end up causing way more problems than they solve. Portability is broken by using the following characters inside delimited identifiers: - backtick (`) -- due to MySQL
- double quote (") -- due to Oracle
- brackets ([ or ]) -- due to Access
Delimited identifiers are known to generally work correctly under the following drivers: - mssql
- mysql
- mysqli
- oci8
- odbc(access)
- odbc(db2)
- pgsql
- sqlite
- sybase
InterBase doesn't seem to be able to use delimited identifiers via PHP 4. They work fine under PHP 5.
Parameters:
raiseError [line 1254]
object a &raiseError(
[mixed
$code = null], [int
$mode = null], [mixed
$options = null], [string
$userinfo = null])
|
|
This method is used to communicate an error and invoke error callbacks etc. Basically a wrapper for PEAR::raiseError without the message string.
Parameters:
replace [line 2263]
mixed replace(
string
$table, array
$fields)
|
|
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. The REPLACE type of query does not make part of the SQL standards. Since pratically only MySQL implements it natively, this type of query is emulated through this method for other DBMS using standard types of queries inside a transaction to assure the atomicity of the operation.
Overridden in child classes as:
- MDB2_xxx::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.
Parameters:
resetWarnings [line 1292]
rollback [line 1743]
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.
Overridden in child classes as:
- MDB2_xxx::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.
setDatabase [line 1797]
string setDatabase(
string
$name)
|
|
Select a different database
Parameters:
setDSN [line 1828]
MDB2_OK setDSN(
mixed
$dsn)
|
|
set the DSN
Parameters:
setFetchMode [line 1334]
mixed setFetchMode(
integer
$fetchmode, [string
$object_class = 'stdClass'])
|
|
Sets which fetch mode should be used by default on queries on this connection
Parameters:
setLimit [line 2136]
mixed setLimit(
string
$limit, [string
$offset = null])
|
|
set the range of the next query
Parameters:
setOption [line 1362]
mixed setOption(
string
$option, mixed
$value)
|
|
set the option for the db class
Parameters:
standaloneQuery [line 1889]
mixed &standaloneQuery(
string
$query, [mixed
$types = null], [boolean
$is_manip = false])
|
|
execute a query as database administrator
Parameters:
subSelect [line 2174]
string subSelect(
string
$query, [string
$type = false])
|
|
simple subselect emulation: leaves the query untouched for all RDBMS that support subselects
Overridden in child classes as:
- MDB2_xxx::subSelect()
- simple subselect emulation for Mysql
Parameters:
supports [line 2530]
boolean|string supports(
string
$feature)
|
|
Tell whether a DB implementation or its backend extension supports a given feature.
Parameters:
_doQuery [line 1944]
result _doQuery(
string
$query, [boolean
$is_manip = false], [resource
$connection = null], [string
$database_name = null])
|
|
Execute a query
Parameters:
_fixResultArrayValues [line 1518]
void _fixResultArrayValues(
array
&$array, array
$mode)
|
|
Do all necessary conversions on result arrays to fix DBMS quirks
Parameters:
_modifyQuery [line 1927]
string _modifyQuery(
string
$query, boolean
$is_manip, integer
$limit, integer
$offset)
|
|
Changes a query string for various DBMS specific reasons
Parameters:
_wrapResult [line 2050]
mixed &_wrapResult(
ressource
$result, [mixed
$types = array()], [mixed
$result_class = true], [mixed
$result_wrap_class = false], [string
$limit = null], [string
$offset = null])
|
|
wrap a result set into the correct class
Parameters:
__toString [line 1201]
Documentation generated on Sun, 16 Apr 2006 08:33:12 -0400 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.
|
|