Packages

Classes

Interfaces

Class dibi

Interface for database drivers.

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

Constructor Summary
public	__construct () Static class - cannot be instantiated.

Method Summary
static void	activate (string `$name`) Change active connection.
static void	addSubst (string `$expr`, string `$subst`) Create a new substitution pair for indentifiers.
static int	affectedRows () Gets the number of affected rows. Alias for getAffectedRows().
static void	begin ([string `$savepoint` = `NULL`]) Begins a transaction - Monostate for DibiConnection::begin().
static DibiFluent	command ()
static void	commit ([string `$savepoint` = `NULL`]) Commits statements in a transaction - Monostate for DibiConnection::commit($savepoint = NULL).
static DibiConnection	connect ([array\|string\|ArrayObject `$config` = `array()`], [string `$name` = `0`]) Creates a new DibiConnection object and connects it to specified database.
static DibiDataSource	dataSource (array\|mixed `$args`) Generates and returns SQL query as DibiDataSource - Monostate for DibiConnection::test().
static void	date ([`$date` = `NULL`])
static void	datetime ([`$time` = `NULL`])
static mixed	defaultSubstFallback (string `$expr`) Default substitution fallback handler.
static DibiFluent	delete (string `$table`)
static void	disconnect () Disconnects from database (doesn't destroy DibiConnection object).
static string	dump ([string\|DibiResult `$sql` = `NULL`], [bool `$return` = `FALSE`]) Prints out a syntax highlighted version of the SQL command or DibiResult.
static DibiRow	fetch (array\|mixed `$args`) Executes SQL query and fetch result - Monostate for DibiConnection::query() & fetch().
static array	fetchAll (array\|mixed `$args`) Executes SQL query and fetch results - Monostate for DibiConnection::query() & fetchAll().
static string	fetchPairs (array\|mixed `$args`) Executes SQL query and fetch pairs - Monostate for DibiConnection::query() & fetchPairs().
static string	fetchSingle (array\|mixed `$args`) Executes SQL query and fetch first column - Monostate for DibiConnection::query() & fetchSingle().
static int	getAffectedRows () Gets the number of affected rows.
static string	getColophon ([`$sender` = `NULL`]) Returns brief descriptions.
static DibiConnection	getConnection ([string `$name` = `NULL`]) Retrieve active connection.
static DibiDatabaseInfo	getDatabaseInfo () Gets a information about the current database - Monostate for DibiConnection::getDatabaseInfo().
static int	getInsertId ([string `$sequence` = `NULL`]) Retrieves the ID generated for an AUTO_INCREMENT column by the previous INSERT query.
static IDibiProfiler	getProfiler () Retrieve active connection profiler.
static DibiFluent	insert (string `$table`, array `$args`)
static int	insertId ([string `$sequence` = `NULL`]) Retrieves the ID generated for an AUTO_INCREMENT column. Alias for getInsertId().
static bool	isConnected () Returns TRUE when connection was established.
static int	loadFile (string `$file`) Import SQL dump from file - extreme fast!
static DibiResult\|int	nativeQuery (string `$sql`) Executes the SQL query - Monostate for DibiConnection::nativeQuery().
static DibiResult\|int	query (array\|mixed `$args`) Generates and executes SQL query - Monostate for DibiConnection::query().
static void	removeSubst (mixed `$expr`) Remove substitution pair.
static void	rollback ([string `$savepoint` = `NULL`]) Rollback changes in a transaction - Monostate for DibiConnection::rollback().
static DibiFluent	select (string `$args`)
static void	setSubstFallback (callback `$callback`) Sets substitution fallback handler.
static bool	test (array\|mixed `$args`) Generates and prints SQL query - Monostate for DibiConnection::test().
static DibiFluent	update (string `$table`, array `$args`)
static void	__callStatic (`$name`, `$args`) Replacement for majority of dibi::methods() in future.

Constant Summary
string	`ASC`	`'ASC'`	line 156 Configuration options
string	`BINARY`	`'bin'`	line 121 dibi data type
string	`BOOL`	`'b'`	line 122 dibi data type
string	`DATE`	`'d'`	line 125 dibi data type
string	`DATETIME`	`'t'`	line 126 dibi data type
string	`DESC`	`'DESC'`	line 156 Configuration options
string	`FIELD_BINARY`	`self::BINARY`	line 135
string	`FIELD_BOOL`	`self::BOOL`	line 136
string	`FIELD_DATE`	`self::DATE`	line 139
string	`FIELD_DATETIME`	`self::DATETIME`	line 140
string	`FIELD_FLOAT`	`self::FLOAT`	line 138
string	`FIELD_INTEGER`	`self::INTEGER`	line 137
string	`FIELD_TEXT`	`self::TEXT`	line 134
string	`FIELD_TIME`	`self::TIME`	line 141
string	`FLOAT`	`'f'`	line 124 dibi data type
string	`IDENTIFIER`	`'n'`	line 128 dibi data type
string	`INTEGER`	`'i'`	line 123 dibi data type
string	`RESULT_DATE_TIME`	`'resultDateTime'`	line 155 Configuration options
string	`RESULT_DETECT_TYPES`	`'resultDetectTypes'`	line 154 Configuration options
string	`REVISION`	`'0b95624 released on 2010-02-24'`	line 148 dibi version
string	`TEXT`	`'s'`	line 120 dibi data type
string	`TIME`	`'t'`	line 127 dibi data type
string	`VERSION`	`'1.3-dev'`	line 147 dibi version

Variable Summary
static string	`$defaultDriver`	`'mysql'`	line 187 Default dibi driver
static int	`$elapsedTime`		line 178 Elapsed time for last query
static int	`$numOfQueries`	`0`	line 184 Number or queries
static string	`$sql`		line 175 Last SQL command @see dibi::query()
static callback	`$substFallBack`	`array(__CLASS__, 'defaultSubstFallback')`	line 169 Substitution fallback
static array	`$substs`	`array()`	line 166 Substitutions for identifiers
static int	`$totalTime`		line 181 Elapsed time for all queries

Constructor Details

line 194

__construct

public __construct ()

Static class - cannot be instantiated.

Method Details

line 272

activate

public static void activate (string $name)

Change active connection.

Input
string	`$name`	connection registy name
Output
void
Throws
throws	DibiException

line 625

addSubst

public static void addSubst (string $expr, string $subst)

Create a new substitution pair for indentifiers.

Input
string	`$expr`	from
string	`$subst`	to
Output
void

line 421

affectedRows

public static int affectedRows ()

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

Output
int	number of rows
Throws
throws	DibiException

line 461

begin

public static void begin ([string $savepoint = NULL])

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

Input
string	`$savepoint`	optional savepoint name
Output
void
Throws
throws	DibiException

line 537

command

public static DibiFluent command ()

Output
DibiFluent

line 474

commit

public static void commit ([string $savepoint = NULL])

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

Input
string	`$savepoint`	optional savepoint name
Output
void
Throws
throws	DibiException

line 212

connect

public static DibiConnection connect ([array|string|ArrayObject $config = array()], [string $name = 0])

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

Input
array\|string\|ArrayObject	`$config`	connection parameters
string	`$name`	connection name
Output
DibiConnection
Throws
throws	DibiException

line 339

dataSource

public static DibiDataSource dataSource (array|mixed $args)

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

Input
array\|mixed	`$args`	one or more arguments
Output
DibiDataSource

line 608

date

public static void date ([$date = NULL])

Input
	`$date`
Output
void
Tags
Deprecated

line 598

datetime

public static void datetime ([$time = NULL])

Input
	`$time`
Output
void
Tags
Deprecated

line 670

defaultSubstFallback

public static mixed defaultSubstFallback (string $expr)

Default substitution fallback handler.

Input
string	`$expr`
Output
mixed

line 584

delete

public static DibiFluent delete (string $table)

Input
string	`$table`	table
Output
DibiFluent

line 223

disconnect

public static void disconnect ()

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

Output
void

line 687

dump

public static string dump ([string|DibiResult $sql = NULL], [bool $return = FALSE])

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

Input
string\|DibiResult	`$sql`
bool	`$return`	return output instead of printing it?
Output
string

line 353

fetch

public static DibiRow fetch (array|mixed $args)

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

Input
array\|mixed	`$args`	one or more arguments
Output
DibiRow
Throws
throws	DibiException

line 367

fetchAll

public static array fetchAll (array|mixed $args)

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

Input
array\|mixed	`$args`	one or more arguments
Output
array	of DibiRow
Throws
throws	DibiException

line 395

fetchPairs

public static string fetchPairs (array|mixed $args)

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

Input
array\|mixed	`$args`	one or more arguments
Output
string
Throws
throws	DibiException

line 381

fetchSingle

public static string fetchSingle (array|mixed $args)

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

Input
array\|mixed	`$args`	one or more arguments
Output
string
Throws
throws	DibiException

line 409

getAffectedRows

public static int getAffectedRows ()

Gets the number of affected rows.

Monostate for DibiConnection::getAffectedRows()

Output
int	number of rows
Throws
throws	DibiException

line 747

getColophon

public static string getColophon ([$sender = NULL])

Returns brief descriptions.

Input
	`$sender`
Output
string

line 247

getConnection

public static DibiConnection getConnection ([string $name = NULL])

Retrieve active connection.

Input
string	`$name`	connection registy name
Output
DibiConnection
Throws
throws	DibiException

line 498

getDatabaseInfo

public static DibiDatabaseInfo getDatabaseInfo ()

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

Output
DibiDatabaseInfo

line 435

getInsertId

public static int getInsertId ([string $sequence = NULL])

Retrieves the ID generated for an AUTO_INCREMENT column by the previous INSERT query.

Monostate for DibiConnection::getInsertId()

Input
string	`$sequence`	optional sequence name
Output
int
Throws
throws	DibiException

line 284

getProfiler

public static IDibiProfiler getProfiler ()

Retrieve active connection profiler.

Output
IDibiProfiler
Throws
throws	DibiException

line 573

insert

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

Input
string	`$table`	table
array	`$args`
Output
DibiFluent

line 448

insertId

public static int insertId ([string $sequence = NULL])

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

Input
string	`$sequence`	optional sequence name
Output
int
Throws
throws	DibiException

line 234

isConnected

public static bool isConnected ()

Returns TRUE when connection was established.

Output
bool

line 510

loadFile

public static int loadFile (string $file)

Import SQL dump from file - extreme fast!

Input
string	`$file`	filename
Output
int	count of sql commands

line 314

nativeQuery

public static DibiResult|int nativeQuery (string $sql)

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

Input
string	`$sql`	SQL statement.
Output
DibiResult\|int	result set object (if any)

line 301

query

public static DibiResult|int query (array|mixed $args)

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

Input
array\|mixed	`$args`	one or more arguments
Output
DibiResult\|int	result set object (if any)
Throws
throws	DibiException

line 637

removeSubst

public static void removeSubst (mixed $expr)

Remove substitution pair.

Input
mixed	`$expr`	from or TRUE
Output
void

line 487

rollback

public static void rollback ([string $savepoint = NULL])

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

Input
string	`$savepoint`	optional savepoint name
Output
void
Throws
throws	DibiException

line 548

select

public static DibiFluent select (string $args)

Input
string	`$args`	column name
Output
DibiFluent

line 653

setSubstFallback

public static void setSubstFallback (callback $callback)

Sets substitution fallback handler.

Input
callback	`$callback`
Output
void

line 326

test

public static bool test (array|mixed $args)

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

Input
array\|mixed	`$args`	one or more arguments
Output
bool

line 561

update

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

Input
string	`$table`	table
array	`$args`
Output
DibiFluent

line 520

__callStatic

public static void __callStatic ($name, $args)

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

Input
	`$name`
	`$args`
Output
void

dibi API documentation