lib/ezdb/classes/ezmysqlidb.php

Show:

inherited

Classes
- \eZMySQLiDB

Table of Contents

File containing the eZMySQLiDB class.

Copyright: Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
License: eZ Business Use License Agreement Version 2.0
Package: lib
Version: 4.6.0

\eZMySQLiDB
jump to top

Package: lib

File containing the eZMySQLiDB class.

Parent(s): \eZDBInterface
Copyright: Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
License: eZ Business Use License Agreement Version 2.0
Version: 4.6.0

Constants

 
                RELATION_FOREIGN_KEY
                = 5

 
                RELATION_FOREIGN_KEY_BIT
                = 32

 
                BINDING_NO
                = 0

inheritedInherited from: \eZDBInterface::BINDING_NO

Inherited_from: \eZDBInterface::BINDING_NO

 
                BINDING_NAME
                = 1

inheritedInherited from: \eZDBInterface::BINDING_NAME

Inherited_from: \eZDBInterface::BINDING_NAME

 
                BINDING_ORDERED
                = 2

inheritedInherited from: \eZDBInterface::BINDING_ORDERED

Inherited_from: \eZDBInterface::BINDING_ORDERED

 
                RELATION_TABLE
                = 0

inheritedInherited from: \eZDBInterface::RELATION_TABLE

Inherited_from: \eZDBInterface::RELATION_TABLE

 
                RELATION_SEQUENCE
                = 1

inheritedInherited from: \eZDBInterface::RELATION_SEQUENCE

Inherited_from: \eZDBInterface::RELATION_SEQUENCE

 
                RELATION_TRIGGER
                = 2

inheritedInherited from: \eZDBInterface::RELATION_TRIGGER

Inherited_from: \eZDBInterface::RELATION_TRIGGER

 
                RELATION_VIEW
                = 3

inheritedInherited from: \eZDBInterface::RELATION_VIEW

Inherited_from: \eZDBInterface::RELATION_VIEW

 
                RELATION_INDEX
                = 4

inheritedInherited from: \eZDBInterface::RELATION_INDEX

Inherited_from: \eZDBInterface::RELATION_INDEX

 
                RELATION_TABLE_BIT
                = 1

inheritedInherited from: \eZDBInterface::RELATION_TABLE_BIT

Inherited_from: \eZDBInterface::RELATION_TABLE_BIT

 
                RELATION_SEQUENCE_BIT
                = 2

inheritedInherited from: \eZDBInterface::RELATION_SEQUENCE_BIT

Inherited_from: \eZDBInterface::RELATION_SEQUENCE_BIT

 
                RELATION_TRIGGER_BIT
                = 4

inheritedInherited from: \eZDBInterface::RELATION_TRIGGER_BIT

Inherited_from: \eZDBInterface::RELATION_TRIGGER_BIT

 
                RELATION_VIEW_BIT
                = 8

inheritedInherited from: \eZDBInterface::RELATION_VIEW_BIT

Inherited_from: \eZDBInterface::RELATION_VIEW_BIT

 
                RELATION_INDEX_BIT
                = 16

inheritedInherited from: \eZDBInterface::RELATION_INDEX_BIT

Inherited_from: \eZDBInterface::RELATION_INDEX_BIT

 
                RELATION_NONE
                = 0

inheritedInherited from: \eZDBInterface::RELATION_NONE

Inherited_from: \eZDBInterface::RELATION_NONE

 
                RELATION_MASK
                = 31

inheritedInherited from: \eZDBInterface::RELATION_MASK

Inherited_from: \eZDBInterface::RELATION_MASK

 
                ERROR_MISSING_EXTENSION
                = 1

inheritedInherited from: \eZDBInterface::ERROR_MISSING_EXTENSION

Inherited_from: \eZDBInterface::ERROR_MISSING_EXTENSION

 
                SERVER_MASTER
                = 1

inheritedInherited from: \eZDBInterface::SERVER_MASTER

Inherited_from: \eZDBInterface::SERVER_MASTER

 
                SERVER_SLAVE
                = 2

