From b18cca80752fa744d05e38a3200225dd03e8b843 Mon Sep 17 00:00:00 2001
From: Yasen Pramatarov <yasen@lindeas.com>
Date: Mon, 2 Dec 2024 11:06:02 +0200
Subject: [PATCH] Adds phpdoc comments

---
 app/pages/dashboard.php | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/app/pages/dashboard.php b/app/pages/dashboard.php
index ae6313e..a9fe4d5 100644
--- a/app/pages/dashboard.php
+++ b/app/pages/dashboard.php
@@ -1,5 +1,14 @@
 <?php
 
+/**
+ * Main dashboard file for displaying conference statistics.
+ * 
+ * This file connects to the database and displays various widgets:
+ * 1. Monthly statistics for the past year.
+ * 2. Conferences from the last 2 days.
+ * 3. The most recent 10 conferences.
+ */
+
 require '../app/classes/conference.php';
 require '../app/classes/participant.php';
 
@@ -21,6 +30,12 @@ if ($response['db'] === null) {
     $conferenceObject = new Conference($db);
     $participantObject = new Participant($db);
 
+    /**
+     * Monthly usage statistics for the last year.
+     *
+     * Retrieves conference and participant numbers for each month within the past year.
+     */
+
     // monthly conferences for the last year
     $fromMonth = (new DateTime())->sub(new DateInterval('P1Y'));
     $fromMonth->modify('first day of this month');
@@ -83,6 +98,12 @@ if ($response['db'] === null) {
     ////
     // conferences in last 2 days
 
+    /**
+     * Conferences in the last 2 days.
+     *
+     * Displays a summary of all conferences held in the past 48 hours.
+     */
+
     // time range limit
     $from_time = date('Y-m-d', time() - 60 * 60 * 24 * 2);
     $until_time = date('Y-m-d', time());
@@ -142,6 +163,12 @@ if ($response['db'] === null) {
     ////
     // last 10 conferences
 
+    /**
+     * Last 10 conferences.
+     *
+     * Displays the 10 most recent conferences in the database.
+     */
+
     // all time
     $from_time = '0000-01-01';
     $until_time = '9999-12-31';