interface Driver

Driver interface.

Methods

void
disconnect()

Disconnects from a database.

ResultDriver|null
query(string $sql)

Internal: 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 $savepoint = null)

Begins a transaction (if supported).

void
commit(string $savepoint = null)

Commits statements in a transaction.

void
rollback(string $savepoint = null)

Rollback changes in a transaction.

mixed
getResource()

Returns the connection resource.

getReflector()

Returns the connection reflector.

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 32
void disconnect()

Disconnects from a database.

Return Value

void

Exceptions

Exception

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

Internal: Executes the SQL query.

Parameters

string $sql

Return Value

ResultDriver|null

Exceptions

DriverException

at line 43
int|null getAffectedRows()

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

Return Value

int|null

at line 48
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 54
void begin(string $savepoint = null)

Begins a transaction (if supported).

Parameters

string $savepoint

Return Value

void

Exceptions

DriverException

at line 60
void commit(string $savepoint = null)

Commits statements in a transaction.

Parameters

string $savepoint

Return Value

void

Exceptions

DriverException

at line 66
void rollback(string $savepoint = null)

Rollback changes in a transaction.

Parameters

string $savepoint

Return Value

void

Exceptions

DriverException

at line 72
mixed getResource()

Returns the connection resource.

Return Value

mixed

at line 77
Reflector getReflector()

Returns the connection reflector.

Return Value

Reflector

at line 82
string escapeText(string $value)

Encodes data for use in a SQL statement.

Parameters

string $value

Return Value

string

at line 84
string escapeBinary(string $value)

Parameters

string $value

Return Value

string

at line 86
string escapeIdentifier(string $value)

Parameters

string $value

Return Value

string

at line 88
string escapeBool(bool $value)

Parameters

bool $value

Return Value

string

at line 90
string escapeDate(DateTimeInterface $value)

Parameters

DateTimeInterface $value

Return Value

string

at line 92
string escapeDateTime(DateTimeInterface $value)

Parameters

DateTimeInterface $value

Return Value

string

at line 94
string escapeDateInterval(DateInterval $value)

Parameters

DateInterval $value

Return Value

string

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

Encodes string for use in a LIKE statement.

Parameters

string $value
int $pos

Return Value

string

at line 104
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