Documentation

Firebird extends DriverBase
in package

Represents the Firebird 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()  : Firebird
Connects to the firebird database using the provided parameters.
disconnect()  : void
Disconnects from the database.
driverSupportsLastInsertId()  : bool
Checks if the Firebird 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 column used by the Firebird driver.
getGetColumnsSql()  : string
Returns the SQL query to retrieve the columns of a table in the Firebird database.
getGetTablesSql()  : string
Returns the SQL query string for retrieving the list of tables in the Firebird database.
getLimitSql()  : string
Returns the SQL query string for applying a limit to the result set, specific to the Firebird driver.
getPdo()  : PDO
Returns the PDO object representing the database connection.

Properties

$driver

protected string $driver = 'firebird'

$dsnParams

protected array<string, string> $dsnParams = []

The array to store the connection details.

Methods

connect()

Connects to the firebird database using the provided parameters.

public connect(array<string, string> $dsnParams, string $username, string $password) : Firebird
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
Firebird

The Firebird object representing the database driver.

disconnect()

Disconnects from the database.

public disconnect() : void

driverSupportsLastInsertId()

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

public driverSupportsLastInsertId() : bool
Return values
bool

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

getDeleteSql()

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 to delete records from.

$where : string

The condition to specify which records to delete.

Return values
string

The generated SQL statement for deleting records.

getDriver()

Returns the driver name for the connection.

public getDriver() : string
Return values
string

The driver name.

getDriverColumnName()

Returns the name of the column used by the Firebird driver.

public getDriverColumnName() : string
Return values
string

The name of the column.

getGetColumnsSql()

Returns the SQL query to retrieve the columns of a table in the Firebird database.

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()

Returns the SQL query string for retrieving the list of tables in the Firebird database.

public getGetTablesSql() : string
Return values
string

The SQL query string.

getLimitSql()

Returns the SQL query string for applying a limit to the result set, specific to the Firebird driver.

public getLimitSql(string $limit) : string
Parameters
$limit : string

The limit value to be applied to the query.

Return values
string

The SQL query string with the limit applied.

getPdo()

Returns the PDO object representing the database connection.

public getPdo() : PDO
Return values
PDO

The PDO object representing the database connection.


        
On this page

Search results