Compare commits

...

3 Commits

Author SHA1 Message Date
Yasen Pramatarov 866af8acfe Adds phpdoc comments 2024-11-28 16:49:47 +02:00
Yasen Pramatarov a8a85b0666 Adds phpdoc comments 2024-11-28 16:46:13 +02:00
Yasen Pramatarov 831c119636 Adds phpdoc comments 2024-11-28 16:40:50 +02:00
3 changed files with 55 additions and 0 deletions

View File

@ -1,5 +1,12 @@
<?php
/**
* Conference information
*
* This page ("conferences") handles the listing and searching of conferences from the database.
* It supports searching by conference ID, name, or listing all conferences within a specified time range.
*/
require '../app/classes/conference.php';
// connect to database

View File

@ -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);

View File

@ -1,5 +1,33 @@
<?php
/**
* Participants information
*
* This page ("participants") retrieves and displays participant information for conferences,
* allowing filtering by participant ID, name, or IP address.
* It supports pagination and displays the results in a widget.
*
* Dependencies:
* - `Participant` class for interacting with the database.
* - Time range helper for filtering data within a specific time range.
* - Widget template for displaying results.
*
* Global Variables Used:
* - `$config`: Application configuration array.
* - `$platformDetails`: Array containing platform details.
* - `$platform_id`: Current platform ID.
*
* Inputs:
* - `$_REQUEST['id']`: Participant ID to filter by.
* - `$_REQUEST['name']`: Participant name (stats_id) to filter by.
* - `$_REQUEST['ip']`: Participant IP to filter by.
* - `$_REQUEST['p']`: Page number for pagination (default: 1).
*
* Outputs:
* - Displays a widget with the filtered participant data.
* - Displays an error message if the database connection fails.
*/
require '../app/classes/participant.php';
// connect to database