Class: ADODB_odbtp

Source Location: /includes/classes/adodb/drivers/adodb-odbtp.inc.php

Class Overview

ADOConnection
   |
   --ADODB_odbtp

Connection object. For connecting to databases, and executing queries.

Child classes:

ADODB_odbtp_unicode: Connection object. For connecting to databases, and executing queries.

Inherited Variables

Class: ADOConnection

ADOConnection::$ansiOuter
ADOConnection::$arrayClass
ADOConnection::$autoCommit
ADOConnection::$autoRollback
ADOConnection::$blobEncodeType
ADOConnection::$cacheSecs
ADOConnection::$charSet
ADOConnection::$concat_operator
ADOConnection::$database
ADOConnection::$debug
ADOConnection::$emptyDate
ADOConnection::$emptyTimeStamp
ADOConnection::$false
ADOConnection::$fetchMode
ADOConnection::$fnCacheExecute
ADOConnection::$fnExecute
ADOConnection::$genID
ADOConnection::$hasLimit
ADOConnection::$hasTop
ADOConnection::$hasTransactions
ADOConnection::$host
ADOConnection::$isoDates
ADOConnection::$lastInsID
ADOConnection::$leftOuter
ADOConnection::$length
ADOConnection::$maxblobsize
ADOConnection::$memCache
ADOConnection::$memCacheCompress
ADOConnection::$memCacheHost
ADOConnection::$memCachePort
ADOConnection::$metaDatabasesSQL
ADOConnection::$metaTablesSQL
ADOConnection::$nameQuote
ADOConnection::$noNullStrings
ADOConnection::$null2null
ADOConnection::$numCacheHits
ADOConnection::$numCacheMisses
ADOConnection::$pageExecuteCountRows
ADOConnection::$password
ADOConnection::$poorAffectedRows
ADOConnection::$raiseErrorFn
ADOConnection::$random
ADOConnection::$readOnly
ADOConnection::$rightOuter
ADOConnection::$rsPrefix
ADOConnection::$substr
ADOConnection::$sysDate
ADOConnection::$sysTimeStamp
ADOConnection::$transCnt
ADOConnection::$transOff
ADOConnection::$true
ADOConnection::$uniqueOrderBy
ADOConnection::$uniqueSort
ADOConnection::$upperCase
ADOConnection::$user
ADOConnection::$_affected
ADOConnection::$_connectionID
ADOConnection::$_errorCode
ADOConnection::$_errorMsg
ADOConnection::$_evalAll
ADOConnection::$_isPersistentConnection
ADOConnection::$_logsql
ADOConnection::$_oldRaiseFn
ADOConnection::$_queryID
ADOConnection::$_transmode
ADOConnection::$_transOK

Inherited Methods

Class: ADOConnection

