Compare commits

...

3 Commits

Author SHA1 Message Date
Yasen Pramatarov d1fe3a7cf5 Adds exceptions for the errors 2024-11-23 15:49:20 +02:00
Yasen Pramatarov fac6e4ea83 Adds phpdoc comments 2024-11-23 15:46:01 +02:00
Yasen Pramatarov c7a161963f Adds phpdoc comments 2024-11-23 15:45:03 +02:00
1 changed files with 58 additions and 11 deletions

View File

@ -1,20 +1,42 @@
<?php
/**
* Class Database
* Manages database connections for SQLite and MySQL (or MariaDB).
*/
class Database {
/**
* @var PDO|null $pdo The PDO instance representing the database connection.
*/
private $pdo;
/**
* Database constructor.
* Initializes the database connection based on provided options.
*
* @param array $options An associative array with database connection options:
* - type: The database type ('sqlite', 'mysql', or 'mariadb').
* - dbFile: The path to the SQLite database file (required for SQLite).
* - host: The database host (required for MySQL).
* - port: The port for MySQL (optional, default: 3306).
* - dbname: The name of the MySQL database (required for MySQL).
* - user: The username for MySQL (required for MySQL).
* - password: The password for MySQL (optional).
*
* @throws Exception If required extensions are not loaded or options are invalid.
*/
public function __construct($options) {
// pdo needed
// check if PDO extension is loaded
if ( !extension_loaded('pdo') ) {
$error = getError('PDO extension not loaded.');
throw new Exception('PDO extension not loaded.');
}
// options check
if (empty($options['type'])) {
$error = getError('Database type is not set.');
throw new Exception('Database type is not set.');
}
// database type
// connect based on database type
switch ($options['type']) {
case 'sqlite':
$this->connectSqlite($options);
@ -23,19 +45,27 @@ class Database {
$this->connectMysql($options);
break;
default:
$error = getError("Database type \"{$options['type']}\" is not supported.");
throw new Exception("Database type \"{$options['type']}\" is not supported.");
}
}
/**
* Establishes a connection to a SQLite database.
*
* @param array $options An associative array with SQLite connection options:
* - dbFile: The path to the SQLite database file.
*
* @throws Exception If the SQLite PDO extension is not loaded or the database file is missing.
*/
private function connectSqlite($options) {
// pdo_sqlite extension is needed
if (!extension_loaded('pdo_sqlite')) {
$error = getError('PDO extension for SQLite not loaded.');
throw new Exception('PDO extension for SQLite not loaded.');
}
// SQLite options
if (empty($options['dbFile']) || !file_exists($options['dbFile'])) {
$error = getError("SQLite database file \"{$dbFile}\" not found.");
throw new Exception("SQLite database file \"{$options['dbFile']}\" not found.");
}
// connect to SQLite
@ -45,19 +75,31 @@ class Database {
// enable foreign key constraints (not ON by default in SQLite3)
$this->pdo->exec('PRAGMA foreign_keys = ON;');
} catch (PDOException $e) {
$error = getError('SQLite connection failed: ', $e->getMessage());
throw new Exception('SQLite connection failed: ' . $e->getMessage());
}
}
/**
* Establishes a connection to a MySQL (or MariaDB) database.
*
* @param array $options An associative array with MySQL connection options:
* - host: The database host.
* - port: The database port (default: 3306).
* - dbname: The name of the database.
* - user: The database username.
* - password: The database password (optional).
*
* @throws Exception If the MySQL PDO extension is not loaded or required options are missing.
*/
private function connectMysql($options) {
// pdo_mysql extension is needed
if (!extension_loaded('pdo_mysql')) {
$error = getError('PDO extension for MySQL not loaded.');
throw new Exception('PDO extension for MySQL not loaded.');
}
// MySQL options
if (empty($options['host']) || empty($options['dbname']) || empty($options['user'])) {
$error = getError('MySQL connection data is missing.');
throw new Exception('MySQL connection data is missing.');
}
// Connect to MySQL
@ -66,10 +108,15 @@ class Database {
$this->pdo = new PDO($dsn, $options['user'], $options['password'] ?? '');
$this->pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
} catch (PDOException $e) {
$error = getError('MySQL connection failed: ', $e->getMessage(), $config['environment']);
throw new Exception('MySQL connection failed: ' . $e->getMessage());
}
}
/**
* Retrieves the current PDO connection instance.
*
* @return PDO|null The PDO instance or null if no connection is established.
*/
public function getConnection() {
return $this->pdo;
}