inheritedInherited from: \eZDBInterface::SERVER_SLAVE

Inherited_from: \eZDBInterface::SERVER_SLAVE

Properties


                 $Charset= ''

inheritedInherited from: \eZDBInterface::$$Charset

Details

Type: n/a
Inherited_from: \eZDBInterface::$$Charset


                 $ConnectRetries= ''

inheritedInherited from: \eZDBInterface::$$ConnectRetries

Details

Type: n/a
Inherited_from: \eZDBInterface::$$ConnectRetries


                 $DB= ''

inheritedInherited from: \eZDBInterface::$$DB

Details

Type: n/a
Inherited_from: \eZDBInterface::$$DB


                 $DBConnection= ''

inheritedInherited from: \eZDBInterface::$$DBConnection

Details

Type: n/a
Inherited_from: \eZDBInterface::$$DBConnection


                 $DBWriteConnection= ''

inheritedInherited from: \eZDBInterface::$$DBWriteConnection

Details

Type: n/a
Inherited_from: \eZDBInterface::$$DBWriteConnection


                 $EndTime= ''

inheritedInherited from: \eZDBInterface::$$EndTime

Details

Type: n/a
Inherited_from: \eZDBInterface::$$EndTime


                 $ErrorMessage= ''

inheritedInherited from: \eZDBInterface::$$ErrorMessage

Details

Type: n/a
Inherited_from: \eZDBInterface::$$ErrorMessage


                 $ErrorNumber= '0'

inheritedInherited from: \eZDBInterface::$$ErrorNumber

Default value0Details

Type: n/a
Inherited_from: \eZDBInterface::$$ErrorNumber


                 $InputTextCodec= ''

inheritedInherited from: \eZDBInterface::$$InputTextCodec

Details

Type: n/a
Inherited_from: \eZDBInterface::$$InputTextCodec


                 $IsConnected= 'false'

inheritedInherited from: \eZDBInterface::$$IsConnected

Default valuefalseDetails

Type: n/a
Inherited_from: \eZDBInterface::$$IsConnected


                 $NumQueries= '0'

inheritedInherited from: \eZDBInterface::$$NumQueries

Default value0Details

Type: n/a
Inherited_from: \eZDBInterface::$$NumQueries


                 $OutputSQL= ''

inheritedInherited from: \eZDBInterface::$$OutputSQL

Details

Type: n/a
Inherited_from: \eZDBInterface::$$OutputSQL


                 $OutputTextCodec= ''

inheritedInherited from: \eZDBInterface::$$OutputTextCodec

Details

Type: n/a
Inherited_from: \eZDBInterface::$$OutputTextCodec


                 $Password= ''

inheritedInherited from: \eZDBInterface::$$Password

Details

Type: n/a
Inherited_from: \eZDBInterface::$$Password


                 $Port= ''

inheritedInherited from: \eZDBInterface::$$Port

Details

Type: n/a
Inherited_from: \eZDBInterface::$$Port


                 $RecordError= 'true'

inheritedInherited from: \eZDBInterface::$$RecordError

Default valuetrueDetails

Type: n/a
Inherited_from: \eZDBInterface::$$RecordError


                 $Server= ''

inheritedInherited from: \eZDBInterface::$$Server

Details

Type: n/a
Inherited_from: \eZDBInterface::$$Server


                 $SlaveDB= ''

inheritedInherited from: \eZDBInterface::$$SlaveDB

Details

Type: n/a
Inherited_from: \eZDBInterface::$$SlaveDB


                 $SlavePassword= ''

inheritedInherited from: \eZDBInterface::$$SlavePassword

Details

Type: n/a
Inherited_from: \eZDBInterface::$$SlavePassword


                 $SlavePort= ''

inheritedInherited from: \eZDBInterface::$$SlavePort

Details

Type: n/a
Inherited_from: \eZDBInterface::$$SlavePort


                 $SlaveServer= ''

inheritedInherited from: \eZDBInterface::$$SlaveServer

Details

Type: n/a
Inherited_from: \eZDBInterface::$$SlaveServer


                 $SlaveUser= ''

