class PdoDriver implements Driver

The driver for PDO.

Driver options:

  • dsn => driver specific DSN
  • username (or user)
  • password (or pass)
  • options (array) => driver specific options {PDO resource (PDO) => existing connection
  • version

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.

mixed
getResource()

Returns the connection resource.

getReflector()

Returns the connection reflector.

createResultDriver(PDOStatement $result)

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 42
__construct(array $config)

No description

Parameters

array $config

Exceptions

NotSupportedException

at line 80
void disconnect()

Disconnects from a database.

Return Value

void

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

Executes the SQL query.

Parameters

string $sql

Return Value

ResultDriver|null

Exceptions

DriverException

at line 124
int|null getAffectedRows()

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

Return Value

int|null

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

Begins a transaction (if supported).

Parameters

string|null $savepoint

Return Value

void

Exceptions

DriverException

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

Commits statements in a transaction.

Parameters

string|null $savepoint

Return Value

void

Exceptions

DriverException

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

Rollback changes in a transaction.

Parameters

string|null $savepoint

Return Value

void

Exceptions

DriverException

at line 181
mixed getResource()

Returns the connection resource.

Return Value

mixed

at line 190
Reflector getReflector()

Returns the connection reflector.

Return Value

Reflector

at line 219
PdoResult createResultDriver(PDOStatement $result)

Result set driver factory.

Parameters

PDOStatement $result

Return Value

PdoResult

at line 231
string escapeText(string $value)

Encodes data for use in a SQL statement.

Parameters

string $value

Return Value

string

at line 239
string escapeBinary(string $value)

No description

Parameters

string $value

Return Value

string

at line 247
string escapeIdentifier(string $value)

No description

Parameters

string $value

Return Value

string

at line 274
string escapeBool(bool $value)

No description

Parameters

bool $value

Return Value

string

at line 284
string escapeDate(DateTimeInterface $value)

No description

Parameters

DateTimeInterface $value

Return Value

string

at line 290
string escapeDateTime(DateTimeInterface $value)

No description

Parameters

DateTimeInterface $value

Return Value

string

at line 305
string escapeDateInterval(DateInterval $value)

No description

Parameters

DateInterval $value

Return Value

string

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

Encodes string for use in a LIKE statement.

Parameters

string $value
int $pos

Return Value

string

at line 352
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.