Configuration
in package
Database configuration and connection utilities.
Handles loading database configuration from .env files and establishing connections.
Tags
Table of Contents
Methods
- connect() : mysqli
- Make the connection to the database.
- loadFromEnv() : array{server: string, userid: string, passwd: string, dbname: string, socket: string}
- Load database configuration from .env file.
- buildConnectErrorMessage() : string
- Build a helpful error message based on the mysqli connect error code.
Methods
connect()
Make the connection to the database.
public
static connect(string $server, string $userid, string $passwd, string $dbname[, string $socket = "" ]) : mysqli
Parameters
- $server : string
-
Server name
- $userid : string
-
Database user ID
- $passwd : string
-
User password
- $dbname : string
-
Database name
- $socket : string = ""
-
Database socket
Return values
mysqli —Connection to the database
loadFromEnv()
Load database configuration from .env file.
public
static loadFromEnv(string $envPath) : array{server: string, userid: string, passwd: string, dbname: string, socket: string}
Parameters
- $envPath : string
-
Path to the .env file
Return values
array{server: string, userid: string, passwd: string, dbname: string, socket: string}buildConnectErrorMessage()
Build a helpful error message based on the mysqli connect error code.
private
static buildConnectErrorMessage(string $server[, string $dbname = '' ]) : string
Parameters
- $server : string
-
The server that was being connected to
- $dbname : string = ''
-
The database name (if relevant)
Return values
string —Human-readable error message with troubleshooting hints