class FirebirdDriver implements Driver

The driver for Firebird/InterBase database.

Driver options:

  • database => the path to database file (server:/path/database.fdb)
  • username (or user)
  • password (or pass)
  • charset => character encoding to set
  • buffers (int) => buffers is the number of database buffers to allocate for the server-side cache. If 0 or omitted, server chooses its own default.
  • resource (resource) => existing connection resource

Constants

ERROR_EXCEPTION_THROWN

Methods

__construct(array $config)

No description

void
disconnect()

Disconnects from a database.

ResultDriver|null
query(string $sql)

Executes the SQL query.

int|null
getAffectedRows()

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

int|null
getInsertId(string|null $sequence)

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

void
begin(string|null $savepoint = null)

Begins a transaction (if supported).

void
commit(string|null $savepoint = null)

Commits statements in a transaction.

void
rollback(string|null $savepoint = null)

Rollback changes in a transaction.

bool
inTransaction()

Is in transaction?

mixed
getResource()

Returns the connection resource.

getReflector()

Returns the connection reflector.

createResultDriver(resource $resource)

Result set driver factory.

string
escapeText(string $value)

Encodes data for use in a SQL statement.

string
escapeBinary(string $value)

No description

string
escapeIdentifier(string $value)

No description

string
escapeBool(bool $value)

No description

string
escapeDate(DateTimeInterface $value)

No description

string
escapeDateTime(DateTimeInterface $value)

No description

string
escapeDateInterval(DateInterval $value)

No description

string
escapeLike(string $value, int $pos)

Encodes string for use in a LIKE statement.

void
applyLimit(string $sql, int|null $limit, int|null $offset)

Injects LIMIT/OFFSET to the SQL query.

Details

at line 43
__construct(array $config)

No description

Parameters

array $config

Exceptions

NotSupportedException

at line 78
void disconnect()

Disconnects from a database.

Return Value

void

at line 88
ResultDriver|null query(string $sql)

Executes the SQL query.

Parameters

string $sql

Return Value

ResultDriver|null

Exceptions

Exception

at line 114
int|null getAffectedRows()

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

Return Value

int|null

at line 123
int|null getInsertId(string|null $sequence)

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

Parameters

string|null $sequence

Return Value

int|null

at line 133
void begin(string|null $savepoint = null)

Begins a transaction (if supported).

Parameters

string|null $savepoint

Return Value

void

Exceptions

DriverException

at line 148
void commit(string|null $savepoint = null)

Commits statements in a transaction.

Parameters

string|null $savepoint

Return Value

void

Exceptions

DriverException

at line 166
void rollback(string|null $savepoint = null)

Rollback changes in a transaction.

Parameters

string|null $savepoint

Return Value

void

Exceptions

DriverException

at line 183
bool inTransaction()

Is in transaction?

Return Value

bool

at line 193
mixed getResource()

Returns the connection resource.

Return Value

mixed

at line 202
Reflector getReflector()

Returns the connection reflector.

Return Value

Reflector

at line 212
FirebirdResult createResultDriver(resource $resource)

Result set driver factory.

Parameters

resource $resource

Return Value

FirebirdResult

at line 224
string escapeText(string $value)

Encodes data for use in a SQL statement.

Parameters

string $value

Return Value

string

at line 230
string escapeBinary(string $value)

No description

Parameters

string $value

Return Value

string

at line 236
string escapeIdentifier(string $value)

No description

Parameters

string $value

Return Value

string

at line 242
string escapeBool(bool $value)

No description

Parameters

bool $value

Return Value

string

at line 248
string escapeDate(DateTimeInterface $value)

No description

Parameters

DateTimeInterface $value

Return Value

string

at line 254
string escapeDateTime(DateTimeInterface $value)

No description

Parameters

DateTimeInterface $value

Return Value

string

at line 260
string escapeDateInterval(DateInterval $value)

No description

Parameters

DateInterval $value

Return Value

string

at line 269
string escapeLike(string $value, int $pos)

Encodes string for use in a LIKE statement.

Parameters

string $value
int $pos

Return Value

string

at line 279
void applyLimit(string $sql, int|null $limit, int|null $offset)

Injects LIMIT/OFFSET to the SQL query.

Parameters

string $sql
int|null $limit
int|null $offset

Return Value

void

Traits

Better OOP experience.