Mysql
extends DriverBase
in package
Represents the MySQL 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() : Mysql
- Connects to the MySQL database using the provided parameters.
- disconnect() : void
- Disconnects from the database.
- driverSupportsLastInsertId() : bool
- Checks if the MySQL driver supports the last insert ID feature.
- getDeleteSql() : string
- Generates a DELETE SQL statement for the specified table and WHERE clause.
- 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 string for retrieving the list of tables in the MySQL database.
- getLimitSql() : string
- Returns the SQL query string for applying a limit to the result set.
- getPdo() : PDO
- Returns the PDO object representing the database connection.
Properties
$driver
protected
string
$driver
= 'mysql'
$dsnParams
protected
array<string, string>
$dsnParams
= []
The array to store the connection details.
$password
protected
string
$password
$pdo
protected
PDO|null
$pdo
= null
$username
protected
string
$username
Methods
connect()
Connects to the MySQL database using the provided parameters.
public
connect(array<string, string> $dsnParams, string $username, string $password) : Mysql
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
Mysql —The Mysql object representing the database driver.
disconnect()
Disconnects from the database.
public
disconnect() : void
driverSupportsLastInsertId()
Checks if the MySQL 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 a DELETE SQL statement for the specified table and WHERE clause.
public
getDeleteSql(string $table, string $where) : string
Parameters
- $table : string
-
The name of the table.
- $where : string
-
The WHERE clause of the SQL statement.
Return values
string —The generated DELETE SQL statement.
getDriver()
Returns the driver name for the connection.
public
getDriver() : string
Return values
string —The driver name.
getDriverColumnName()
Returns the name of the driver column.
public
getDriverColumnName() : string
Return values
string —The name of the driver column.
getGetColumnsSql()
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()
Returns the SQL query string for retrieving the list of tables in the MySQL 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.
public
getLimitSql(string $limit) : string
Parameters
- $limit : string
-
The limit value.
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.