Documentation

IDBConnection extends IPDOConnection

Defines a generic database connection

Table of Contents

getConnectionId() A unique connection id generated each time a new instance of some IDBConnection is created. Implementations MUST ensure the returned value is unique. string
forwardCursor() Create a forward-only cursor. Used to stream database results. Generator
select() Select some stuff from some database Generator
execute() Execute some query with no result set. int
insert() Build an insert query using a prepared statement. int
update() Build an update query using a prepared statement. int
delete() Execute a delete query for a record using a compound key. int
prepareIn() This will prepare a list of integers or a single int for a prepared sql query. This returns '(?)' if $val is an int and '(?,?,...)' if $val is an int[]. if $val is an array and it is not all ints then an InvalidArgumentException is thrown. string
extractRow() This will extract a columns prefixed by a prefix in prefixList. array
getProperties() Access the args IConnectionProperties
close() Close the database connection void
selectdb() Select the current database void
curdb() Returns the current database being used string
multiSelect() Execute a sql statement that has multiple result sets ie: a stored procedure that has multiple selects, or one of those snazzy subquery statements Generator
getLastStatement() Retrieve the last sql statement that was used string
getLastOpts() Retrieve the last set of options used array
setAutoCommit() Set auto commit if supported by the driver. void

Methods

getConnectionId()

A unique connection id generated each time a new instance of some IDBConnection is created. Implementations MUST ensure the returned value is unique.

public getConnectionId( ) : string
Return values
string —

id

forwardCursor()

Create a forward-only cursor. Used to stream database results.

public forwardCursor( $statement : string [, $options : array = null ] [, $scroll : bool = false ] ) : Generator
Parameters
$statement : string

sql statement

$options : array = null

bindings. object or array

$scroll : bool = false

scroll

Return values
Generator —

Results rows

select()

Select some stuff from some database

public select( $statement : string [, $opt : type = null ] ) : Generator
Parameters
$statement : string

sql statement

$opt : type = null

Bindings for prepared statement. This can be an object or an array

Return values
Generator

execute()

Execute some query with no result set.

public execute( $statement : string [, $opt : array|object = null ] ) : int
Parameters
$statement : string

Query

$opt : array|object = null

Bindings

Return values
int —

Affected rows

insert()

Build an insert query using a prepared statement.

public insert( $table : string , $pairs : array ) : int

This will work for most queries, but if you need to do something super complicated, write your own sql...

Parameters
$table : string

Table name

$pairs : array

Column names and values map

Tags
throws
InvalidArgumentException
throws
DBException
Return values
int —

last insert id for updates

update()

Build an update query using a prepared statement.

public update( $table : string , $pkPairs : array , $pairs : array [, $limit : int = 1 ] ) : int
Parameters
$table : string

Table name

$pkPairs : array

list of [primary key => value] for locating records to update.

$pairs : array

Column names and values map

$limit : int = 1

Limit to this number

Tags
throws
InvalidArgumentException
throws
DBException
Return values
int —

the number of affected rows

delete()

Execute a delete query for a record using a compound key.

public delete( $table : string , $pkCols : array [, $limit : int = 1 ] ) : int
Parameters
$table : string

table name

$pkCols : array
$limit : int = 1

limit

Tags
throws
InvalidArgumentExcepton

if table or col or id are empty or if col contains invalid characters or if limit is not an integer or is less than one

throws
DBException

if there is a problem executing the query

Return values
int —

affected rows

prepareIn()

This will prepare a list of integers or a single int for a prepared sql query. This returns '(?)' if $val is an int and '(?,?,...)' if $val is an int[]. if $val is an array and it is not all ints then an InvalidArgumentException is thrown.

public prepareIn( $val : int|array [, $allInt : bool = true ] ) : string
Parameters
$val : int|array

value to use

$allInt : bool = true

set to false to toggle off int checking

Tags
throws
InvalidArgumentException

if val is invalid

Return values
string —

in statement

extractRow()

This will extract a columns prefixed by a prefix in prefixList.

public extractRow( $prefixList : array , $data : array ) : array

The returned array will contain an array for each prefix in the list. If any columsn match the format prefixxxx the the column name will have the prefix removed and be added to the output list that matches the prefix in the list.

Parameters
$prefixList : array

List of prefixes to extract

$data : array

Row data

Return values
array —

columns

selectdb()

Select the current database

public selectdb( $db : string ) : void
Parameters
$db : string

Database name

curdb()

Returns the current database being used

public curdb( ) : string
Return values
string —

Current database name

multiSelect()

Execute a sql statement that has multiple result sets ie: a stored procedure that has multiple selects, or one of those snazzy subquery statements

public multiSelect( $sql : string ) : Generator
Parameters
$sql : string

SQL statement to execute

Tags
throws
DBException

if there is one

Return values
Generator —

array results

getLastStatement()

Retrieve the last sql statement that was used

public getLastStatement( ) : string
Return values
string —

last statement

getLastOpts()

Retrieve the last set of options used

public getLastOpts( ) : array
Return values
array —

opts

setAutoCommit()

Set auto commit if supported by the driver.

public setAutoCommit( $on : bool ) : void
Parameters
$on : bool

on or off

Search results