From c7a161963f631202f8b86947c95116aac517f800 Mon Sep 17 00:00:00 2001
From: Yasen Pramatarov <yasen@lindeas.com>
Date: Sat, 23 Nov 2024 15:45:03 +0200
Subject: [PATCH] Adds phpdoc comments

---
 app/classes/database.php | 24 +++++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

diff --git a/app/classes/database.php b/app/classes/database.php
index 63c7449..2534db7 100644
--- a/app/classes/database.php
+++ b/app/classes/database.php
@@ -1,10 +1,32 @@
 <?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.');
         }