class OracleDriver implements Driver

The driver for Oracle database.

Driver options:

  • database => the name of the local Oracle instance or the name of the entry in tnsnames.ora
  • username (or user)
  • password (or pass)
  • charset => character encoding to set
  • schema => alters session schema
  • nativeDate => use native date format (defaults to true)
  • resource (resource) => existing connection resource
  • persistent => Creates persistent connections with oci_pconnect instead of oci_new_connect

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

No description

Parameters

array $config

Exceptions

NotSupportedException

at line 75
void disconnect()

Disconnects from a database.

Return Value

void

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

Executes the SQL query.

Parameters

string $sql

Return Value

ResultDriver|null

Exceptions

DriverException

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

No description

Parameters

string $message
$code
string $sql

Return Value

DriverException

at line 130
int|null getAffectedRows()

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

Return Value

int|null

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

Begins a transaction (if supported).

Parameters

string|null $savepoint

Return Value

void

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

Commits statements in a transaction.

Parameters

string|null $savepoint

Return Value

void

Exceptions

DriverException

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

Rollback changes in a transaction.

Parameters

string|null $savepoint

Return Value

void

Exceptions

DriverException

at line 189
mixed getResource()

Returns the connection resource.

Return Value

mixed

at line 198
Reflector getReflector()

Returns the connection reflector.

Return Value

Reflector

at line 208
OracleResult createResultDriver(resource $resource)

Result set driver factory.

Parameters

resource $resource

Return Value

OracleResult

at line 220
string escapeText(string $value)

Encodes data for use in a SQL statement.

Parameters

string $value

Return Value

string

at line 226
string escapeBinary(string $value)

No description

Parameters

string $value

Return Value

string

at line 232
string escapeIdentifier(string $value)

No description

Parameters

string $value

Return Value

string

at line 239
string escapeBool(bool $value)

No description

Parameters

bool $value

Return Value

string

at line 245
string escapeDate(DateTimeInterface $value)

No description

Parameters

DateTimeInterface $value

Return Value

string

at line 253
string escapeDateTime(DateTimeInterface $value)

No description

Parameters

DateTimeInterface $value

Return Value

string

at line 261
string escapeDateInterval(DateInterval $value)

No description

Parameters

DateInterval $value

Return Value

string

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

Encodes string for use in a LIKE statement.

Parameters

string $value
int $pos

Return Value

string

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