Zikula 1.0.1
[ class tree: Zikula 1.0.1 ] [ index: Zikula 1.0.1 ] [ all elements ]

Class: ADODB_mysql

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

Class Overview

ADOConnection
   |
   --ADODB_mysql

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


Variables

Methods


Child classes:

ADODB_mysqlt
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::$fmtDate
ADOConnection::$fnCacheExecute
ADOConnection::$fnExecute
ADOConnection::$genID
ADOConnection::$hasTop
ADOConnection::$host
ADOConnection::$lastInsID
ADOConnection::$leftOuter
ADOConnection::$length
ADOConnection::$maxblobsize
ADOConnection::$memCache
ADOConnection::$memCacheCompress
ADOConnection::$memCacheHost
ADOConnection::$memCachePort
ADOConnection::$metaDatabasesSQL
ADOConnection::$noNullStrings
ADOConnection::$null2null
ADOConnection::$numCacheHits
ADOConnection::$numCacheMisses
ADOConnection::$pageExecuteCountRows
ADOConnection::$password
ADOConnection::$raiseErrorFn
ADOConnection::$random
ADOConnection::$readOnly
ADOConnection::$replaceQuote
ADOConnection::$rightOuter
ADOConnection::$rsPrefix
ADOConnection::$transCnt
ADOConnection::$transOff
ADOConnection::$true
ADOConnection::$uniqueOrderBy
ADOConnection::$uniqueSort
ADOConnection::$upperCase
ADOConnection::$user
ADOConnection::$_affected
ADOConnection::$_bindInputArray
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 21]
Connection object. For connecting to databases, and executing queries.



[ Top ]


Class Variables

$clientFlags =  0

[line 38]


Type:   mixed


[ Top ]

$compat323 =  false

[line 41]


Type:   mixed


[ Top ]

$databaseType =  'mysql'

[line 22]


Type:   mixed
Overrides:   Array


[ Top ]

$dataProvider =  'mysql'

[line 23]


Type:   mixed
Overrides:   Array


[ Top ]

$fmtTimeStamp =  "'Y-m-d H:i:s'"

[line 28]


Type:   mixed
Overrides:   Array


[ Top ]

$forceNewConnect =  false

[line 36]


Type:   mixed


[ Top ]

$hasAffectedRows =  true

[line 25]


Type:   mixed
Overrides:   Array


[ Top ]

$hasGenID =  false

[line 31]


Type:   mixed
Overrides:   Array


[ Top ]

$hasInsertID =  true

[line 24]


Type:   mixed
Overrides:   Array


[ Top ]

$hasLimit =  true

[line 29]


Type:   mixed
Overrides:   Array


[ Top ]

$hasMoveFirst =  true

[line 30]


Type:   mixed
Overrides:   Array


[ Top ]

$hasTransactions =  false

[line 35]


Type:   mixed
Overrides:   Array


[ Top ]

$isoDates =  true

[line 32]


Type:   mixed
Overrides:   Array


[ Top ]

$metaColumnsSQL =  "SHOW COLUMNS FROM `%s`"

[line 27]


Type:   mixed


[ Top ]

$metaTablesSQL =  "SHOW TABLES"

[line 26]


Type:   mixed
Overrides:   Array


[ Top ]

$nameQuote =  '`'

[line 40]


Type:   mixed
Overrides:   Array


[ Top ]

$poorAffectedRows =  true

[line 37]


Type:   mixed
Overrides:   Array


[ Top ]

$substr =  "substring"

[line 39]


Type:   mixed
Overrides:   Array


[ Top ]

$sysDate =  'CURDATE()'

[line 33]


Type:   mixed
Overrides:   Array


[ Top ]

$sysTimeStamp =  'NOW()'

[line 34]


Type:   mixed
Overrides:   Array


[ Top ]

$_dropSeqSQL =  "drop table %s"

[line 191]


Type:   mixed


[ Top ]

$_genIDSQL =  "update %s set id=LAST_INSERT_ID(id+1);"

[line 187]


Type:   mixed


[ Top ]

$_genSeq2SQL =  "insert into %s values (%s)"

[line 190]


Type:   mixed


[ Top ]

$_genSeqCountSQL =  "select count(*) from %s"

[line 189]


Type:   mixed


[ Top ]

$_genSeqSQL =  "create table %s (id int not null)"

[line 188]


Type:   mixed


[ Top ]



Class Methods


constructor ADODB_mysql [line 43]

