Packages

  • dibi
    • drivers
    • nette
    • reflection
  • None
  • PHP

Classes

  • dibi
  • DibiConnection
  • DibiDataSource
  • DibiDateTime
  • DibiEvent
  • DibiFileLogger
  • DibiFirePhpLogger
  • DibiFluent
  • DibiObject
  • DibiResult
  • DibiResultIterator
  • DibiRow
  • DibiTranslator

Interfaces

  • IDataSource
  • IDibiDriver
  • IDibiReflector
  • IDibiResultDriver

Exceptions

  • DibiDriverException
  • DibiException
  • DibiNotImplementedException
  • DibiNotSupportedException
  • DibiPcreException
  • Overview
  • Package
  • Class
  • Tree

Class dibi

Interface for database drivers.

This class is static container class for creating DB objects and store connections info.

Package: dibi
Author: David Grudl
Located at dibi.php
Methods summary
final public
# __construct( )

Static class - cannot be instantiated.

Static class - cannot be instantiated.
public static DibiConnection
# connect( mixed $config = array(), string $name = 0 )

Creates a new DibiConnection object and connects it to specified database.

Creates a new DibiConnection object and connects it to specified database.

Parameters

$config
mixed
connection parameters
$name
string
connection name

Returns

DibiConnection

Throws

DibiException
public static
# disconnect( )