ADOConnection::ADOConnection(): Constructor
ADOConnection::addq(): Quotes a string, without prefixing nor appending quotes.
ADOConnection::Affected_Rows()
ADOConnection::AutoExecute()
ADOConnection::BeginTrans(): Begin a Transaction. Must be followed by CommitTrans() or RollbackTrans().
ADOConnection::BindDate()
ADOConnection::BindTimeStamp()
ADOConnection::BlobDecode()
ADOConnection::BlobEncode()
ADOConnection::CacheExecute(): Execute SQL, caching recordsets.
ADOConnection::CacheFlush(): Flush cached recordsets that match a particular $sql statement.
ADOConnection::CacheGetAll()
ADOConnection::CacheGetArray()
ADOConnection::CacheGetAssoc()
ADOConnection::CacheGetCol()
ADOConnection::CacheGetOne()
ADOConnection::CacheGetRow()
ADOConnection::CachePageExecute(): Will select the supplied $page number from a recordset, given that it is paginated in pages of $nrows rows per page. It also saves two boolean values saying if the given page is the first and/or last one of the recordset. Added by Iv�n Oliva to provide recordset pagination.
ADOConnection::CacheSelectLimit(): Will select, getting rows from $offset (1-based), for $nrows.
ADOConnection::Close(): Close Connection
ADOConnection::CommitLock()
ADOConnection::CommitTrans(): If database does not support transactions, always return true as data always commited
ADOConnection::CompleteTrans()
ADOConnection::Concat(): Different SQL databases used different methods to combine strings together.
ADOConnection::Connect(): Connect to database
ADOConnection::CreateSequence()
ADOConnection::DBDate(): Converts a date "d" to a string that the database can understand.
ADOConnection::DBTimeStamp(): Converts a timestamp "ts" to a string that the database can understand.
ADOConnection::Disconnect(): PEAR DB Compat - do not use internally
ADOConnection::DropSequence()
ADOConnection::ErrorMsg()
ADOConnection::ErrorNative(): PEAR DB Compat - do not use internally.
ADOConnection::ErrorNo()
ADOConnection::escape()
ADOConnection::Execute(): Execute SQL
ADOConnection::FailTrans()
ADOConnection::GenID(): Generates a sequence id and stores it in $this->genID; GenID is only available if $this->hasGenID = true;
ADOConnection::GetActiveRecords()
ADOConnection::GetActiveRecordsClass()
ADOConnection::GetAll()
ADOConnection::GetArray()
ADOConnection::GetAssoc()
ADOConnection::GetCharSet()
ADOConnection::GetCol()
ADOConnection::GetInsertSQL(): Generates an Insert Query based on an existing recordset.
ADOConnection::GetOne(): Return first element of first row of sql statement. Recordset is disposed for you.
ADOConnection::GetRandRow()
ADOConnection::GetRow(): Return one row of sql statement. Recordset is disposed for you.
ADOConnection::GetUpdateSQL(): Generates an Update Query based on an existing recordset.
ADOConnection::HasFailedTrans()
ADOConnection::IfNull()
ADOConnection::IgnoreErrors()
ADOConnection::InParameter()
ADOConnection::Insert_ID()
ADOConnection::IsConnected()
ADOConnection::LimitQuery(): PEAR DB Compat - do not use internally
ADOConnection::LogSQL()
ADOConnection::MetaColumnNames(): List columns names in a table as an array.
ADOConnection::MetaColumns(): List columns in a database as an array of ADOFieldObjects.
ADOConnection::MetaDatabases(): return the databases that the driver can connect to.
ADOConnection::MetaError()
ADOConnection::MetaErrorMsg()
ADOConnection::MetaForeignKeys()
ADOConnection::MetaIndexes(): List indexes on a table as an array.
ADOConnection::MetaPrimaryKeys()
ADOConnection::MetaTables()
ADOConnection::MetaTransaction()
ADOConnection::MetaType()
ADOConnection::NConnect(): Always force a new connection to database - currently only works with oracle
ADOConnection::nextId(): PEAR DB Compat - do not use internally.
ADOConnection::OffsetDate()
ADOConnection::outp(): All error messages go through this bottleneck function.
ADOConnection::OutParameter()
ADOConnection::PageExecute(): Will select the supplied $page number from a recordset, given that it is paginated in pages of $nrows rows per page. It also saves two boolean values saying if the given page is the first and/or last one of the recordset. Added by Iv�n Oliva to provide recordset pagination.
ADOConnection::Param()
ADOConnection::Parameter()
ADOConnection::PConnect(): Establish persistent connect to database
ADOConnection::PO_Insert_ID(): Portable Insert ID. Pablo Roca <pabloroca#mvps.org>
ADOConnection::Prepare(): Should prepare the sql statement and return the stmt resource.
ADOConnection::PrepareSP(): Some databases, eg. mssql require a different function for preparing stored procedures. So we cannot use Prepare().
ADOConnection::q()
ADOConnection::QMagic()
ADOConnection::qstr(): Correctly quotes a string so that all strings are escaped. We prefix and append to the string single-quotes.
ADOConnection::Query(): PEAR DB Compat - do not use internally.
ADOConnection::Quote(): PEAR DB Compat
ADOConnection::Replace(): Insert or replace a single record. Note: this is not the same as MySQL's replace.
ADOConnection::RollbackLock()
ADOConnection::RollbackTrans(): If database does not support transactions, rollbacks always fail, so return false
ADOConnection::RowLock(): Lock a row, will escalate and lock the table if row locking not supported will normally free the lock at the end of the transaction
ADOConnection::SelectDB(): Choose a database to connect to. Many databases do not support this.
ADOConnection::SelectLimit(): Will select, getting rows from $offset (1-based), for $nrows.
ADOConnection::SerializableRS(): Create serializable recordset. Breaks rs link to connection.
ADOConnection::ServerInfo()
ADOConnection::SetCharSet()
ADOConnection::SetDateLocale(): Change the SQL connection locale to a specified locale.
ADOConnection::SetFetchMode(): PEAR DB Compat - do not use internally.
ADOConnection::SetTransactionMode()
ADOConnection::SQLDate()
ADOConnection::StartTrans()
ADOConnection::Time()
ADOConnection::Transpose()
ADOConnection::UnixDate(): Also in ADORecordSet.
ADOConnection::UnixTimeStamp(): Also in ADORecordSet.
ADOConnection::UpdateBlob(): Update a blob column, given a where clause. There are more sophisticated blob handling functions that we could have implemented, but all require a very complex API. Instead we have chosen something that is extremely simple to understand and use.
ADOConnection::UpdateBlobFile(): Usage: UpdateBlob('TABLE', 'COLUMN', '/path/to/file', 'ID=1');
ADOConnection::UpdateClob(): Usage: UpdateClob('TABLE', 'COLUMN', $var, 'ID=1', 'CLOB');
ADOConnection::UserDate(): Also in ADORecordSet.
ADOConnection::UserTimeStamp()
ADOConnection::Version()
ADOConnection::xCacheFlush()
ADOConnection::_dirFlush(): Private function to erase all of the files and subdirectories in a directory.
ADOConnection::_Execute()
ADOConnection::_findschema()
ADOConnection::_findvers()
ADOConnection::_gencachename(): Private function to generate filename for caching.
ADOConnection::_nconnect()
ADOConnection::_rs2rs(): Convert database recordset to an array recordset input recordset's cursor should be at beginning, and old $rs will be closed.

