Clean up the PHPDoc comments

main
Yasen Pramatarov 2024-11-29 18:07:47 +02:00
parent 866af8acfe
commit 3ce20c2069
3 changed files with 7 additions and 33 deletions

View File

@ -3,8 +3,9 @@
/** /**
* Conference information * Conference information
* *
* This page ("conferences") handles the listing and searching of conferences from the database. * This page ("conferences") retrieves and displays information about conferences.
* It supports searching by conference ID, name, or listing all conferences within a specified time range. * Allows filtering by conference ID or name, and listing within a specified time range.
* Supports pagination.
*/ */
require '../app/classes/conference.php'; require '../app/classes/conference.php';

View File

@ -3,29 +3,9 @@
/** /**
* Participants information * Participants information
* *
* This page ("participants") retrieves and displays participant information for conferences, * This page ("participants") retrieves and displays participant information for conferences.
* allowing filtering by participant ID, name, or IP address. * Allows filtering by participant ID, name, or IP address, and listing within a specified time range.
* It supports pagination and displays the results in a widget. * Supports pagination.
*
* 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'; require '../app/classes/participant.php';

View File

@ -1,7 +1,7 @@
<?php <?php
/** /**
* User Profile Management * User profile management
* *
* This page ("profile") handles user profile actions such as updating user details, * This page ("profile") handles user profile actions such as updating user details,
* avatar management, and assigning or removing user rights. * avatar management, and assigning or removing user rights.
@ -10,13 +10,6 @@
* Actions handled: * Actions handled:
* - `remove`: Remove a user's avatar. * - `remove`: Remove a user's avatar.
* - `edit`: Edit user profile details, rights, or avatar. * - `edit`: Edit user profile details, rights, or avatar.
*
* Global Variables Used:
* - `$userObject`: Instance of the user management class.
* - `$userDetails`: Current user details array.
* - `$userRights`: Array of user's current rights.
* - `$config`: Configuration array for avatars and other settings.
* - `$app_root`: Base URL of the application.
*/ */
$action = $_REQUEST['action'] ?? ''; $action = $_REQUEST['action'] ?? '';