ADODB_mysql ADODB_mysql( )



[ Top ]

method BeginTrans [line 175]

void BeginTrans( )



Overridden in child classes as:

ADODB_mysqlt::BeginTrans()

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

[ Top ]

method CharMax [line 542]

void CharMax( )



[ Top ]

method Concat [line 339]

void Concat( )



Overrides ADOConnection::Concat() (Different SQL databases used different methods to combine strings together.)

[ Top ]

method CreateSequence [line 193]

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



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

Parameters:

   $seqname  
   $startID  

[ Top ]

method ErrorMsg [line 514]

void ErrorMsg( )



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

[ Top ]

method ErrorNo [line 524]

void ErrorNo( )



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

[ Top ]

method GenID [line 204]

void GenID( [ $seqname = 'adodbseq'], [ $startID = 1])



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

Parameters:

   $seqname  
   $startID  

[ Top ]

method GetOne [line 160]

void GetOne( $sql, [ $inputarr = false])



Overrides ADOConnection::GetOne() (Return first element of first row of sql statement. Recordset is disposed for you.)

Parameters:

   $sql  
   $inputarr  

[ Top ]

method IfNull [line 55]

void IfNull( $field, $ifNull)



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

Parameters:

   $field  
   $ifNull  

[ Top ]

method MetaColumns [line 400]

void &MetaColumns( $table)



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

Parameters:

   $table  

[ Top ]

method MetaDatabases [line 235]

void &MetaDatabases( )



Overrides ADOConnection::MetaDatabases() (return the databases that the driver can connect to.)

[ Top ]

method MetaForeignKeys [line 556]

void MetaForeignKeys( $table, [ $owner = FALSE], [ $upper = FALSE], [ $associative = FALSE])



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

Parameters:

   $table  
   $owner  
   $upper  
   $associative  

[ Top ]

method MetaIndexes [line 79]

void &MetaIndexes( $table, [ $primary = FALSE], [ $owner = false])



Overrides ADOConnection::MetaIndexes() (List indexes on a table as an array.)

Parameters:

   $table  
   $primary  
   $owner  

[ Top ]

method MetaTables [line 61]

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



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

Parameters:

   $ttype  
   $showSchema  
   $mask  

[ Top ]

method OffsetDate [line 350]

void OffsetDate( $dayFraction, [ $date = false])



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

Parameters:

   $dayFraction  
   $date  

[ Top ]

method qstr [line 133]

void qstr( $s, [ $magic_quotes = false])



Overrides ADOConnection::qstr() (Correctly quotes a string so that all strings are escaped. We prefix and append to the string single-quotes.)

Parameters:

   $s  
   $magic_quotes  

[ Top ]

method SelectDB [line 480]

void SelectDB( $dbName)



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

Parameters:

   $dbName  

[ Top ]

method SelectLimit [line 491]

void &SelectLimit( $sql, [ $nrows = -1], [ $offset = -1], [ $inputarr = false], [ $secs = 0])



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

Parameters:

   $sql  
   $nrows  
   $offset  
   $inputarr  
   $secs  

[ Top ]

method ServerInfo [line 48]

void ServerInfo( )



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

[ Top ]

method SQLDate [line 251]

void SQLDate( $fmt, [ $col = false])



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

Parameters:

   $fmt  
   $col  

[ Top ]

method TextMax [line 550]

void TextMax( )



[ Top ]

method _affectedrows [line 180]

void _affectedrows( )



[ Top ]

method _close [line 532]

void _close( )



[ Top ]

method _connect [line 361]

void _connect( $argHostname, $argUsername, $argPassword, $argDatabasename)



Parameters:

   $argHostname  
   $argUsername  
   $argPassword  
   $argDatabasename  

[ Top ]

method _insertid [line 154]

void _insertid( )



[ Top ]

method _nconnect [line 394]

void _nconnect( $argHostname, $argUsername, $argPassword, $argDatabasename)



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

Parameters:

   $argHostname  
   $argUsername  
   $argPassword  
   $argDatabasename  

[ Top ]

method _pconnect [line 380]

void _pconnect( $argHostname, $argUsername, $argPassword, $argDatabasename)



Parameters:

   $argHostname  
   $argUsername  
   $argPassword  
   $argDatabasename  

[ Top ]

method _query [line 505]

void _query( $sql, $inputarr)



Parameters:

   $sql  
   $inputarr  

[ Top ]


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