Documentation

Menu

## Oci extends DriverBase
in package

Oci.php : 15

Represents the Oracle driver for the PDO database class.

### Table of Contents

#### Properties

$driver : string
$dsnParams : array<string, string>
$password : string
$pdo : PDO|null
$username : string

#### Methods

connect() : Oci
  Connects to the Oracle database using the provided parameters.
disconnect() : void
  Disconnects from the database.
driverSupportsLastInsertId() : bool
  Checks if the OCI driver supports the last insert ID feature.
getDeleteSql() : string
  Generates the SQL statement for deleting records from a table based on a given condition.
getDriver() : string
  Returns the driver name for the connection.
getDriverColumnName() : string
  Returns the name of the driver column.
getGetColumnsSql() : string
  Returns the SQL query to retrieve the columns of a table.
getGetTablesSql() : string
  Returns the SQL query to retrieve the list of tables in the Oracle database.
getLimitSql() : string
  Returns the SQL query string for applying a limit to a query for the Oracle OCI driver.
getPdo() : PDO
  Returns the PDO object representing the database connection.

### Properties

#### $driver

Oci.php : 19
`protected string $driver = 'oci'`

#### $dsnParams

DriverBase.php : 21
`protected array<string, string> $dsnParams = []`

The array to store the connection details.

#### $password

DriverBase.php : 25
`protected string $password`

#### $pdo

Oci.php : 17
`protected PDO|null $pdo = null`

#### $username

DriverBase.php : 23
`protected string $username`

### Methods

#### connect()

Oci.php : 29

Connects to the Oracle database using the provided parameters.

`public connect(array<string, string> $dsnParams, string $username, string $password) : Oci`

##### Parameters

$dsnParams : array<string, string>

  The parameters for the DSN connection string.

$username : string

  The username for the database connection.

$password : string

  The password for the database connection.

##### Return values

Oci —

The Oci object representing the database driver.

#### disconnect()

DriverBase.php : 40

Disconnects from the database.

`public disconnect() : void`

#### driverSupportsLastInsertId()

Oci.php : 82

Checks if the OCI driver supports the last insert ID feature.

`public driverSupportsLastInsertId() : bool`

##### Return values

bool —

Returns true if the OCI driver supports last insert ID, false otherwise.

#### getDeleteSql()

Oci.php : 109

Generates the SQL statement for deleting records from a table based on a given condition.

`public getDeleteSql(string $table, string $where) : string`

##### Parameters

$table : string

  The name of the table from which to delete records.

$where : string

  The condition used to determine which records to delete.

##### Return values

string —

The generated SQL statement for deleting records.

#### getDriver()

DriverBase.php : 50

Returns the driver name for the connection.

`public getDriver() : string`

##### Return values

string —

The driver name.

#### getDriverColumnName()

Oci.php : 130

Returns the name of the driver column.

`public getDriverColumnName() : string`

##### Return values

string —

The name of the driver column.

#### getGetColumnsSql()

Oci.php : 93

Returns the SQL query to retrieve the columns of a table.

`public getGetColumnsSql(string $table) : string`

##### Parameters

$table : string

  The name of the table.

##### Return values

string —

The SQL query to retrieve the columns of the table.

#### getGetTablesSql()

Oci.php : 140

Returns the SQL query to retrieve the list of tables in the Oracle database.

`public getGetTablesSql() : string`

##### Return values

string —

The SQL query to retrieve the list of tables.

#### getLimitSql()

Oci.php : 151

Returns the SQL query string for applying a limit to a query for the Oracle OCI driver.

`public getLimitSql(string $limit) : string`

##### Parameters

$limit : string

  The limit value.

##### Return values

string —

The SQL query string with the applied limit.

#### getPdo()

DriverBase.php : 60

Returns the PDO object representing the database connection.

`public getPdo() : PDO`

##### Return values

PDO —

The PDO object representing the database connection.

## Search results