inheritedInherited from: \eZDBInterface::$$SlaveUser

Details

Type: n/a
Inherited_from: \eZDBInterface::$$SlaveUser


                 $SocketPath= ''

inheritedInherited from: \eZDBInterface::$$SocketPath

Details

Type: n/a
Inherited_from: \eZDBInterface::$$SocketPath


                 $StartTime= ''

inheritedInherited from: \eZDBInterface::$$StartTime

Details

Type: n/a
Inherited_from: \eZDBInterface::$$StartTime


                 $TempTableList= ''

Details

Type: n/a


                 $TimeTaken= ''

inheritedInherited from: \eZDBInterface::$$TimeTaken

Details

Type: n/a
Inherited_from: \eZDBInterface::$$TimeTaken


                 $TransactionCounter= ''

inheritedInherited from: \eZDBInterface::$$TransactionCounter

Details

Type: n/a
Inherited_from: \eZDBInterface::$$TransactionCounter


                 $TransactionIsValid= ''

inheritedInherited from: \eZDBInterface::$$TransactionIsValid

Details

Type: n/a
Inherited_from: \eZDBInterface::$$TransactionIsValid


                 $UseBuiltinEncoding= ''

inheritedInherited from: \eZDBInterface::$$UseBuiltinEncoding

Details

Type: n/a
Inherited_from: \eZDBInterface::$$UseBuiltinEncoding


                 $UsePersistentConnection= 'false'

inheritedInherited from: \eZDBInterface::$$UsePersistentConnection

Default valuefalseDetails

Type: n/a
Inherited_from: \eZDBInterface::$$UsePersistentConnection


                 $UseSlaveServer= ''

inheritedInherited from: \eZDBInterface::$$UseSlaveServer

Details

Type: n/a
Inherited_from: \eZDBInterface::$$UseSlaveServer


                 $User= ''

inheritedInherited from: \eZDBInterface::$$User

Details

Type: n/a
Inherited_from: \eZDBInterface::$$User

int
                 $errorHandling= 'eZDB::ERROR_HANDLING_STANDARD'

inherited

Error handling mechanism

One of the eZDB::ERROR_HANDLING_* constantsInherited from: \eZDBInterface::$$errorHandling

Default valueeZDB::ERROR_HANDLING_STANDARDDetails

Type: int
Inherited_from: \eZDBInterface::$$errorHandling

Methods

