lib/ezdb/classes/ezdbinterface.php

Show:

inherited

Classes
- \eZDBInterface

Table of Contents

File containing the eZDBInterface 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

\eZDBInterface
jump to top

Package: lib

File containing the eZDBInterface class.

Children: \eZMySQLDB; \eZMySQLiDB; \eZNullDB; \eZPostgreSQLDB
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

 
                BINDING_NO
                = 0

 
                BINDING_NAME
                = 1

 
                BINDING_ORDERED
                = 2

 
                RELATION_TABLE
                = 0

 
                RELATION_SEQUENCE
                = 1

 
                RELATION_TRIGGER
                = 2

 
                RELATION_VIEW
                = 3

 
                RELATION_INDEX
                = 4

 
                RELATION_TABLE_BIT
                = 1

 
                RELATION_SEQUENCE_BIT
                = 2

 
                RELATION_TRIGGER_BIT
                = 4

 
                RELATION_VIEW_BIT
                = 8

 
                RELATION_INDEX_BIT
                = 16

 
                RELATION_NONE
                = 0

 
                RELATION_MASK
                = 31

 
                ERROR_MISSING_EXTENSION
                = 1

 
                SERVER_MASTER
                = 1

 
                SERVER_SLAVE
                = 2

Properties


                 $Charset= ''

Details

Type: n/a


                 $ConnectRetries= ''

Details

Type: n/a


                 $DB= ''

Details

Type: n/a


                 $DBConnection= ''

Details

Type: n/a


                 $DBWriteConnection= ''

Details

Type: n/a


                 $EndTime= ''

Details

Type: n/a


                 $ErrorMessage= ''

Details

Type: n/a


                 $ErrorNumber= '0'

Default value0Details

Type: n/a


                 $InputTextCodec= ''

Details

Type: n/a


                 $IsConnected= 'false'

Default valuefalseDetails

Type: n/a


                 $NumQueries= '0'

Default value0Details

Type: n/a


                 $OutputSQL= ''

Details

Type: n/a


                 $OutputTextCodec= ''

Details

Type: n/a


                 $Password= ''

Details

Type: n/a


                 $Port= ''

Details

Type: n/a


                 $RecordError= 'true'

Default valuetrueDetails

Type: n/a


                 $Server= ''

Details

Type: n/a


                 $SlaveDB= ''

Details

Type: n/a


                 $SlavePassword= ''

Details

Type: n/a


                 $SlavePort= ''

Details

Type: n/a


                 $SlaveServer= ''

Details

Type: n/a


                 $SlaveUser= ''

Details

Type: n/a


                 $SocketPath= ''

Details

Type: n/a


                 $StartTime= ''

Details

Type: n/a


                 $TimeTaken= ''

Details

Type: n/a


                 $TransactionCounter= ''

Details

Type: n/a


                 $TransactionIsValid= ''

Details

Type: n/a


                 $UseBuiltinEncoding= ''

Details

Type: n/a


                 $UsePersistentConnection= 'false'

Default valuefalseDetails

Type: n/a


                 $UseSlaveServer= ''

Details

Type: n/a


                 $User= ''

Details

Type: n/a

int
                 $errorHandling= 'eZDB::ERROR_HANDLING_STANDARD'

Error handling mechanism

One of the eZDB::ERROR_HANDLING_* constants

Default valueeZDB::ERROR_HANDLING_STANDARDDetails

Type: int

Methods

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

Parameters

Name	Type	Description
$sql
$params
$server

attribute(
           $name
          )
        
        :
          void

Parameters

Name	Type	Description
$name

attributes(
          
          )
        
        :
          void

availableDatabases(
          
          )
        
        :
          void

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

checkCharset(
           $charset,  $currentCharset
          )
        
        :
          void

Parameters

Name	Type	Description
$charset
$currentCharset

commit(
          
          )
        
        :
          void

commitQuery(
          
          )
        
        :
          void

concatString(
           $strings
              =
              array()
          )
        
        :
          void

Parameters

Name	Type	Description
$strings

connectRetryCount(
          
          )
        
        :
          void

connectRetryWaitTime(
          
          )
        
        :
          void

createDatabase(
           $dbName
          )
        
        :
          void

Parameters

Name	Type	Description
$dbName

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

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

Parameters

Name	Type	Description
$tableList
$server

eZDBInterface(
           $parameters
          )
        
        :
          void

Parameters

Name	Type	Description
$parameters

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

Parameters

Name	Type	Description
$server

endTime(
          
          )
        
        :
          void

endTimer(
          
          )
        
        :
          void

errorMessage(
          
          )
        
        :
          void

errorNumber(
          
          )
        
        :
          void

escapeString(
           $str
          )
        
        :
          void

Parameters

Name	Type	Description
$str

generateFailedTransactionStack(
          
          )
        
        :
          void

generateFailedTransactionStackEntry(
           $stack,  $indentCount
          )
        
        :
          void

Parameters

Name	Type	Description
$stack
$indentCount

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

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

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

Parameters

Name	Type	Description
$entry

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

Parameters

Name	Type	Description
$pattern
$randomizeIndex
$server

hasAttribute(
           $name
          )
        
        :
          void

Parameters

Name	Type	Description
$name

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

Parameters

Name	Type	Description
$minVersion
$name

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

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

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

Parameters

Name	Type	Description
$path
$sqlFile
$usePathType

invalidateTransaction(
          
          )
        
        :
          void

isCharsetSupported(
           $charset
          )
        
        :
          void

Parameters

Name	Type	Description
$charset

isConnected(
          
          )
        
        :
          void

isTransactionValid(
          
          )
        
        :
          void

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

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
          )
        
        :
          void

Parameters

Name	Type	Description
$relationType

removeDatabase(
           $dbName
          )
        
        :
          void

Parameters

Name	Type	Description
$dbName

removeRelation(
           $relationName,  $relationType
          )
        
        :
          void

Parameters

Name	Type	Description
$relationName
$relationType

reportError(
          
          )
        
        :
          void

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

Parameters

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

rollback(
          
          )
        
        :
          void

rollbackQuery(
          
          )
        
        :
          void

setError(
          
          )
        
        :
          void

setErrorHandling(
          int $errorHandling
          )
        
        :
          void

Sets the eZDB error handling mode

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

Parameters

Name	Type	Description
$enabled

socketPath(
          
          )
        
        :
          void

startTime(
          
          )
        
        :
          void

startTimer(
          
          )
        
        :
          void

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

Parameters

Name	Type	Description
$string
$from
$len

supportedRelationTypeMask(
          
          )
        
        :
          void

supportedRelationTypes(
          
          )
        
        :
          void

supportsDefaultValuesInsertion(
          
          )
        
        :
          void

timeTaken(
          
          )
        
        :
          void

transactionCounter(
          
          )
        
        :
          void

unlock(
          
          )
        
        :
          void

useShortNames(
          
          )
        
        :
          void

usesBuiltinEncoding(
          
          )
        
        :
          void

version(
          
          )
        
        :
          void

lib/ezdb/classes/ezdbinterface.php

\eZDBInterfacejump to top

Constants

Properties

Methods

\eZDBInterface
jump to top