Class Details

[line 17]
Connection object. For connecting to databases, and executing queries.

[ Top ]

Class Variables

$databaseType = "odbtp"

[line 18]

Type:	mixed
Overrides:	Array

[ Top ]

$dataProvider = "odbtp"

[line 19]

Type:	mixed
Overrides:	Array

[ Top ]

$fmtDate = "'Y-m-d'"

[line 20]

Type:	mixed
Overrides:	Array

[ Top ]

$fmtTimeStamp = "'Y-m-d, h:i:sA'"

[line 21]

Type:	mixed
Overrides:	Array

[ Top ]

$hasAffectedRows = true

[line 24]

Type:	mixed
Overrides:	Array

[ Top ]

$hasGenID = true

[line 26]

Type:	mixed
Overrides:	Array

[ Top ]

$hasInsertID = false

[line 25]

Type:	mixed
Overrides:	Array

[ Top ]

$hasMoveFirst = true

[line 27]

Type:	mixed
Overrides:	Array

[ Top ]

$odbc_driver = 0

[line 23]

Type:

mixed

[ Top ]

$replaceQuote = "''"

[line 22]

Type:	mixed
Overrides:	Array

[ Top ]

$_bindInputArray = false

[line 31]

Type:	mixed
Overrides:	Array

[ Top ]

$_canPrepareSP = false

[line 33]

Type:

mixed

[ Top ]

$_dontPoolDBC = true

[line 34]

Type:

mixed

[ Top ]

$_dropSeqSQL = "delete from adodb_seq where seq_name = '%s'"

[line 30]

Type:

mixed

[ Top ]

$_genSeqSQL = "create table %s (seq_name char(30) not null unique , seq_value integer not null)"

[line 29]

Type:

mixed

[ Top ]

$_useUnicodeSQL = false

[line 32]

Type:

mixed

[ Top ]

Class Methods

constructor ADODB_odbtp [line 36]

ADODB_odbtp ADODB_odbtp(
)

[ Top ]

method BeginTrans [line 391]

void BeginTrans(
)

Overrides ADOConnection::BeginTrans() (Begin a Transaction. Must be followed by CommitTrans() or RollbackTrans().)

[ Top ]

method CommitTrans [line 406]

void CommitTrans(
[
$ok = true])

Overrides ADOConnection::CommitTrans() (If database does not support transactions, always return true as data always commited)

Parameters:

$ok

[ Top ]

method CreateSequence [line 76]

void CreateSequence(
[
$seqname = 'adodbseq'], [
$start = 1])

Overrides ADOConnection::CreateSequence() (parent method not documented)

Parameters:

	$seqname
	$start

[ Top ]

method DropSequence [line 100]

void DropSequence(

$seqname)

Overrides ADOConnection::DropSequence() (parent method not documented)

Parameters:

$seqname

[ Top ]

method ErrorMsg [line 46]

void ErrorMsg(
)

Overrides ADOConnection::ErrorMsg() (parent method not documented)

[ Top ]

method ErrorNo [line 52]

void ErrorNo(
)

Overrides ADOConnection::ErrorNo() (parent method not documented)

[ Top ]

method GenID [line 106]

void GenID(
[
$seq = 'adodbseq'], [
$start = 1])

Overrides ADOConnection::GenID() (Generates a sequence id and stores it in $this->genID; GenID is only available if $this->hasGenID = true;)