Disconnects from database (doesn't destroy DibiConnection object).

Disconnects from database (doesn't destroy DibiConnection object).
public static boolean
# isConnected( )

Returns TRUE when connection was established.

Returns TRUE when connection was established.

Returns

boolean
public static DibiConnection
# getConnection( string $name = NULL )

Retrieve active connection.

Retrieve active connection.

Parameters

$name
string
connection registy name

Returns

DibiConnection

Throws

DibiException
public static DibiConnection
# setConnection( DibiConnection $connection )

Sets connection.

Sets connection.

Parameters

$connection
DibiConnection

Returns

DibiConnection
public static
# activate( string $name )

Change active connection.

Change active connection.

Parameters

$name
string
connection registy name

Throws

DibiException
public static DibiResult|integer
# query( array|mixed $args )

Generates and executes SQL query - Monostate for DibiConnection::query().

Generates and executes SQL query - Monostate for DibiConnection::query().

Parameters

$args
array|mixed
one or more arguments

Returns

DibiResult|integer
result set object (if any)

Throws

DibiException
public static DibiResult|integer
# nativeQuery( string $sql )

Executes the SQL query - Monostate for DibiConnection::nativeQuery().

Executes the SQL query - Monostate for DibiConnection::nativeQuery().

Parameters

$sql
string
SQL statement.

Returns

DibiResult|integer
result set object (if any)
public static boolean
# test( array|mixed $args )

Generates and prints SQL query - Monostate for DibiConnection::test().

Generates and prints SQL query - Monostate for DibiConnection::test().

Parameters

$args
array|mixed
one or more arguments

Returns

boolean
public static DibiDataSource
# dataSource( array|mixed $args )

Generates and returns SQL query as DibiDataSource - Monostate for DibiConnection::test().

Generates and returns SQL query as DibiDataSource - Monostate for DibiConnection::test().

Parameters

$args
array|mixed
one or more arguments

Returns

DibiDataSource
public static DibiRow
# fetch( array|mixed $args )

Executes SQL query and fetch result - Monostate for DibiConnection::query() & fetch().

Executes SQL query and fetch result - Monostate for DibiConnection::query() & fetch().

Parameters

$args
array|mixed
one or more arguments

Returns

DibiRow

Throws

DibiException
public static array
# fetchAll( array|mixed $args )

Executes SQL query and fetch results - Monostate for DibiConnection::query() & fetchAll().

Executes SQL query and fetch results - Monostate for DibiConnection::query() & fetchAll().

Parameters

$args
array|mixed
one or more arguments

Returns

array
of DibiRow

Throws

DibiException
public static string
# fetchSingle( array|mixed $args )

Executes SQL query and fetch first column - Monostate for DibiConnection::query() & fetchSingle().

Executes SQL query and fetch first column - Monostate for DibiConnection::query() & fetchSingle().

Parameters

$args
array|mixed
one or more arguments

Returns

string

Throws

DibiException
public static string
# fetchPairs( array|mixed $args )

Executes SQL query and fetch pairs - Monostate for DibiConnection::query() & fetchPairs().

Executes SQL query and fetch pairs - Monostate for DibiConnection::query() & fetchPairs().

Parameters

$args
array|mixed
one or more arguments

Returns

string

Throws

DibiException
public static integer
# getAffectedRows( )

Gets the number of affected rows. Monostate for DibiConnection::getAffectedRows()

Gets the number of affected rows. Monostate for DibiConnection::getAffectedRows()

Returns

integer
number of rows

Throws

DibiException
public static integer
# affectedRows( )

Gets the number of affected rows. Alias for getAffectedRows().

Gets the number of affected rows. Alias for getAffectedRows().

Returns

integer
number of rows

Throws

DibiException
public static integer
# getInsertId( string $sequence = NULL )

Retrieves the ID generated for an AUTO_INCREMENT column by the previous INSERT query. Monostate for DibiConnection::getInsertId()

Retrieves the ID generated for an AUTO_INCREMENT column by the previous INSERT query. Monostate for DibiConnection::getInsertId()

Parameters

$sequence
string
optional sequence name

Returns

integer

Throws

DibiException
public static integer
# insertId( string $sequence = NULL )

Retrieves the ID generated for an AUTO_INCREMENT column. Alias for getInsertId().

Retrieves the ID generated for an AUTO_INCREMENT column. Alias for getInsertId().

Parameters

$sequence
string
optional sequence name

Returns

integer

Throws

DibiException
public static
# begin( string $savepoint = NULL )

Begins a transaction - Monostate for DibiConnection::begin().

Begins a transaction - Monostate for DibiConnection::begin().

Parameters

$savepoint
string
optional savepoint name

Throws

DibiException
public static
# commit( string $savepoint = NULL )

Commits statements in a transaction - Monostate for DibiConnection::commit($savepoint = NULL).

Commits statements in a transaction - Monostate for DibiConnection::commit($savepoint = NULL).

Parameters

$savepoint
string
optional savepoint name

Throws

DibiException
public static
# rollback( string $savepoint = NULL )

Rollback changes in a transaction - Monostate for DibiConnection::rollback().

Rollback changes in a transaction - Monostate for DibiConnection::rollback().

Parameters

$savepoint
string
optional savepoint name

Throws

DibiException
public static DibiDatabaseInfo
# getDatabaseInfo( )

Gets a information about the current database - Monostate for DibiConnection::getDatabaseInfo().

Gets a information about the current database - Monostate for DibiConnection::getDatabaseInfo().

Returns

DibiDatabaseInfo
public static integer
# loadFile( string $file )

Import SQL dump from file - extreme fast!

Import SQL dump from file - extreme fast!

Parameters

$file
string
filename

Returns

integer
count of sql commands
public static
# __callStatic( $name, $args )

Replacement for majority of dibi::methods() in future.

Replacement for majority of dibi::methods() in future.
public static DibiFluent
# command( )

Returns

DibiFluent
public static DibiFluent
# select( string $args )

Parameters

$args
string
column name

Returns

DibiFluent
public static DibiFluent
# update( string $table, array $args )

Parameters

$table
string
table
$args
array

Returns

DibiFluent
public static DibiFluent
# insert( string $table, array $args )

Parameters

$table
string
table
$args
array

Returns

DibiFluent
public static DibiFluent
# delete( string $table )

Parameters

$table
string
table

Returns

DibiFluent
public static DibiDateTime
# datetime( $time = NULL )

Returns

DibiDateTime
public static DibiHashMap
# getSubstitutes( )

Returns substitution hashmap - Monostate for DibiConnection::getSubstitutes().

Returns substitution hashmap - Monostate for DibiConnection::getSubstitutes().

Returns

DibiHashMap
public static string
# dump( string|DibiResult $sql = NULL, boolean $return = FALSE )

Prints out a syntax highlighted version of the SQL command or DibiResult.

Prints out a syntax highlighted version of the SQL command or DibiResult.

Parameters

$sql
string|DibiResult
$return
boolean
return output instead of printing it?

Returns

string
Constants summary
string TEXT 's'
#

column type

column type
string BINARY 'bin'
#

column type

column type
string BOOL 'b'
#

column type

column type
string INTEGER 'i'
#

column type

column type
string FLOAT 'f'
#

column type

column type
string DATE 'd'
#

column type

column type
string DATETIME 't'
#

column type

column type
string TIME 't'
#

column type

column type
string IDENTIFIER 'n'
#
string VERSION '1.5-rc2'
#

version

version
string REVISION 'b964887 released on 2012-01-12'
#

version

version
string ASC 'ASC'
#

sorting order

sorting order
string DESC 'DESC'
#

sorting order

sorting order
Properties summary
public static string $sql
#

Last SQL command @see dibi::query()

Last SQL command @see dibi::query()
public static integer $elapsedTime
#

Elapsed time for last query

Elapsed time for last query
public static integer $totalTime
#

Elapsed time for all queries

Elapsed time for all queries
public static integer $numOfQueries 0
#

Number or queries

Number or queries
public static string $defaultDriver 'mysql'
#

Default dibi driver

Default dibi driver
dibi API documentation API documentation generated by ApiGen 2.3.0