Adds phpdoc comments

main
Yasen Pramatarov 2024-12-02 11:06:02 +02:00
parent a6b0553393
commit b18cca8075
1 changed files with 27 additions and 0 deletions

View File

@ -1,5 +1,14 @@
<?php <?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/conference.php';
require '../app/classes/participant.php'; require '../app/classes/participant.php';
@ -21,6 +30,12 @@ if ($response['db'] === null) {
$conferenceObject = new Conference($db); $conferenceObject = new Conference($db);
$participantObject = new Participant($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 // monthly conferences for the last year
$fromMonth = (new DateTime())->sub(new DateInterval('P1Y')); $fromMonth = (new DateTime())->sub(new DateInterval('P1Y'));
$fromMonth->modify('first day of this month'); $fromMonth->modify('first day of this month');
@ -83,6 +98,12 @@ if ($response['db'] === null) {
//// ////
// conferences in last 2 days // 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 // time range limit
$from_time = date('Y-m-d', time() - 60 * 60 * 24 * 2); $from_time = date('Y-m-d', time() - 60 * 60 * 24 * 2);
$until_time = date('Y-m-d', time()); $until_time = date('Y-m-d', time());
@ -142,6 +163,12 @@ if ($response['db'] === null) {
//// ////
// last 10 conferences // last 10 conferences
/**
* Last 10 conferences.
*
* Displays the 10 most recent conferences in the database.
*/
// all time // all time
$from_time = '0000-01-01'; $from_time = '0000-01-01';
$until_time = '9999-12-31'; $until_time = '9999-12-31';