Parameters:

	$seq
	$start

[ Top ]

method IfNull [line 514]

void IfNull(

$field, 
$ifNull)

Overrides ADOConnection::IfNull() (parent method not documented)

Parameters:

	$field
	$ifNull

[ Top ]

method MetaColumns [line 298]

void &MetaColumns(

$table, [
$upper = true])

Overrides ADOConnection::MetaColumns() (List columns in a database as an array of ADOFieldObjects.)

Parameters:

	$table
	$upper

[ Top ]

method MetaForeignKeys [line 361]

void &MetaForeignKeys(

$table, [
$owner = ''], [
$upper = false])

Overrides ADOConnection::MetaForeignKeys() (parent method not documented)

Parameters:

	$table
	$owner
	$upper

[ Top ]

method MetaPrimaryKeys [line 344]

void &MetaPrimaryKeys(

$table, [
$owner = ''])

Overrides ADOConnection::MetaPrimaryKeys() (parent method not documented)

Parameters:

	$table
	$owner

[ Top ]

method MetaTables [line 276]

void &MetaTables(
[
$ttype = ''], [
$showSchema = false], [
$mask = false])

Overrides ADOConnection::MetaTables() (parent method not documented)

Parameters:

	$ttype
	$showSchema
	$mask

[ Top ]

method Parameter [line 476]

void Parameter(

&$stmt, 
&$var, 
$name, [
$isOutput = false], [
$maxLen = 0], [
$type = 0])

Overrides ADOConnection::Parameter() (parent method not documented)

Parameters:

	&$stmt
	&$var
	$name
	$isOutput
	$maxLen
	$type

[ Top ]

method Prepare [line 437]

void Prepare(

$sql)

Overrides ADOConnection::Prepare() (Should prepare the sql statement and return the stmt resource.)

Parameters:

$sql

[ Top ]

method PrepareSP [line 448]

void PrepareSP(

$sql)

Overrides ADOConnection::PrepareSP() (Some databases, eg. mssql require a different function for preparing stored procedures. So we cannot use Prepare().)

Parameters:

$sql

[ Top ]

method RollbackTrans [line 417]

void RollbackTrans(
)

Overrides ADOConnection::RollbackTrans() (If database does not support transactions, rollbacks always fail, so return false)

[ Top ]

method SelectDB [line 266]

void SelectDB(

$dbName)

Overrides ADOConnection::SelectDB() (Choose a database to connect to. Many databases do not support this.)

Parameters:

$dbName

[ Top ]

method SelectLimit [line 427]

void &SelectLimit(

$sql, [
$nrows = -1], [
$offset = -1], [
$inputarr = false], [
$secs2cache = 0])

Overrides ADOConnection::SelectLimit() (Will select, getting rows from $offset (1-based), for $nrows.)

Parameters:

	$sql
	$nrows
	$offset
	$inputarr
	$secs2cache

[ Top ]

method ServerInfo [line 40]

void ServerInfo(
)

Overrides ADOConnection::ServerInfo() (parent method not documented)

[ Top ]

method UpdateBlob [line 502]

void UpdateBlob(

$table, 
$column, 
$val, 
$where, [
$blobtype = 'image'])

Overrides ADOConnection::UpdateBlob() (Update a blob column, given a where clause. There are more sophisticated blob handling functions that we could have implemented, but all require a very complex API. Instead we have chosen something that is extremely simple to understand and use.)

Parameters:

	$table
	$column
	$val
	$where
	$blobtype

[ Top ]

method _affectedrows [line 68]

void _affectedrows(
)

[ Top ]

method _close [line 562]

void _close(
)

[ Top ]

method _connect [line 150]

void _connect(

$HostOrInterface, [
$UserOrDSN = ''], [
$argPassword = ''], [
$argDatabase = ''])

Parameters:

	$HostOrInterface
	$UserOrDSN
	$argPassword
	$argDatabase

[ Top ]

method _insertid [line 58]

void _insertid(
)

[ Top ]

method _pconnect [line 260]

void _pconnect(

$HostOrInterface, [
$UserOrDSN = ''], [
$argPassword = ''], [
$argDatabase = ''])

Parameters:

	$HostOrInterface
	$UserOrDSN
	$argPassword
	$argDatabase

[ Top ]

method _query [line 525]

void _query(

$sql, [
$inputarr = false])

Parameters:

	$sql
	$inputarr

[ Top ]

Documentation generated on Fri, 18 Jul 2008 21:40:59 +0200 by phpDocumentor 1.4.1