From 831c1196360653e4cb428a7c92f85fc57e94ce61 Mon Sep 17 00:00:00 2001
From: Yasen Pramatarov <yasen@lindeas.com>
Date: Thu, 28 Nov 2024 16:40:50 +0200
Subject: [PATCH] Adds phpdoc comments

---
 app/pages/login.php | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/app/pages/login.php b/app/pages/login.php
index f40d06e..972671d 100644
--- a/app/pages/login.php
+++ b/app/pages/login.php
@@ -1,5 +1,25 @@
 <?php
 
+/**
+ * User Login
+ *
+ * this page ("login") handles user login, session management, cookie handling, and error logging.
+ * Supports "remember me" functionality to extend session duration.
+ *
+ * Global Variables Used:
+ * - `$userObject`: Instance of the user management class.
+ * - `$logObject`: Instance of the logging class.
+ * - `$config`: Configuration array containing settings for cookies, domain, and folder.
+ * - `$app_root`: Base URL of the application.
+ * - `$user_IP`: Captured IP address of the user.
+ *
+ * Actions Performed:
+ * - Validates login credentials.
+ * - Manages session and cookies based on "remember me" option.
+ * - Logs successful and failed login attempts.
+ * - Displays login form and optional custom messages.
+ */
+
 // clear the global error var before login
 unset($error);