class SqliteDriver implements Driver

The driver for SQLite v3 database.

Driver options:

  • database (or file) => the filename of the SQLite3 database
  • formatDate => how to format date in SQL (date)
  • formatDateTime => how to format datetime in SQL (date)
  • resource (SQLite3) => existing connection resource

Methods

__construct(array $config)

No description

void
disconnect()

Disconnects from a database.

ResultDriver|null
query(string $sql)

Executes the SQL query.

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

No description

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(SQLite3Result $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.

void
registerFunction(string $name, callable $callback, int $numArgs = -1)

Registers an user defined function for use in SQL statements.

void
registerAggregateFunction(string $name, callable $rowCallback, callable $agrCallback, int $numArgs = -1)

Registers an aggregating user defined function for use in SQL statements.

Details

at line 38
__construct(array $config)

No description

Parameters

array $config

Exceptions

NotSupportedException

at line 73
void disconnect()

Disconnects from a database.

Return Value

void

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

Executes the SQL query.

Parameters

string $sql

Return Value

ResultDriver|null

Exceptions

DriverException

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

No description

Parameters

string $message
$code
string $sql

Return Value

DriverException

at line 127
int|null getAffectedRows()

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

Return Value

int|null

at line 136
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 146
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 166
void rollback(string|null $savepoint = null)

Rollback changes in a transaction.

Parameters

string|null $savepoint

Return Value

void

Exceptions

DriverException

at line 175
mixed getResource()

Returns the connection resource.

Return Value

mixed

at line 184
Reflector getReflector()

Returns the connection reflector.

Return Value

Reflector

at line 193
SqliteResult createResultDriver(SQLite3Result $result)

Result set driver factory.

Parameters

SQLite3Result $result

Return Value

SqliteResult

at line 205
string escapeText(string $value)

Encodes data for use in a SQL statement.

Parameters

string $value

Return Value

string

at line 211
string escapeBinary(string $value)

No description

Parameters

string $value

Return Value

string

at line 217
string escapeIdentifier(string $value)

No description

Parameters

string $value

Return Value

string

at line 223
string escapeBool(bool $value)

No description

Parameters

bool $value

Return Value

string

at line 229
string escapeDate(DateTimeInterface $value)

No description

Parameters

DateTimeInterface $value

Return Value

string

at line 235
string escapeDateTime(DateTimeInterface $value)

No description

Parameters

DateTimeInterface $value

Return Value

string

at line 241
string escapeDateInterval(DateInterval $value)

No description

Parameters

DateInterval $value

Return Value

string

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

Encodes string for use in a LIKE statement.

Parameters

string $value
int $pos

Return Value

string

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

at line 278
void registerFunction(string $name, callable $callback, int $numArgs = -1)

Registers an user defined function for use in SQL statements.

Parameters

string $name
callable $callback
int $numArgs

Return Value

void

at line 287
void registerAggregateFunction(string $name, callable $rowCallback, callable $agrCallback, int $numArgs = -1)

Registers an aggregating user defined function for use in SQL statements.

Parameters

string $name
callable $rowCallback
callable $agrCallback
int $numArgs

Return Value

void

Traits

Better OOP experience.