arrayQuery(
           $sql,  $params
              =
              array(),  $server
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$sql
$params
$server

attribute(
           $name
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::attribute()

Parameters

Name	Type	Description
$name

attributes(
          
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::attributes()

availableDatabases(
          
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::begin()

beginQuery(
          
          )
        
        :
          void

bindVariable(
           $value,  $fieldDef
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$value
$fieldDef

bindingType(
          
          )
        
        :
          void

bitAnd(
           $arg1,  $arg2
          )
        
        :
          void

Parameters

Name	Type	Description
$arg1
$arg2

bitOr(
           $arg1,  $arg2
          )
        
        :
          void

Parameters

Name	Type	Description
$arg1
$arg2

charset(
          
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::charset()

checkCharset(
           $charset,  $currentCharset
          )
        
        :
          void

Parameters

Name	Type	Description
$charset
$currentCharset

checkCharsetPriv(
           $charset,  $currentCharset
          )
        
        :
          void

Parameters

Name	Type	Description
$charset
$currentCharset

commit(
          
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::commit()

commitQuery(
          
          )
        
        :
          void

concatString(
           $strings
              =
              array()
          )
        
        :
          void

Parameters

Name	Type	Description
$strings

connect(
           $server,  $db,  $user,  $password,  $socketPath,  $charset
              =
              null,  $port
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$server
$db
$user
$password
$socketPath
$charset
$port

connectRetryCount(
          
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::connectRetryCount()

connectRetryWaitTime(
          
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::connectRetryWaitTime()

createDatabase(
           $dbName
          )
        
        :
          void

Parameters

Name	Type	Description
$dbName

createTempTable(
           $createTableQuery
              =
              '',  $server
              =
              self::SERVER_SLAVE
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::createTempTable()

Parameters

Name	Type	Description
$createTableQuery
$server

databaseClientVersion(
          
          )
        
        :
          void

databaseName(
          
          )
        
        :
          void

databaseServerVersion(
          
          )
        
        :
          void

dropTempTable(
           $dropTableQuery
              =
              '',  $server
              =
              self::SERVER_SLAVE
          )
        
        :
          void

Parameters

Name	Type	Description
$dropTableQuery
$server

dropTempTableList(
           $tableList,  $server
              =
              self::SERVER_SLAVE
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::dropTempTableList()

Parameters

Name	Type	Description
$tableList
$server

eZDBInterface(
           $parameters
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::eZDBInterface()

Parameters

Name	Type	Description
$parameters

eZMySQLiDB(
           $parameters
          )
        
        :
          void

Parameters

Name	Type	Description
$parameters

eZTableList(
           $server
              =
              eZDBInterface::SERVER_MASTER
          )
        
        :
          void

Parameters

Name	Type	Description
$server

endTime(
          
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::endTime()

endTimer(
          
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::endTimer()

errorMessage(
          
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::errorMessage()

errorNumber(
          
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::errorNumber()

escapeString(
           $str
          )
        
        :
          void

Parameters

Name	Type	Description
$str

generateFailedTransactionStack(
          
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::generateFailedTransactionStack()

generateFailedTransactionStackEntry(
           $stack,  $indentCount
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::generateFailedTransactionStackEntry()

Parameters

Name	Type	Description
$stack
$indentCount

generateSQLINStatement(
          int | array $elements, string $columnName
              =
              '', bool $not
              =
              false, \$unique $unique
              =
              true, \$type $type
              =
              false
          )
        
        :
          string

inherited

This function can be used to create a SQL IN statement to be used in a WHERE clause:

Inherited from: \eZDBInterface::generateSQLINStatement()

WHERE columnName IN ( element1, element2, ... ) By default, the elements that can be submitted as an anonymous array (or an integer value in case of a single element) will just be imploded. Drivers for databases with a limitation of the elements within an IN statement have to reimplement this function. It is also possible to negate the "IN" to a "NOT IN" by using the last parameter of this function.

Usage:

$db =& eZDb::instance(); $db->generateSQLINStatement( array( 2, 5, 43, ) );

Parameters

Name	Type	Description
$elements	int \| array	Elements that should (not) be matched by the IN statment as an integer or anonymous array
$columnName	string	Column name of the database table the IN statement should be created for
$not	bool	Will generate a "NOT IN" ( if set to \c true ) statement instead of an "IN" ( if set to false , default )
$unique	\$unique	Wether or not to make the array unique. Not implemented in this class, but can be used by extending classes (oracle does use it)
$type	\$type	The type to cast the array elements to

Returns

Type	Description
string	A string with the correct IN statement like for example "columnName IN ( element1, element2 )"

generateTraceEntry(
           $entry
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::generateTraceEntry()

Parameters

Name	Type	Description
$entry

generateUniqueTempTableName(
           $pattern,  $randomizeIndex
              =
              false,  $server
              =
              self::SERVER_SLAVE
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::generateUniqueTempTableName()

Parameters

Name	Type	Description
$pattern
$randomizeIndex
$server

hasAttribute(
           $name
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::hasAttribute()

Parameters

Name	Type	Description
$name

hasRequiredServerVersion(
           $minVersion,  $name
              =
              false
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::hasRequiredServerVersion()

Parameters

Name	Type	Description
$minVersion
$name

implodeWithTypeCast(
          string $glue, array $pieces, \$type $type
          )
        
        :
          string

inherited

Casts elements of \a $pieces to type $type and returns them as string separated by $glue.

Inherited from: \eZDBInterface::implodeWithTypeCast()

Parameters

Name	Type	Description
$glue	string	The separator.
$pieces	array	The array containing the elements.
$type	\$type	The type to cast to.

Returns

Type	Description
string

Details

Example: implodeWithTypeCast( ',', $myArray, 'int' )
Note: : Use generateSQLINStatement() if you intent to use this for IN statments!

insertFile(
           $path,  $sqlFile,  $usePathType
              =
              true
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::insertFile()

Parameters

Name	Type	Description
$path
$sqlFile
$usePathType

invalidateTransaction(
          
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::invalidateTransaction()

isCharsetSupported(
           $charset
          )
        
        :
          void

Parameters

Name	Type	Description
$charset

isConnected(
          
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::isConnected()

isTransactionValid(
          
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::isTransactionValid()

lastSerialID(
           $table
              =
              false,  $column
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$table
$column

lock(
           $table
          )
        
        :
          void

Parameters

Name	Type	Description
$table

Parameters

Name	Type	Description
$str

prepareSqlQuery(
           $fd,  $buffer
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::prepareSqlQuery()

Parameters

Name	Type	Description
$fd
$buffer

query(
           $sql,  $server
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$sql
$server

relationCount(
           $relationType
              =
              eZDBInterface::RELATION_TABLE
          )
        
        :
          void

Parameters

Name	Type	Description
$relationType

relationCounts(
           $relationMask
          )
        
        :
          void

Parameters

Name	Type	Description
$relationMask

relationList(
           $relationType
              =
              eZDBInterface::RELATION_TABLE
          )
        
        :
          void

Parameters

Name	Type	Description
$relationType

relationMatchRegexp(
           $relationType
          )
        
        :
          void

Parameters

Name	Type	Description
$relationType

relationName(
           $relationType
          )
        
        :
          string | false

Local eZDBInterface::relationName() override to support the foreign keys type relation

Parameters

Name	Type	Description
$relationType

Returns

Type	Description
string \| false

removeDatabase(
           $dbName
          )
        
        :
          void

Parameters

Name	Type	Description
$dbName

removeRelation(
           $relationName,  $relationType
          )
        
        :
          void

Parameters

Name	Type	Description
$relationName
$relationType

reportError(
          
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::reportError()

reportQuery(
           $class,  $sql,  $numRows,  $timeTaken,  $asDebug
              =
              false
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::reportQuery()

Parameters

Name	Type	Description
$class
$sql
$numRows
$timeTaken
$asDebug

rollback(
          
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::rollback()

rollbackQuery(
          
          )
        
        :
          void

setError(
          \MySQLi $connection
              =
              false
          )
        
        :
          void

Sets the internal error messages & number

Parameters

Name	Type	Description
$connection	\MySQLi	database connection handle, overrides the current one if given

setErrorHandling(
          int $errorHandling
          )
        
        :
          void

inherited

Sets the eZDB error handling mode

Inherited from: \eZDBInterface::setErrorHandling()

Parameters

Name	Type	Description
$errorHandling	int	Possible values are:pm - eZDB::ERROR_HANDLING_STANDARD: backward compatible error handling, using reportError - eZDB::ERROR_HANDLING_EXCEPTION: using exceptions

Details

Since: 4.5

setIsSQLOutputEnabled(
           $enabled
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::setIsSQLOutputEnabled()

Parameters

Name	Type	Description
$enabled

socketPath(
          
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::socketPath()

startTime(
          
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::startTime()

startTimer(
          
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::startTimer()

subString(
           $string,  $from,  $len
              =
              null
          )
        
        :
          void

Parameters

Name	Type	Description
$string
$from
$len

supportedRelationTypeMask(
          
          )
        
        :
          void

supportedRelationTypes(
          
          )
        
        :
          void

supportsDefaultValuesInsertion(
          
          )
        
        :
          void

timeTaken(
          
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::timeTaken()

transactionCounter(
          
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::transactionCounter()

unlock(
          
          )
        
        :
          void

useShortNames(
          
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::useShortNames()

usesBuiltinEncoding(
          
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::usesBuiltinEncoding()

version(
          
          )
        
        :
          void

inherited

Inherited from: \eZDBInterface::version()

lib/ezdb/classes/ezmysqlidb.php

\eZMySQLiDBjump to top

Constants

Properties

Methods

\eZMySQLiDB
jump to top