mysqliconnectionlibrary
Table of Contents
- connect() : mysqli
- Connects to a database.
- disconnect() : void
- Closes an open database connection.
- cleanString() : string
- Creates an "escape string" to help prevent SQL injection.
- cleanHtmlString() : string
- Creates an "escape string" to help prevent SQL injection - doesn't strip HTML tags.
Functions
connect()
Connects to a database.
connect([string $server = DBSERVER ][, string $username = DBUSER ][, string $password = DBPASS ][, string $databaseName = DBNAME ], int $port[, string $socket = "" ]) : mysqli
Parameters
- $server : string = DBSERVER
-
(Optional) The database server's hostname (Defaults to DBSERVER).
- $username : string = DBUSER
-
(Optional) The database user (Defaults to DBUSER).
- $password : string = DBPASS
-
(Optional) The database user's password (Defaults to DBPASS).
- $databaseName : string = DBNAME
-
(Optional) The database name (Defaults to DBNAME).
- $port : int
-
(Optional) The database port.
- $socket : string = ""
-
(Optional) The database socket.
Return values
mysqli —The database connection object.
disconnect()
Closes an open database connection.
disconnect(mysqli $dBConnection) : void
Parameters
- $dBConnection : mysqli
-
The Database connection object.
Return values
void —cleanString()
Creates an "escape string" to help prevent SQL injection.
cleanString(mysqli $dBConnection, string $string[, string $encoding = "UTF-8" ]) : string
This method will convert HTML to escape sequences.
Parameters
- $dBConnection : mysqli
-
The database connection object currently in use.
- $string : string
-
The String to clean.
- $encoding : string = "UTF-8"
-
(Optional) the encoding of the string (Defaults to UTF-8).
Return values
string —The string.
cleanHtmlString()
Creates an "escape string" to help prevent SQL injection - doesn't strip HTML tags.
cleanHtmlString(mysqli $dBConnection, string $string[, string $encoding = "UTF-8" ]) : string
Parameters
- $dBConnection : mysqli
-
The database connection object currently in use.
- $string : string
-
The String to clean.
- $encoding : string = "UTF-8"
-
(Optional) the encoding of the string (Defaults to UTF-8).
Return values
string —The string.