1. class
  2. Dibi
  3. \
  4. Drivers
  5. \
  6. MySqliDriver

MySqliDriver

class MySqliDriver implements Driver, ResultDriver

The driver for MySQL database.

Driver options:

  • host => the MySQL server host name
  • port (int) => the port number to attempt to connect to the MySQL server
  • socket => the socket or named pipe
  • username (or user)
  • password (or pass)
  • database => the database name to select
  • options (array) => array of driver specific constants (MYSQLI_*) and values {\Dibi\Drivers\mysqli_options}
  • flags (int) => driver specific constants (MYSQLICLIENT*) {\Dibi\Drivers\mysqli_real_connect}
  • charset => character encoding to set (default is utf8)
  • persistent (bool) => try to find a persistent link?
  • unbuffered (bool) => sends query without fetching and buffering the result rows automatically?
  • sqlmode => see http://dev.mysql.com/doc/refman/5.0/en/server-sql-mode.html
  • resource (mysqli) => existing connection resource

Constants

ERROR_ACCESS_DENIED

ERROR_DUPLICATE_ENTRY

ERROR_DATA_TRUNCATED

Methods

__construct()

No description

void
connect(array $config)

Connects to a database.

void
disconnect()

Disconnects from a database.

ResultDriver|null
query($sql)

Executes the SQL query.

static DriverException
createException($message, $code, $sql)

No description

array
getInfo()

Retrieves information about the most recently executed query.

int|false
getAffectedRows()

Gets the number of affected rows by the last INSERT, UPDATE or DELETE query.

int|false
getInsertId($sequence)

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

void
begin($savepoint = null)

Begins a transaction (if supported).

void
commit($savepoint = null)

Commits statements in a transaction.

void
rollback($savepoint = null)

Rollback changes in a transaction.

mixed
getResource()

Returns the connection resource.

Reflector
getReflector()

Returns the connection reflector.

ResultDriver
createResultDriver(mysqli_result $resource)

Result set driver factory.

string
escapeText($value)

Encodes data for use in a SQL statement.

string
escapeBinary($value)

No description

string
escapeIdentifier($value)

No description

string
escapeBool($value)

No description

string
escapeDate($value)

No description

string
escapeDateTime($value)

No description

string
escapeLike($value, $pos)

Encodes string for use in a LIKE statement.

string
unescapeBinary($value)

Decodes data from result set.

escape($value, $type) deprecated

No description

void
applyLimit($sql, $limit, $offset)

Injects LIMIT/OFFSET to the SQL query.

void
__destruct()

Automatically frees the resources allocated for this result set.

int
getRowCount()

Returns the number of rows in a result set.

array
fetch($assoc)

Fetches the row at current position and moves the internal cursor to the next position.

bool
seek($row)

Moves cursor position without fetching row.

void
free()

Frees the resources allocated for this result set.

array
getResultColumns()

Returns metadata for all columns in a result set.

mixed
getResultResource()

Returns the result set resource.

Details

at line 57
__construct()

No description

Exceptions

NotSupportedException

at line 70
void connect(array $config)

Connects to a database.

Parameters

array $config

Return Value

void

Exceptions

Exception

at line 135
void disconnect()

Disconnects from a database.

Return Value

void

at line 147
ResultDriver|null query($sql)

Executes the SQL query.

Parameters

$sql

Return Value

ResultDriver|null

Exceptions

DriverException

at line 164
static DriverException createException($message, $code, $sql)

No description

Parameters

$message
$code
$sql

Return Value

DriverException

at line 185
array getInfo()

Retrieves information about the most recently executed query.

Return Value

array

at line 204
int|false getAffectedRows()

Gets the number of affected rows by the last INSERT, UPDATE or DELETE query.

Return Value

int|false

number of rows or false on error

at line 214
int|false getInsertId($sequence)

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

Parameters

$sequence

Return Value

int|false

int on success or false on failure

at line 226
void begin($savepoint = null)

Begins a transaction (if supported).

Parameters

$savepoint

Return Value

void

Exceptions

DriverException

at line 238
void commit($savepoint = null)

Commits statements in a transaction.

Parameters

$savepoint

Return Value

void

Exceptions

DriverException

at line 250
void rollback($savepoint = null)

Rollback changes in a transaction.

Parameters

$savepoint

Return Value

void

Exceptions

DriverException

at line 260
mixed getResource()

Returns the connection resource.

Return Value

mixed

at line 270
Reflector getReflector()

Returns the connection reflector.

Return Value

Reflector

at line 280
ResultDriver createResultDriver(mysqli_result $resource)

Result set driver factory.

Parameters

mysqli_result $resource

Return Value

ResultDriver

at line 296
string escapeText($value)

Encodes data for use in a SQL statement.

Parameters

$value

Return Value

string

encoded value

at line 306
string escapeBinary($value)

No description

Parameters

$value

Return Value

string

at line 316
string escapeIdentifier($value)

No description

Parameters

$value

Return Value

string

at line 326
string escapeBool($value)

No description

Parameters

$value

Return Value

string

at line 336
string escapeDate($value)

No description

Parameters

$value

Return Value

string

at line 349
string escapeDateTime($value)

No description

Parameters

$value

Return Value

string

at line 364
string escapeLike($value, $pos)

Encodes string for use in a LIKE statement.

Parameters

$value
$pos

Return Value

string

at line 376
string unescapeBinary($value)

Decodes data from result set.

Parameters

$value

Return Value

string

at line 383
escape($value, $type) deprecated

deprecated

No description

Parameters

$value
$type

at line 397
void applyLimit($sql, $limit, $offset)

Injects LIMIT/OFFSET to the SQL query.

Parameters

$sql
$limit
$offset

Return Value

void

at line 417
void __destruct()

Automatically frees the resources allocated for this result set.

Return Value

void

at line 429
int getRowCount()

Returns the number of rows in a result set.

Return Value

int

at line 443
array fetch($assoc)

Fetches the row at current position and moves the internal cursor to the next position.

Parameters

$assoc

Return Value

array

array on success, nonarray if no next record

at line 455
bool seek($row)

Moves cursor position without fetching row.

Parameters

$row

Return Value

bool

true on success, false if unable to seek to specified record

Exceptions

Exception

at line 468
void free()

Frees the resources allocated for this result set.

Return Value

void

at line 479
array getResultColumns()

Returns metadata for all columns in a result set.

Return Value

array

of {name, nativetype [, table, fullname, (int) size, (bool) nullable, (mixed) default, (bool) autoincrement, (array) vendor ]}

at line 514
mixed getResultResource()

Returns the result set resource.

Return Value

mixed

Traits

Strict

Better OOP experience.